Repository: PalisadoesFoundation/talawa-admin Branch: main Commit: 909d2193ece3 Files: 3311 Total size: 13.6 MB Directory structure: gitextract_7oxmh0tn/ ├── .coderabbit/ │ └── ast-grep-rules/ │ ├── assertions-must-use-waitfor.yml │ ├── hardcoded-timeout.yml │ ├── mutation-null-guards.yml │ ├── no-dynamic-timestamps-in-tests.yml │ ├── no-local-timezone-in-tests.yml │ └── vitest-cleanup.yml ├── .coderabbit.yaml ├── .dockerignore ├── .flake8 ├── .github/ │ ├── FUNDING.yml │ ├── ISSUE_TEMPLATE/ │ │ ├── bug-report.md │ │ └── feature-request.md │ ├── dependabot.yaml │ ├── pull_request_template.md │ └── workflows/ │ ├── README.md │ ├── auto-assign.yml │ ├── auto-label.json5 │ ├── check-tsdoc.js │ ├── codeql-codescan.yml │ ├── config/ │ │ ├── check-pr-issue-skip-usernames.txt │ │ ├── countline_excluded_file_list.txt │ │ └── sensitive_files.txt │ ├── issue-assigned.yml │ ├── issue-unassigned.yml │ ├── issue.yml │ ├── pull-request-comment.yml │ ├── pull-request-review.yml │ ├── pull-request-target.yml │ ├── pull-request.yml │ ├── push-deploy-website.yml │ ├── push.yml │ ├── requirements.txt │ ├── scripts/ │ │ ├── app_health_check.sh │ │ ├── check-minio-compliance.cjs │ │ ├── compare_translations.py │ │ ├── css_check.py │ │ ├── test/ │ │ │ ├── README.md │ │ │ ├── test_css_check.py │ │ │ └── test_translation_check.py │ │ └── translation_check.py │ └── stale.yml ├── .gitignore ├── .graphqlrc.yml ├── .husky/ │ ├── commit-msg │ ├── post-merge │ ├── pre-commit │ └── scripts/ │ ├── check-tools.sh │ ├── fetch-verified.sh │ ├── precommit-node.sh │ ├── precommit-python.sh │ ├── staged-files.sh │ └── venv.sh ├── .lintstagedrc.json ├── .nojekyll ├── .prettierignore ├── .prettierrc ├── .pydocstyle ├── CODEOWNERS ├── CODE_OF_CONDUCT.md ├── CODE_STYLE.md ├── CONTRIBUTING.md ├── DOCUMENTATION.md ├── INSTALLATION.md ├── ISSUE_GUIDELINES.md ├── LICENSE ├── PR_GUIDELINES.md ├── README.md ├── commitlint.config.js ├── config/ │ ├── babel.config.cjs │ ├── docker/ │ │ └── setup/ │ │ ├── apache.conf │ │ ├── nginx.conf │ │ └── nginx.rootless.conf.template │ ├── vite.config.spec.ts │ └── vite.config.ts ├── cypress/ │ ├── README.md │ ├── e2e/ │ │ ├── Accessibility/ │ │ │ └── .gitkeep │ │ ├── AdminPortal/ │ │ │ ├── ActionItems/ │ │ │ │ ├── .gitkeep │ │ │ │ └── ActionItems.cy.ts │ │ │ ├── Advertisements/ │ │ │ │ ├── .gitkeep │ │ │ │ └── Advertisements.cy.ts │ │ │ ├── Dashboard/ │ │ │ │ ├── .gitkeep │ │ │ │ └── AdminDashboard.cy.ts │ │ │ ├── Events/ │ │ │ │ ├── .gitkeep │ │ │ │ └── EventLifecycle.cy.ts │ │ │ ├── Organizations/ │ │ │ │ ├── .gitkeep │ │ │ │ └── OrganizationSetup.cy.ts │ │ │ ├── People/ │ │ │ │ ├── .gitkeep │ │ │ │ └── ManageMembers.cy.ts │ │ │ ├── Posts/ │ │ │ │ ├── .gitkeep │ │ │ │ └── Posts.cy.ts │ │ │ ├── Tags/ │ │ │ │ └── .gitkeep │ │ │ └── Venues/ │ │ │ └── .gitkeep │ │ ├── Auth/ │ │ │ ├── .gitkeep │ │ │ └── Login.cy.ts │ │ ├── CascadingEffects/ │ │ │ └── .gitkeep │ │ ├── E2EFlows/ │ │ │ └── .gitkeep │ │ ├── ErrorScenarios/ │ │ │ └── .gitkeep │ │ ├── MultiOrganization/ │ │ │ └── .gitkeep │ │ ├── SharedComponents/ │ │ │ ├── .gitkeep │ │ │ ├── GraphQLUtilities.cy.ts │ │ │ └── Navigation.cy.ts │ │ └── UserPortal/ │ │ ├── Dashboard/ │ │ │ ├── .gitkeep │ │ │ └── UserDashboard.cy.ts │ │ ├── EventDiscovery/ │ │ │ └── .gitkeep │ │ ├── OrganizationDiscovery/ │ │ │ └── .gitkeep │ │ ├── Posts/ │ │ │ └── .gitkeep │ │ ├── Profile/ │ │ │ └── .gitkeep │ │ ├── Transactions/ │ │ │ └── .gitkeep │ │ └── VolunteerSignup/ │ │ └── .gitkeep │ ├── fixtures/ │ │ ├── admin/ │ │ │ ├── actionItems.json │ │ │ ├── advertisements.json │ │ │ ├── events.json │ │ │ ├── organizations.json │ │ │ ├── people.json │ │ │ ├── tags.json │ │ │ └── venues.json │ │ ├── api/ │ │ │ └── graphql/ │ │ │ ├── createOrganization.error.conflict.json │ │ │ ├── createOrganization.success.json │ │ │ ├── getOrganizationEvents.error.notFound.json │ │ │ ├── getOrganizationEvents.success.json │ │ │ ├── getOrganizationMembers.error.notFound.json │ │ │ ├── getOrganizationMembers.success.json │ │ │ └── organizations.success.json │ │ ├── auth/ │ │ │ ├── credentials.json │ │ │ └── users.json │ │ └── user/ │ │ ├── campaigns.json │ │ ├── donations.json │ │ ├── posts.json │ │ └── volunteers.json │ ├── pageObjects/ │ │ ├── AdminPortal/ │ │ │ ├── ActionItemPage.ts │ │ │ ├── AdminDashboard.ts │ │ │ ├── AdminEventPage.ts │ │ │ ├── AdvertisementPage.ts │ │ │ ├── EventAttendancePage.ts │ │ │ ├── LeftDrawer.ts │ │ │ ├── MemberManagementPage.ts │ │ │ ├── OrganizationSettingsPage.ts │ │ │ ├── PeoplePage.ts │ │ │ ├── PostPage.ts │ │ │ └── VolunteerManagementPage.ts │ │ ├── UserPortal/ │ │ │ └── UserDashboard.ts │ │ ├── auth/ │ │ │ └── LoginPage.ts │ │ ├── base/ │ │ │ └── BasePage.ts │ │ └── shared/ │ │ ├── ModalActions.ts │ │ ├── TableActions.ts │ │ └── types.ts │ └── support/ │ ├── commands.ts │ ├── e2e.ts │ └── graphql-utils.ts ├── cypress.config.ts ├── docker/ │ ├── Dockerfile.deploy │ ├── Dockerfile.dev │ ├── Dockerfile.prod │ ├── Dockerfile.rootless.dev │ ├── Dockerfile.rootless.prod │ ├── docker-compose.deploy.yaml │ ├── docker-compose.dev.yaml │ ├── docker-compose.prod.yaml │ ├── docker-compose.rootless.dev.yaml │ └── docker-compose.rootless.prod.yaml ├── docs/ │ ├── .gitignore │ ├── CNAME │ ├── README.md │ ├── docs/ │ │ ├── auto-docs/ │ │ │ ├── App/ │ │ │ │ └── functions/ │ │ │ │ └── default.md │ │ │ ├── Constant/ │ │ │ │ ├── common/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ ├── FILE_NAME_TEMPLATE_BACKUP_ENV.md │ │ │ │ │ │ ├── ROUTE_USER.md │ │ │ │ │ │ ├── ROUTE_USER_ORG.md │ │ │ │ │ │ ├── TEST_ID_DELETE_EVENT_MODAL.md │ │ │ │ │ │ ├── TEST_ID_PEOPLE_CARD.md │ │ │ │ │ │ ├── TEST_ID_PEOPLE_EMAIL.md │ │ │ │ │ │ ├── TEST_ID_PEOPLE_IMAGE.md │ │ │ │ │ │ ├── TEST_ID_PEOPLE_NAME.md │ │ │ │ │ │ ├── TEST_ID_PEOPLE_ROLE.md │ │ │ │ │ │ ├── TEST_ID_PEOPLE_SNO.md │ │ │ │ │ │ └── TEST_ID_UPDATE_EVENT_MODAL.md │ │ │ │ │ └── variables/ │ │ │ │ │ ├── DATE_FORMAT.md │ │ │ │ │ ├── DATE_FORMAT_ISO_DATE.md │ │ │ │ │ ├── DATE_TIME_SEPARATOR.md │ │ │ │ │ ├── DUMMY_DATE_TIME_PREFIX.md │ │ │ │ │ ├── IDENTIFIER_ID.md │ │ │ │ │ ├── IDENTIFIER_USER_ID.md │ │ │ │ │ └── MAX_NAME_LENGTH.md │ │ │ │ ├── constant/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── deriveBackendWebsocketUrl.md │ │ │ │ │ └── variables/ │ │ │ │ │ ├── AUTH_TOKEN.md │ │ │ │ │ ├── BACKEND_URL.md │ │ │ │ │ ├── BACKEND_WEBSOCKET_URL.md │ │ │ │ │ ├── REACT_APP_USE_RECAPTCHA.md │ │ │ │ │ └── RECAPTCHA_SITE_KEY.md │ │ │ │ └── fileUpload/ │ │ │ │ └── variables/ │ │ │ │ ├── AGENDA_ITEM_ALLOWED_MIME_TYPES.md │ │ │ │ ├── AGENDA_ITEM_MIME_TYPE.md │ │ │ │ ├── FILE_UPLOAD_ALLOWED_TYPES.md │ │ │ │ └── FILE_UPLOAD_MAX_SIZE_MB.md │ │ │ ├── GraphQl/ │ │ │ │ ├── Mutations/ │ │ │ │ │ ├── ActionItemCategoryMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_ACTION_ITEM_CATEGORY_MUTATION.md │ │ │ │ │ │ ├── DELETE_ACTION_ITEM_CATEGORY_MUTATION.md │ │ │ │ │ │ └── UPDATE_ACTION_ITEM_CATEGORY_MUTATION.md │ │ │ │ │ ├── ActionItemMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── COMPLETE_ACTION_ITEM_FOR_INSTANCE.md │ │ │ │ │ │ ├── CREATE_ACTION_ITEM_MUTATION.md │ │ │ │ │ │ ├── DELETE_ACTION_ITEM_FOR_INSTANCE.md │ │ │ │ │ │ ├── DELETE_ACTION_ITEM_MUTATION.md │ │ │ │ │ │ ├── MARK_ACTION_ITEM_AS_PENDING_FOR_INSTANCE.md │ │ │ │ │ │ ├── MARK_ACTION_ITEM_AS_PENDING_MUTATION.md │ │ │ │ │ │ ├── UPDATE_ACTION_ITEM_FOR_INSTANCE.md │ │ │ │ │ │ └── UPDATE_ACTION_ITEM_MUTATION.md │ │ │ │ │ ├── AdvertisementMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── ADD_ADVERTISEMENT_MUTATION.md │ │ │ │ │ │ ├── DELETE_ADVERTISEMENT_MUTATION.md │ │ │ │ │ │ └── UPDATE_ADVERTISEMENT_MUTATION.md │ │ │ │ │ ├── AgendaFolderMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_AGENDA_FOLDER_MUTATION.md │ │ │ │ │ │ ├── DELETE_AGENDA_FOLDER_MUTATION.md │ │ │ │ │ │ └── UPDATE_AGENDA_FOLDER_MUTATION.md │ │ │ │ │ ├── AgendaItemMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_AGENDA_ITEM_MUTATION.md │ │ │ │ │ │ ├── DELETE_AGENDA_ITEM_MUTATION.md │ │ │ │ │ │ ├── UPDATE_AGENDA_ITEM_MUTATION.md │ │ │ │ │ │ └── UPDATE_AGENDA_ITEM_SEQUENCE_MUTATION.md │ │ │ │ │ ├── CampaignMutation/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_CAMPAIGN_MUTATION.md │ │ │ │ │ │ └── UPDATE_CAMPAIGN_MUTATION.md │ │ │ │ │ ├── CommentMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_COMMENT_POST.md │ │ │ │ │ │ ├── DELETE_COMMENT.md │ │ │ │ │ │ ├── LIKE_COMMENT.md │ │ │ │ │ │ ├── UNLIKE_COMMENT.md │ │ │ │ │ │ └── UPDATE_COMMENT.md │ │ │ │ │ ├── EventAttendeeMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── ADD_EVENT_ATTENDEE.md │ │ │ │ │ │ ├── MARK_CHECKIN.md │ │ │ │ │ │ └── REMOVE_EVENT_ATTENDEE.md │ │ │ │ │ ├── EventMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_EVENT_MUTATION.md │ │ │ │ │ │ ├── DELETE_ENTIRE_RECURRING_EVENT_SERIES_MUTATION.md │ │ │ │ │ │ ├── DELETE_SINGLE_EVENT_INSTANCE_MUTATION.md │ │ │ │ │ │ ├── DELETE_STANDALONE_EVENT_MUTATION.md │ │ │ │ │ │ ├── DELETE_THIS_AND_FOLLOWING_EVENTS_MUTATION.md │ │ │ │ │ │ ├── REGISTER_EVENT.md │ │ │ │ │ │ ├── UPDATE_ENTIRE_RECURRING_EVENT_SERIES_MUTATION.md │ │ │ │ │ │ ├── UPDATE_EVENT_MUTATION.md │ │ │ │ │ │ ├── UPDATE_SINGLE_RECURRING_EVENT_INSTANCE_MUTATION.md │ │ │ │ │ │ └── UPDATE_THIS_AND_FOLLOWING_EVENTS_MUTATION.md │ │ │ │ │ ├── EventVolunteerMutation/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── ADD_VOLUNTEER.md │ │ │ │ │ │ ├── CREATE_VOLUNTEER_GROUP.md │ │ │ │ │ │ ├── DELETE_VOLUNTEER.md │ │ │ │ │ │ ├── DELETE_VOLUNTEER_FOR_INSTANCE.md │ │ │ │ │ │ ├── DELETE_VOLUNTEER_GROUP.md │ │ │ │ │ │ ├── DELETE_VOLUNTEER_GROUP_FOR_INSTANCE.md │ │ │ │ │ │ ├── UPDATE_VOLUNTEER_GROUP.md │ │ │ │ │ │ └── UPDATE_VOLUNTEER_MEMBERSHIP.md │ │ │ │ │ ├── FundMutation/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_FUND_MUTATION.md │ │ │ │ │ │ └── UPDATE_FUND_MUTATION.md │ │ │ │ │ ├── OrganizationMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CANCEL_MEMBERSHIP_REQUEST.md │ │ │ │ │ │ ├── CREATE_CHAT.md │ │ │ │ │ │ ├── CREATE_CHAT_MEMBERSHIP.md │ │ │ │ │ │ ├── CREATE_SAMPLE_ORGANIZATION_MUTATION.md │ │ │ │ │ │ ├── DELETE_CHAT.md │ │ │ │ │ │ ├── DELETE_CHAT_MEMBERSHIP.md │ │ │ │ │ │ ├── DELETE_CHAT_MESSAGE.md │ │ │ │ │ │ ├── EDIT_CHAT_MESSAGE.md │ │ │ │ │ │ ├── JOIN_PUBLIC_ORGANIZATION.md │ │ │ │ │ │ ├── MARK_CHAT_MESSAGES_AS_READ.md │ │ │ │ │ │ ├── MESSAGE_SENT_TO_CHAT.md │ │ │ │ │ │ ├── REMOVE_SAMPLE_ORGANIZATION_MUTATION.md │ │ │ │ │ │ ├── SEND_MEMBERSHIP_REQUEST.md │ │ │ │ │ │ ├── SEND_MESSAGE_TO_CHAT.md │ │ │ │ │ │ ├── TOGGLE_PINNED_POST.md │ │ │ │ │ │ ├── UPDATE_CHAT.md │ │ │ │ │ │ ├── UPDATE_CHAT_MEMBERSHIP.md │ │ │ │ │ │ └── UPDATE_USER_ROLE_IN_ORG_MUTATION.md │ │ │ │ │ ├── PledgeMutation/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_PLEDGE.md │ │ │ │ │ │ ├── DELETE_PLEDGE.md │ │ │ │ │ │ └── UPDATE_PLEDGE.md │ │ │ │ │ ├── PluginMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_PLUGIN_MUTATION.md │ │ │ │ │ │ ├── DELETE_PLUGIN_MUTATION.md │ │ │ │ │ │ ├── INSTALL_PLUGIN_MUTATION.md │ │ │ │ │ │ ├── UPDATE_PLUGIN_MUTATION.md │ │ │ │ │ │ └── UPLOAD_PLUGIN_ZIP_MUTATION.md │ │ │ │ │ ├── TagMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── ADD_PEOPLE_TO_TAG.md │ │ │ │ │ │ ├── ASSIGN_TO_TAGS.md │ │ │ │ │ │ ├── CREATE_USER_TAG.md │ │ │ │ │ │ ├── REMOVE_FROM_TAGS.md │ │ │ │ │ │ ├── REMOVE_USER_TAG.md │ │ │ │ │ │ ├── UNASSIGN_USER_TAG.md │ │ │ │ │ │ └── UPDATE_USER_TAG.md │ │ │ │ │ ├── VenueMutations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── CREATE_VENUE_MUTATION.md │ │ │ │ │ │ ├── DELETE_VENUE_MUTATION.md │ │ │ │ │ │ └── UPDATE_VENUE_MUTATION.md │ │ │ │ │ └── mutations/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── ACCEPT_EVENT_INVITATION.md │ │ │ │ │ ├── ACCEPT_ORGANIZATION_REQUEST_MUTATION.md │ │ │ │ │ ├── BLOCK_USER_MUTATION_PG.md │ │ │ │ │ ├── CREATE_MEMBER_PG.md │ │ │ │ │ ├── CREATE_ORGANIZATION_MEMBERSHIP_MUTATION_PG.md │ │ │ │ │ ├── CREATE_ORGANIZATION_MUTATION.md │ │ │ │ │ ├── CREATE_ORGANIZATION_MUTATION_PG.md │ │ │ │ │ ├── CREATE_POST_MUTATION.md │ │ │ │ │ ├── DELETE_ORGANIZATION_MUTATION.md │ │ │ │ │ ├── DELETE_POST_MUTATION.md │ │ │ │ │ ├── DONATE_TO_ORGANIZATION.md │ │ │ │ │ ├── FORGOT_PASSWORD_MUTATION.md │ │ │ │ │ ├── GENERATE_OTP_MUTATION.md │ │ │ │ │ ├── GET_FILE_PRESIGNEDURL.md │ │ │ │ │ ├── LINK_OAUTH_ACCOUNT.md │ │ │ │ │ ├── LOGOUT_MUTATION.md │ │ │ │ │ ├── PRESIGNED_URL.md │ │ │ │ │ ├── REFRESH_TOKEN_MUTATION.md │ │ │ │ │ ├── REJECT_ORGANIZATION_REQUEST_MUTATION.md │ │ │ │ │ ├── REMOVE_MEMBER_MUTATION.md │ │ │ │ │ ├── REMOVE_MEMBER_MUTATION_PG.md │ │ │ │ │ ├── RESEND_VERIFICATION_EMAIL_MUTATION.md │ │ │ │ │ ├── RESET_COMMUNITY.md │ │ │ │ │ ├── REVOKE_REFRESH_TOKEN.md │ │ │ │ │ ├── SEND_EVENT_INVITATIONS.md │ │ │ │ │ ├── SIGNUP_MUTATION.md │ │ │ │ │ ├── SIGN_IN_WITH_OAUTH.md │ │ │ │ │ ├── UNBLOCK_USER_MUTATION_PG.md │ │ │ │ │ ├── UNLINK_OAUTH_ACCOUNT.md │ │ │ │ │ ├── UPDATE_COMMUNITY_PG.md │ │ │ │ │ ├── UPDATE_CURRENT_USER_MUTATION.md │ │ │ │ │ ├── UPDATE_EVENT_MUTATION.md │ │ │ │ │ ├── UPDATE_ORGANIZATION_MUTATION.md │ │ │ │ │ ├── UPDATE_POST_MUTATION.md │ │ │ │ │ ├── UPDATE_POST_VOTE.md │ │ │ │ │ ├── UPDATE_SESSION_TIMEOUT_PG.md │ │ │ │ │ ├── UPDATE_USER_MUTATION.md │ │ │ │ │ ├── VERIFY_EMAIL_MUTATION.md │ │ │ │ │ └── VERIFY_EVENT_INVITATION.md │ │ │ │ └── Queries/ │ │ │ │ ├── ActionItemCategoryQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── ACTION_ITEM_CATEGORY_LIST.md │ │ │ │ │ └── GET_ACTION_ITEM_CATEGORY.md │ │ │ │ ├── ActionItemQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── ACTION_ITEM_LIST.md │ │ │ │ │ └── GET_EVENT_ACTION_ITEMS.md │ │ │ │ ├── AdvertisementQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── ORGANIZATION_ADVERTISEMENT_LIST.md │ │ │ │ ├── AgendaCategoryQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── AGENDA_ITEM_CATEGORY_LIST.md │ │ │ │ ├── AgendaFolderQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── AGENDA_FOLDER_LIST.md │ │ │ │ ├── CommentQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── GET_POST_COMMENTS.md │ │ │ │ ├── EventVolunteerQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── EVENT_VOLUNTEER_GROUP_LIST.md │ │ │ │ │ ├── GET_EVENT_VOLUNTEERS.md │ │ │ │ │ ├── GET_EVENT_VOLUNTEER_GROUPS.md │ │ │ │ │ ├── USER_EVENTS_VOLUNTEER.md │ │ │ │ │ ├── USER_VOLUNTEER_MEMBERSHIP.md │ │ │ │ │ └── VOLUNTEER_RANKING.md │ │ │ │ ├── NotificationQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── GET_USER_NOTIFICATIONS.md │ │ │ │ │ └── MARK_NOTIFICATION_AS_READ.md │ │ │ │ ├── OrganizationQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── ORGANIZATION_MEMBERS.md │ │ │ │ │ ├── ORGANIZATION_PINNED_POST_LIST.md │ │ │ │ │ ├── ORGANIZATION_POST_BY_ID.md │ │ │ │ │ ├── ORGANIZATION_POST_LIST_WITH_VOTES.md │ │ │ │ │ ├── ORGANIZATION_USER_TAGS_LIST.md │ │ │ │ │ ├── ORGANIZATION_USER_TAGS_LIST_PG.md │ │ │ │ │ ├── USER_CREATED_ORGANIZATIONS.md │ │ │ │ │ ├── USER_JOINED_ORGANIZATIONS_PG.md │ │ │ │ │ └── VENUE_LIST.md │ │ │ │ ├── PlugInQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── CHATS_LIST.md │ │ │ │ │ ├── CHAT_BY_ID.md │ │ │ │ │ ├── GET_ALL_PLUGINS.md │ │ │ │ │ ├── IS_SAMPLE_ORGANIZATION_QUERY.md │ │ │ │ │ └── UNREAD_CHATS.md │ │ │ │ ├── Queries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── ALL_ORGANIZATIONS_PG.md │ │ │ │ │ ├── CURRENT_USER.md │ │ │ │ │ ├── EVENT_ATTENDEES.md │ │ │ │ │ ├── EVENT_CHECKINS.md │ │ │ │ │ ├── EVENT_DETAILS.md │ │ │ │ │ ├── EVENT_FEEDBACKS.md │ │ │ │ │ ├── EVENT_REGISTRANTS.md │ │ │ │ │ ├── GET_COMMUNITY_DATA_PG.md │ │ │ │ │ ├── GET_COMMUNITY_SESSION_TIMEOUT_DATA_PG.md │ │ │ │ │ ├── GET_EVENTS_BY_ORGANIZATION_ID.md │ │ │ │ │ ├── GET_ORGANIZATION_BASIC_DATA.md │ │ │ │ │ ├── GET_ORGANIZATION_BLOCKED_USERS_COUNT.md │ │ │ │ │ ├── GET_ORGANIZATION_BLOCKED_USERS_PG.md │ │ │ │ │ ├── GET_ORGANIZATION_DATA_PG.md │ │ │ │ │ ├── GET_ORGANIZATION_EVENTS_PG.md │ │ │ │ │ ├── GET_ORGANIZATION_EVENTS_USER_PORTAL_PG.md │ │ │ │ │ ├── GET_ORGANIZATION_MEMBERS_PG.md │ │ │ │ │ ├── GET_ORGANIZATION_POSTS_COUNT_PG.md │ │ │ │ │ ├── GET_ORGANIZATION_POSTS_PG.md │ │ │ │ │ ├── GET_ORGANIZATION_VENUES_COUNT.md │ │ │ │ │ ├── GET_ORGANIZATION_VENUES_PG.md │ │ │ │ │ ├── GET_USER_BY_ID.md │ │ │ │ │ ├── GET_USER_TAGS.md │ │ │ │ │ ├── MEMBERSHIP_REQUEST_PG.md │ │ │ │ │ ├── MEMBERS_LIST.md │ │ │ │ │ ├── MEMBERS_LIST_PG.md │ │ │ │ │ ├── MEMBERS_LIST_WITH_DETAILS.md │ │ │ │ │ ├── ORGANIZATIONS_LIST.md │ │ │ │ │ ├── ORGANIZATIONS_LIST_BASIC.md │ │ │ │ │ ├── ORGANIZATIONS_MEMBER_CONNECTION_LIST.md │ │ │ │ │ ├── ORGANIZATION_DONATION_CONNECTION_LIST.md │ │ │ │ │ ├── ORGANIZATION_EVENT_CONNECTION_LIST.md │ │ │ │ │ ├── ORGANIZATION_FIELDS.md │ │ │ │ │ ├── ORGANIZATION_FILTER_LIST.md │ │ │ │ │ ├── ORGANIZATION_LIST.md │ │ │ │ │ ├── ORGANIZATION_LIST_NO_MEMBERS.md │ │ │ │ │ ├── ORGANIZATION_MEMBER_ADMIN_COUNT.md │ │ │ │ │ ├── RECURRING_EVENTS.md │ │ │ │ │ ├── SIGNIN_QUERY.md │ │ │ │ │ ├── USERS_CONNECTION_LIST.md │ │ │ │ │ ├── USER_DETAILS.md │ │ │ │ │ ├── USER_JOINED_ORGANIZATIONS_NO_MEMBERS.md │ │ │ │ │ ├── USER_LIST.md │ │ │ │ │ ├── USER_LIST_FOR_ADMIN.md │ │ │ │ │ ├── USER_LIST_FOR_TABLE.md │ │ │ │ │ └── USER_ORGANIZATION_LIST.md │ │ │ │ ├── fundQueries/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── FUND_CAMPAIGN.md │ │ │ │ │ ├── FUND_CAMPAIGN_PLEDGE.md │ │ │ │ │ ├── FUND_LIST.md │ │ │ │ │ ├── USER_FUND_CAMPAIGNS.md │ │ │ │ │ └── USER_PLEDGES.md │ │ │ │ └── userTagQueries/ │ │ │ │ └── variables/ │ │ │ │ ├── USER_TAGS_ASSIGNED_MEMBERS.md │ │ │ │ ├── USER_TAGS_MEMBERS_TO_ASSIGN_TO.md │ │ │ │ └── USER_TAG_SUB_TAGS.md │ │ │ ├── components/ │ │ │ │ ├── AdminPortal/ │ │ │ │ │ ├── AddPeopleToTag/ │ │ │ │ │ │ ├── AddPeopleToTag/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── AddPeopleToTagsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS_ERROR.md │ │ │ │ │ │ ├── MOCK_EMPTY.md │ │ │ │ │ │ └── MOCK_NON_ERROR.md │ │ │ │ │ ├── Advertisements/ │ │ │ │ │ │ ├── Advertisements/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── AdvertisementsMocks/ │ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ │ └── wait.md │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── client.md │ │ │ │ │ │ │ ├── createAdvertisement.md │ │ │ │ │ │ │ ├── createAdvertisementError.md │ │ │ │ │ │ │ ├── createAdvertisementWithEndDateBeforeStart.md │ │ │ │ │ │ │ ├── createAdvertisementWithoutName.md │ │ │ │ │ │ │ ├── createDates.md │ │ │ │ │ │ │ ├── dateConstants.md │ │ │ │ │ │ │ ├── deleteAdvertisementMocks.md │ │ │ │ │ │ │ ├── emptyMocks.md │ │ │ │ │ │ │ ├── fetchErrorMocks.md │ │ │ │ │ │ │ ├── filterActiveAdvertisementData.md │ │ │ │ │ │ │ ├── filterCompletedAdvertisementData.md │ │ │ │ │ │ │ ├── getActiveAdvertisementMocks.md │ │ │ │ │ │ │ ├── getCompletedAdvertisementMocks.md │ │ │ │ │ │ │ ├── initialActiveData.md │ │ │ │ │ │ │ ├── initialArchivedData.md │ │ │ │ │ │ │ ├── link.md │ │ │ │ │ │ │ ├── updateAdMocks.md │ │ │ │ │ │ │ └── updateDates.md │ │ │ │ │ │ ├── core/ │ │ │ │ │ │ │ ├── AdvertisementEntry/ │ │ │ │ │ │ │ │ └── AdvertisementEntry/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── AdvertisementRegister/ │ │ │ │ │ │ │ ├── AdvertisementRegister/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── AdvertisementRegisterMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── createAdFailMock.md │ │ │ │ │ │ │ ├── createAdvertisement.md │ │ │ │ │ │ │ ├── dateConstants.md │ │ │ │ │ │ │ ├── mockBigFile.md │ │ │ │ │ │ │ ├── mockFile.md │ │ │ │ │ │ │ └── updateAdFailMock.md │ │ │ │ │ │ └── skeleton/ │ │ │ │ │ │ └── AdvertisementSkeleton/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── AdvertisementSkeleton.md │ │ │ │ │ ├── AgendaFolder/ │ │ │ │ │ │ ├── AgendaFolderContainer/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── Create/ │ │ │ │ │ │ │ └── AgendaFolderCreateModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── Delete/ │ │ │ │ │ │ │ └── AgendaFolderDeleteModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── DragAndDrop/ │ │ │ │ │ │ │ └── AgendaDragAndDrop/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── Update/ │ │ │ │ │ │ └── AgendaFolderUpdateModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── AgendaItems/ │ │ │ │ │ │ ├── Create/ │ │ │ │ │ │ │ └── AgendaItemsCreateModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── Delete/ │ │ │ │ │ │ │ └── AgendaItemsDeleteModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── Preview/ │ │ │ │ │ │ │ └── AgendaItemsPreviewModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── Update/ │ │ │ │ │ │ └── AgendaItemsUpdateModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── ApplyToSelector/ │ │ │ │ │ │ └── ApplyToSelector/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── AssignmentTypeSelector/ │ │ │ │ │ │ └── AssignmentTypeSelector/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── ContriStats/ │ │ │ │ │ │ └── ContriStats/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── EventManagement/ │ │ │ │ │ │ ├── Dashboard/ │ │ │ │ │ │ │ ├── EventDashboard/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── EventDashboard.mocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS_EMPTY_DATE_STRINGS.md │ │ │ │ │ │ │ ├── MOCKS_INVALID_DATETIME.md │ │ │ │ │ │ │ ├── MOCKS_MISSING_DATA.md │ │ │ │ │ │ │ ├── MOCKS_NO_EVENT.md │ │ │ │ │ │ │ ├── MOCKS_NO_LOCATION.md │ │ │ │ │ │ │ ├── MOCKS_UNDEFINED_INVITE_ONLY.md │ │ │ │ │ │ │ ├── MOCKS_WITHOUT_TIME.md │ │ │ │ │ │ │ └── MOCKS_WITH_TIME.md │ │ │ │ │ │ ├── EventActionItems/ │ │ │ │ │ │ │ └── EventActionItems/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── EventAgenda/ │ │ │ │ │ │ │ └── EventAgenda/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── EventAttendance/ │ │ │ │ │ │ │ ├── Attendance/ │ │ │ │ │ │ │ │ └── EventAttendance/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ ├── AttendanceList/ │ │ │ │ │ │ │ │ └── AttendedEventList/ │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ ├── EventAttendanceMocks/ │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ ├── MOCKDETAIL.md │ │ │ │ │ │ │ │ ├── MOCKEVENT.md │ │ │ │ │ │ │ │ └── MOCKS.md │ │ │ │ │ │ │ └── Statistics/ │ │ │ │ │ │ │ └── EventStatistics/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── AttendanceStatisticsModal.md │ │ │ │ │ │ └── EventRegistrant/ │ │ │ │ │ │ ├── EventRegistrants/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── Registrations.mocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── COMBINED_MOCKS.md │ │ │ │ │ │ ├── EMPTY_EVENT_CHECKINS_MOCK.md │ │ │ │ │ │ ├── EMPTY_REGISTRANTS_MOCK.md │ │ │ │ │ │ ├── EMPTY_STATE_MOCKS.md │ │ │ │ │ │ ├── ERROR_DELETION_MOCKS.md │ │ │ │ │ │ ├── EVENT_CHECKINS_MOCK.md │ │ │ │ │ │ ├── EVENT_DETAILS_MOCK.md │ │ │ │ │ │ ├── MISSING_DATE_MOCKS.md │ │ │ │ │ │ ├── MISSING_NAME_MOCKS.md │ │ │ │ │ │ ├── RECURRING_EVENT_DETAILS_MOCK.md │ │ │ │ │ │ ├── RECURRING_EVENT_MOCKS.md │ │ │ │ │ │ ├── RECURRING_EVENT_REGISTRANTS_MOCK.md │ │ │ │ │ │ ├── REGISTRANTS_ERROR_USER_MOCK.md │ │ │ │ │ │ ├── REGISTRANTS_MISSING_DATE_MOCK.md │ │ │ │ │ │ ├── REGISTRANTS_MISSING_NAME_MOCK.md │ │ │ │ │ │ ├── REGISTRANTS_MOCK.md │ │ │ │ │ │ ├── REMOVE_ATTENDEE_ERROR_MOCK.md │ │ │ │ │ │ └── REMOVE_ATTENDEE_SUCCESS_MOCK.md │ │ │ │ │ ├── EventRegistrantsModal/ │ │ │ │ │ │ ├── EventRegistrantsWrapper/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── EventRegistrantsWrapper.md │ │ │ │ │ │ └── Modal/ │ │ │ │ │ │ ├── AddOnSpot/ │ │ │ │ │ │ │ └── AddOnSpotAttendee/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── EventRegistrantsModal/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── EventRegistrantsModal.md │ │ │ │ │ │ └── InviteByEmail/ │ │ │ │ │ │ └── InviteByEmailModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── LeftDrawer/ │ │ │ │ │ │ └── LeftDrawer/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── ILeftDrawerProps.md │ │ │ │ │ ├── OrgContriCards/ │ │ │ │ │ │ └── OrgContriCards/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrgPeopleListCard/ │ │ │ │ │ │ └── OrgPeopleListCard/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrgSettings/ │ │ │ │ │ │ ├── ActionItemCategories/ │ │ │ │ │ │ │ ├── Modal/ │ │ │ │ │ │ │ │ ├── ActionItemCategoryModal/ │ │ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ │ │ └── IActionItemCategoryModal.md │ │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ │ └── ActionItemCategoryViewModal/ │ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ │ └── ICategoryViewModalProps.md │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ ├── OrgActionItemCategories/ │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── OrgActionItemCategoryMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ ├── MOCKS_EMPTY.md │ │ │ │ │ │ │ └── MOCKS_ERROR.md │ │ │ │ │ │ └── General/ │ │ │ │ │ │ ├── DeleteOrg/ │ │ │ │ │ │ │ └── DeleteOrg/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── GeneralSettings/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── OrgUpdate/ │ │ │ │ │ │ ├── OrgUpdate/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── OrgUpdateMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── FIXED_UTC_TIMESTAMP.md │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS_QUERY_ERROR.md │ │ │ │ │ │ ├── MOCKS_QUERY_ERROR_FETCH.md │ │ │ │ │ │ ├── MOCKS_UPDATE_ERROR.md │ │ │ │ │ │ ├── mockOrgData.md │ │ │ │ │ │ ├── mockOrgDataWithEmptyFields.md │ │ │ │ │ │ ├── mockOrgDataWithNullUserReg.md │ │ │ │ │ │ └── mockUpdateOrgResponse.md │ │ │ │ │ ├── OrganizationDashCards/ │ │ │ │ │ │ ├── CardItem/ │ │ │ │ │ │ │ ├── CardItem/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── Loader/ │ │ │ │ │ │ │ └── CardItemLoading/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── DashboardCard/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── Loader/ │ │ │ │ │ │ └── DashboardCardLoading/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrganizationScreen/ │ │ │ │ │ │ └── OrganizationScreen/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── translationKeyMap.md │ │ │ │ │ ├── SecuredRoute/ │ │ │ │ │ │ └── SecuredRoute/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── SuperAdminScreen/ │ │ │ │ │ │ └── SuperAdminScreen/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── TagActions/ │ │ │ │ │ │ ├── Node/ │ │ │ │ │ │ │ ├── TagNode/ │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── TagNodeMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS1.md │ │ │ │ │ │ │ └── MOCKS_ERROR_SUBTAGS_QUERY1.md │ │ │ │ │ │ ├── TagActions/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── TagActionsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS_ERROR_ASSIGN_OR_REMOVAL_TAGS.md │ │ │ │ │ │ └── MOCKS_ERROR_SUBTAGS_QUERY.md │ │ │ │ │ ├── UpdateSession/ │ │ │ │ │ │ └── UpdateSession/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── UserTableRow/ │ │ │ │ │ │ └── UserTableRow/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── UserTableRow.md │ │ │ │ │ └── Venues/ │ │ │ │ │ ├── Modal/ │ │ │ │ │ │ └── VenueModal/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceVenueModalProps.md │ │ │ │ │ ├── VenueCard/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── VenueCardMocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── MOCK_VENUE_ITEM.md │ │ │ │ │ ├── MOCK_VENUE_ITEM_LONG_TEXT.md │ │ │ │ │ └── MOCK_VENUE_ITEM_WITH_IMAGE.md │ │ │ │ ├── Auth/ │ │ │ │ │ ├── LoginForm/ │ │ │ │ │ │ └── LoginForm/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── LoginForm.md │ │ │ │ │ ├── OAuthButton/ │ │ │ │ │ │ └── OAuthButton/ │ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ │ ├── OAuthMode.md │ │ │ │ │ │ │ └── OAuthSize.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── OAuthButton.md │ │ │ │ │ ├── OrgSelector/ │ │ │ │ │ │ └── OrgSelector/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── OrgSelector.md │ │ │ │ │ ├── PasswordStrengthIndicator/ │ │ │ │ │ │ ├── PasswordStrengthIndicator/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── PasswordStrengthIndicator.md │ │ │ │ │ │ └── RequirementRow/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── RequirementRow.md │ │ │ │ │ ├── RegistrationForm/ │ │ │ │ │ │ └── RegistrationForm/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── RegistrationForm.md │ │ │ │ │ └── theme/ │ │ │ │ │ └── oauthBrand/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── brandForProvider.md │ │ │ │ ├── ChangeLanguageDropdown/ │ │ │ │ │ └── ChangeLanguageDropDown/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── CollapsibleDropdown/ │ │ │ │ │ └── CollapsibleDropdown/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── CursorPaginationManager/ │ │ │ │ │ └── CursorPaginationManager/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── CursorPaginationManager.md │ │ │ │ ├── EventCalender/ │ │ │ │ │ ├── EventCalenderMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ └── eventData.md │ │ │ │ │ ├── Header/ │ │ │ │ │ │ └── EventHeader/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── Monthly/ │ │ │ │ │ │ └── EventCalender/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── Yearly/ │ │ │ │ │ └── YearlyEventCalender/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── EventDashboardScreen/ │ │ │ │ │ ├── EventDashboardScreen/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── EventDashboardScreenMocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── MOCKS.md │ │ │ │ ├── EventStats/ │ │ │ │ │ ├── EventStatsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── diverseRatingsProps.md │ │ │ │ │ │ ├── emptyProps.md │ │ │ │ │ │ ├── mockData.md │ │ │ │ │ │ └── nonEmptyProps.md │ │ │ │ │ └── Statistics/ │ │ │ │ │ ├── AverageRating/ │ │ │ │ │ │ └── AverageRating/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── AverageRating.md │ │ │ │ │ ├── EventStats/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── EventStats.md │ │ │ │ │ ├── Feedback/ │ │ │ │ │ │ └── Feedback/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── FeedbackStats.md │ │ │ │ │ └── Review/ │ │ │ │ │ └── Review/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── ReviewStats.md │ │ │ │ ├── HolidayCards/ │ │ │ │ │ └── HolidayCard/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── IconComponent/ │ │ │ │ │ └── IconComponent/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── IIconComponent.md │ │ │ │ ├── LeftDrawerOrg/ │ │ │ │ │ └── LeftDrawerOrg/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── ILeftDrawerProps.md │ │ │ │ ├── NotificationIcon/ │ │ │ │ │ └── NotificationIcon/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── Pagination/ │ │ │ │ │ └── Navigator/ │ │ │ │ │ └── Pagination/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── ProfileCard/ │ │ │ │ │ └── ProfileCard/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── ProfileDropdown/ │ │ │ │ │ └── ProfileDropdown/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── SignOut/ │ │ │ │ │ └── SignOut/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── UserDetails/ │ │ │ │ │ ├── UserEvents/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── UserOrganizations/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── UserTags/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── UserPortal/ │ │ │ │ │ ├── ChatRoom/ │ │ │ │ │ │ ├── ChatHeader/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── ChatRoom/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── EmptyChatState/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── MessageImage/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── MessageInput/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── MessageItem/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── types/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── INewChat.md │ │ │ │ │ │ └── InterfaceChatHeaderProps.md │ │ │ │ │ ├── CommentCard/ │ │ │ │ │ │ └── CommentCard/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── ContactCard/ │ │ │ │ │ │ └── ContactCard/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── CreateDirectChat/ │ │ │ │ │ │ └── CreateDirectChat/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── CreateGroupChat/ │ │ │ │ │ │ └── CreateGroupChat/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── DonationCard/ │ │ │ │ │ │ └── DonationCard/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── EventCard/ │ │ │ │ │ │ └── EventCard/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── GroupChatDetails/ │ │ │ │ │ │ ├── GroupChatDetails/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── GroupChatDetailsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── delayedMocks.md │ │ │ │ │ │ ├── failingMocks.md │ │ │ │ │ │ ├── filledMockChat.md │ │ │ │ │ │ ├── incompleteMockChat.md │ │ │ │ │ │ └── mocks.md │ │ │ │ │ ├── OrganizationSidebar/ │ │ │ │ │ │ └── OrganizationSidebar/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── SecuredRouteForUser/ │ │ │ │ │ │ └── SecuredRouteForUser/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── UserNavbar/ │ │ │ │ │ │ └── UserNavbar/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── UserPortalCard/ │ │ │ │ │ │ └── UserPortalCard/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── UserPortalNavigationBar/ │ │ │ │ │ │ ├── LanguageSelector/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── UserDropdown/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── UserPortalNavigationBar/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── UserPortalNavigationBar.md │ │ │ │ │ │ └── UserPortalNavigationBarMocks/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── getMockIcon.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── logoutErrorMock.md │ │ │ │ │ │ ├── logoutMock.md │ │ │ │ │ │ ├── logoutNetworkErrorMock.md │ │ │ │ │ │ ├── mockNavigationLinksBase.md │ │ │ │ │ │ ├── mockOrganizationId.md │ │ │ │ │ │ ├── mockOrganizationName.md │ │ │ │ │ │ ├── mockUserId.md │ │ │ │ │ │ ├── mockUserName.md │ │ │ │ │ │ ├── organizationDataErrorMock.md │ │ │ │ │ │ ├── organizationDataMock.md │ │ │ │ │ │ └── organizationDataNullMock.md │ │ │ │ │ ├── UserProfileSettings/ │ │ │ │ │ │ └── UserProfile/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── UserSidebar/ │ │ │ │ │ │ └── UserSidebar/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceUserSidebarProps.md │ │ │ │ │ └── UserSidebarOrg/ │ │ │ │ │ └── UserSidebarOrg/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceUserSidebarOrgProps.md │ │ │ │ └── UsersTableItem/ │ │ │ │ ├── UserTableItemMocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ ├── MOCKS2.md │ │ │ │ │ └── MOCKS_UPDATE.md │ │ │ │ └── UsersTableItem/ │ │ │ │ └── functions/ │ │ │ │ └── default.md │ │ │ ├── config/ │ │ │ │ └── oauthProviders/ │ │ │ │ ├── functions/ │ │ │ │ │ ├── getEnabledProviders.md │ │ │ │ │ └── getProviderConfig.md │ │ │ │ └── variables/ │ │ │ │ └── OAUTH_PROVIDERS.md │ │ │ ├── constants/ │ │ │ │ └── variables/ │ │ │ │ └── socialMediaLinks.md │ │ │ ├── hooks/ │ │ │ │ ├── auth/ │ │ │ │ │ ├── useAuthNotifications/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── useAuthNotifications.md │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceToastConfig.md │ │ │ │ │ ├── useLogin/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── useLogin.md │ │ │ │ │ └── useRegistration/ │ │ │ │ │ ├── classes/ │ │ │ │ │ │ └── RegistrationError.md │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── useRegistration.md │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── IRegisterInput.md │ │ │ │ │ │ └── IRegistrationSuccessResult.md │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ └── RegistrationErrorCodeType.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── RegistrationErrorCode.md │ │ │ │ ├── useAvatarUpload/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── useAvatarUpload.md │ │ │ │ ├── useFieldValidation/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── useFieldValidation.md │ │ │ │ ├── usePasswordVisibility/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── usePasswordVisibility.md │ │ │ │ └── useUserProfile/ │ │ │ │ └── functions/ │ │ │ │ └── default.md │ │ │ ├── index/ │ │ │ │ └── variables/ │ │ │ │ └── client.md │ │ │ ├── install/ │ │ │ │ ├── functions/ │ │ │ │ │ ├── handleDirectExecutionError.md │ │ │ │ │ ├── main.md │ │ │ │ │ └── runIfDirectExecution.md │ │ │ │ ├── os/ │ │ │ │ │ ├── detector/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ ├── detectOS.md │ │ │ │ │ │ └── isRunningInWsl.md │ │ │ │ │ ├── linux/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ ├── installDocker.md │ │ │ │ │ │ └── installTypeScript.md │ │ │ │ │ ├── macos/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ ├── installDocker.md │ │ │ │ │ │ └── installTypeScript.md │ │ │ │ │ └── windows/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── installDocker.md │ │ │ │ │ └── installTypeScript.md │ │ │ │ ├── packages/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── installPackage.md │ │ │ │ ├── types/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── IOSInfo.md │ │ │ │ │ │ └── IPackageStatus.md │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ ├── LinuxDistro.md │ │ │ │ │ │ ├── OS.md │ │ │ │ │ │ └── PackageName.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── PACKAGE_NAMES.md │ │ │ │ └── utils/ │ │ │ │ ├── checker/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── checkInstalledPackages.md │ │ │ │ │ └── checkPackage.md │ │ │ │ ├── checkers/ │ │ │ │ │ ├── docker/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── checkDocker.md │ │ │ │ │ └── typescript/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── checkTypeScript.md │ │ │ │ ├── exec/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ ├── checkVersion.md │ │ │ │ │ │ ├── commandExists.md │ │ │ │ │ │ └── execCommand.md │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── IExecOptions.md │ │ │ │ │ │ └── IExecResult.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── deps.md │ │ │ │ └── logger/ │ │ │ │ ├── functions/ │ │ │ │ │ ├── createSpinner.md │ │ │ │ │ ├── logError.md │ │ │ │ │ ├── logInfo.md │ │ │ │ │ ├── logStep.md │ │ │ │ │ ├── logSuccess.md │ │ │ │ │ └── logWarning.md │ │ │ │ └── interfaces/ │ │ │ │ └── ISpinner.md │ │ │ ├── plugin/ │ │ │ │ ├── graphql-service/ │ │ │ │ │ ├── classes/ │ │ │ │ │ │ └── PluginGraphQLService.md │ │ │ │ │ ├── functions/ │ │ │ │ │ │ ├── useCreatePlugin.md │ │ │ │ │ │ ├── useDeletePlugin.md │ │ │ │ │ │ ├── useGetAllPlugins.md │ │ │ │ │ │ ├── useInstallPlugin.md │ │ │ │ │ │ └── useUpdatePlugin.md │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── ICreatePluginInput.md │ │ │ │ │ ├── IDeletePluginInput.md │ │ │ │ │ ├── IInstallPluginInput.md │ │ │ │ │ ├── IPlugin.md │ │ │ │ │ └── IUpdatePluginInput.md │ │ │ │ ├── hooks/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── useLoadedPlugins.md │ │ │ │ │ ├── usePluginDrawerItems.md │ │ │ │ │ ├── usePluginInjectors.md │ │ │ │ │ └── usePluginRoutes.md │ │ │ │ ├── manager/ │ │ │ │ │ ├── classes/ │ │ │ │ │ │ └── PluginManager.md │ │ │ │ │ └── functions/ │ │ │ │ │ ├── getPluginManager.md │ │ │ │ │ └── resetPluginManager.md │ │ │ │ ├── managers/ │ │ │ │ │ ├── discovery/ │ │ │ │ │ │ └── classes/ │ │ │ │ │ │ └── DiscoveryManager.md │ │ │ │ │ ├── event-manager/ │ │ │ │ │ │ └── classes/ │ │ │ │ │ │ └── EventManager.md │ │ │ │ │ ├── extension-registry/ │ │ │ │ │ │ └── classes/ │ │ │ │ │ │ └── ExtensionRegistryManager.md │ │ │ │ │ └── lifecycle/ │ │ │ │ │ └── classes/ │ │ │ │ │ └── LifecycleManager.md │ │ │ │ ├── registry/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ ├── createErrorComponent.md │ │ │ │ │ │ ├── createLazyPluginComponent.md │ │ │ │ │ │ ├── discoverAndRegisterAllPlugins.md │ │ │ │ │ │ ├── extractComponentNames.md │ │ │ │ │ │ ├── getPluginComponent.md │ │ │ │ │ │ ├── getPluginComponents.md │ │ │ │ │ │ ├── getPluginManifest.md │ │ │ │ │ │ ├── initializePluginSystem.md │ │ │ │ │ │ ├── isPluginRegistered.md │ │ │ │ │ │ └── registerPluginDynamically.md │ │ │ │ │ └── variables/ │ │ │ │ │ ├── manifestCache.md │ │ │ │ │ └── pluginRegistry.md │ │ │ │ ├── services/ │ │ │ │ │ ├── AdminPluginFileService/ │ │ │ │ │ │ ├── classes/ │ │ │ │ │ │ │ └── AdminPluginFileService.md │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── IInstalledPlugin.md │ │ │ │ │ │ │ ├── IPluginFileValidationResult.md │ │ │ │ │ │ │ └── IPluginInstallationResult.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── adminPluginFileService.md │ │ │ │ │ └── InternalFileWriter/ │ │ │ │ │ ├── classes/ │ │ │ │ │ │ └── InternalFileWriter.md │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── IFileOperationResult.md │ │ │ │ │ │ └── IFileWriteResult.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── internalFileWriter.md │ │ │ │ ├── types/ │ │ │ │ │ ├── enumerations/ │ │ │ │ │ │ ├── ExtensionPointType.md │ │ │ │ │ │ └── PluginStatus.md │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── IDrawerExtension.md │ │ │ │ │ ├── IExtensionPoints.md │ │ │ │ │ ├── IExtensionRegistry.md │ │ │ │ │ ├── IInjectorExtension.md │ │ │ │ │ ├── IInstalledPlugin.md │ │ │ │ │ ├── ILoadedPlugin.md │ │ │ │ │ ├── IPluginDetails.md │ │ │ │ │ ├── IPluginDrawerItemsProps.md │ │ │ │ │ ├── IPluginInfo.md │ │ │ │ │ ├── IPluginLifecycle.md │ │ │ │ │ ├── IPluginManifest.md │ │ │ │ │ ├── IPluginMeta.md │ │ │ │ │ ├── IPluginModalProps.md │ │ │ │ │ ├── IPluginRouterProps.md │ │ │ │ │ ├── IPluginStoreProps.md │ │ │ │ │ └── IRouteExtension.md │ │ │ │ ├── utils/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── filterByPermissions.md │ │ │ │ │ ├── generatePluginId.md │ │ │ │ │ ├── sortDrawerItems.md │ │ │ │ │ └── validatePluginManifest.md │ │ │ │ ├── variables/ │ │ │ │ │ ├── PluginInjector.md │ │ │ │ │ ├── PluginRouteRenderer.md │ │ │ │ │ └── PluginRoutes.md │ │ │ │ └── vite/ │ │ │ │ └── internalFileWriterPlugin/ │ │ │ │ ├── functions/ │ │ │ │ │ └── createInternalFileWriterPlugin.md │ │ │ │ └── interfaces/ │ │ │ │ └── IInternalFileWriterPluginOptions.md │ │ │ ├── reportWebVitals/ │ │ │ │ └── functions/ │ │ │ │ └── default.md │ │ │ ├── screens/ │ │ │ │ ├── AdminPortal/ │ │ │ │ │ ├── BlockUser/ │ │ │ │ │ │ └── BlockUser/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── CommunityProfile/ │ │ │ │ │ │ └── CommunityProfile/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── EventManagement/ │ │ │ │ │ │ └── EventManagement/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── EventVolunteers/ │ │ │ │ │ │ ├── Requests/ │ │ │ │ │ │ │ ├── Requests/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── Requests.mocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ │ │ ├── ERROR_MOCKS.md │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ ├── MOCKS_WITH_FILTER_DATA.md │ │ │ │ │ │ │ └── UPDATE_ERROR_MOCKS.md │ │ │ │ │ │ ├── VolunteerContainer/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── VolunteerGroups/ │ │ │ │ │ │ │ ├── VolunteerGroups/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ ├── deleteModal/ │ │ │ │ │ │ │ │ └── VolunteerGroupDeleteModal/ │ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ │ └── InterfaceDeleteVolunteerGroupModal.md │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── modal/ │ │ │ │ │ │ │ ├── VolunteerGroupModal/ │ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ │ └── InterfaceVolunteerGroupModal.md │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── VolunteerGroups.mocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ ├── MOCKS_EMPTY.md │ │ │ │ │ │ │ └── MOCKS_ERROR.md │ │ │ │ │ │ └── Volunteers/ │ │ │ │ │ │ ├── Volunteers/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── Volunteers.mocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ ├── MOCKS_EMPTY.md │ │ │ │ │ │ │ └── MOCKS_ERROR.md │ │ │ │ │ │ ├── createModal/ │ │ │ │ │ │ │ └── VolunteerCreateModal/ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ └── InterfaceVolunteerCreateModal.md │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── deleteModal/ │ │ │ │ │ │ │ └── VolunteerDeleteModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── viewModal/ │ │ │ │ │ │ └── VolunteerViewModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── FundCampaignPledge/ │ │ │ │ │ │ ├── FundCampaignPledge/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── PledgeColumns/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── getPledgeColumns.md │ │ │ │ │ │ ├── Pledges.mocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ ├── MOCKS_DELETE_PLEDGE_ERROR.md │ │ │ │ │ │ │ ├── MOCKS_FUND_CAMPAIGN_PLEDGE_ERROR.md │ │ │ │ │ │ │ ├── PLEDGE_MODAL_ERROR_MOCKS.md │ │ │ │ │ │ │ └── PLEDGE_MODAL_MOCKS.md │ │ │ │ │ │ ├── deleteModal/ │ │ │ │ │ │ │ └── PledgeDeleteModal/ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ └── InterfaceDeletePledgeModal.md │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── modal/ │ │ │ │ │ │ └── PledgeModal/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfacePledgeModal.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── Leaderboard/ │ │ │ │ │ │ ├── Leaderboard/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── Leaderboard.mocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ │ ├── ERROR_MOCKS.md │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ └── SEARCH_EMPTY_MOCKS.md │ │ │ │ │ ├── ManageTag/ │ │ │ │ │ │ ├── ManageTag/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ ├── default.md │ │ │ │ │ │ │ └── getManageTagErrorMessage.md │ │ │ │ │ │ ├── ManageTagMockComponents/ │ │ │ │ │ │ │ ├── MockAddPeopleToTag/ │ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── MockTagActions/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── ManageTagMockUtils/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── buildAssignedUsers.md │ │ │ │ │ │ ├── ManageTagMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ └── MOCKS_ERROR_ASSIGNED_MEMBERS.md │ │ │ │ │ │ ├── ManageTagNonErrorMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS_ERROR_OBJECT.md │ │ │ │ │ │ │ ├── MOCKS_INFINITE_SCROLL_NULL_EDGES.md │ │ │ │ │ │ │ ├── MOCKS_INFINITE_SCROLL_NULL_FETCH_RESULT.md │ │ │ │ │ │ │ ├── MOCKS_INFINITE_SCROLL_PAGINATION.md │ │ │ │ │ │ │ ├── MOCKS_SUCCESS_REMOVE_USER_TAG.md │ │ │ │ │ │ │ ├── MOCKS_SUCCESS_UNASSIGN_USER_TAG.md │ │ │ │ │ │ │ ├── MOCKS_SUCCESS_UPDATE_USER_TAG.md │ │ │ │ │ │ │ └── MOCKS_WITH_ANCESTOR_TAGS.md │ │ │ │ │ │ ├── ManageTagNullFalsyMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS_EMPTY_ASSIGNED_MEMBERS_ARRAY.md │ │ │ │ │ │ │ ├── MOCKS_EMPTY_EDGES_ARRAY.md │ │ │ │ │ │ │ ├── MOCKS_EMPTY_PAGE_INFO.md │ │ │ │ │ │ │ ├── MOCKS_ERROR_REMOVE_USER_TAG.md │ │ │ │ │ │ │ ├── MOCKS_ERROR_UNASSIGN_USER_TAG.md │ │ │ │ │ │ │ ├── MOCKS_ERROR_UPDATE_USER_TAG.md │ │ │ │ │ │ │ ├── MOCKS_NULL_ANCESTOR_TAGS.md │ │ │ │ │ │ │ ├── MOCKS_NULL_DATA.md │ │ │ │ │ │ │ ├── MOCKS_NULL_USERS_ASSIGNED_TO.md │ │ │ │ │ │ │ └── MOCKS_UNDEFINED_DATA.md │ │ │ │ │ │ ├── editModal/ │ │ │ │ │ │ │ └── EditUserTagModal/ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ └── InterfaceEditUserTagModalProps.md │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── removeModal/ │ │ │ │ │ │ │ └── RemoveUserTagModal/ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ └── InterfaceRemoveUserTagModalProps.md │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── unassignModal/ │ │ │ │ │ │ └── UnassignUserTagModal/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceUnassignUserTagModalProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── MemberDetail/ │ │ │ │ │ │ ├── MemberDetail/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── UserContactDetails/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── fieldConfigs/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── addressFieldConfigs.md │ │ │ │ │ │ │ └── phoneFieldConfigs.md │ │ │ │ │ │ └── resolveAvatarFile/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── resolveAvatarFile.md │ │ │ │ │ ├── Notification/ │ │ │ │ │ │ └── Notification/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrgContribution/ │ │ │ │ │ │ └── OrgContribution/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrgList/ │ │ │ │ │ │ ├── OrgList/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── OrgListMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ ├── MOCKS_ADMIN.md │ │ │ │ │ │ │ └── MOCKS_EMPTY.md │ │ │ │ │ │ └── modal/ │ │ │ │ │ │ └── OrganizationModal/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceOrganizationModalProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrgSettings/ │ │ │ │ │ │ ├── OrgSettings/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── OrgSettings.mocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── MOCKS.md │ │ │ │ │ ├── OrganizationDashboard/ │ │ │ │ │ │ ├── OrganizationDashboard/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── OrganizationDashboardMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ │ │ ├── ERROR_MOCKS.md │ │ │ │ │ │ │ └── MOCKS.md │ │ │ │ │ │ ├── OrganizationDashboardSecondaryMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── MOCKS_ORG2.md │ │ │ │ │ │ └── components/ │ │ │ │ │ │ ├── DashboardStats/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── UpcomingEventsCard/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrganizationEvents/ │ │ │ │ │ │ ├── CreateEventModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── OrganizationEvents/ │ │ │ │ │ │ │ ├── enumerations/ │ │ │ │ │ │ │ │ └── ViewType.md │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── OrganizationEventsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── MOCKS.md │ │ │ │ │ ├── OrganizationFundCampaign/ │ │ │ │ │ │ ├── OrganizationFundCampaignMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ └── MOCK_ERROR.md │ │ │ │ │ │ ├── OrganizationFundCampaigns/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── modal/ │ │ │ │ │ │ ├── CampaignModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── types/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── IDateRangeValue.md │ │ │ │ │ │ └── InterfaceCampaignModal.md │ │ │ │ │ ├── OrganizationFunds/ │ │ │ │ │ │ ├── OrganizationFunds/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── OrganizationFundsMocks/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ │ ├── MOCKS_ERROR.md │ │ │ │ │ │ │ └── NO_FUNDS.md │ │ │ │ │ │ └── modal/ │ │ │ │ │ │ └── FundModal/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceFundModal.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrganizationPeople/ │ │ │ │ │ │ ├── OrganizationPeople/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── addMember/ │ │ │ │ │ │ ├── AddMember/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── types/ │ │ │ │ │ │ ├── enumerations/ │ │ │ │ │ │ │ └── OrganizationMembershipRole.md │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── IEdge.md │ │ │ │ │ │ ├── IQueryVariable.md │ │ │ │ │ │ └── IUserDetails.md │ │ │ │ │ ├── OrganizationTags/ │ │ │ │ │ │ ├── OrganizationTags/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── OrganizationTagsMocks/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ ├── makeTagEdge.md │ │ │ │ │ │ │ └── makeUserTags.md │ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ │ └── TagEdge.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS_ASCENDING_NO_SEARCH.md │ │ │ │ │ │ ├── MOCKS_EMPTY.md │ │ │ │ │ │ ├── MOCKS_ERROR.md │ │ │ │ │ │ ├── MOCKS_ERROR_ERROR_TAG.md │ │ │ │ │ │ ├── MOCKS_FETCHMORE_UNDEFINED.md │ │ │ │ │ │ ├── MOCKS_NO_MORE_PAGES.md │ │ │ │ │ │ ├── MOCKS_NULL_END_CURSOR.md │ │ │ │ │ │ ├── MOCKS_UNDEFINED_USER_TAGS.md │ │ │ │ │ │ └── MOCK_RESPONSES.md │ │ │ │ │ ├── OrganizationTransactions/ │ │ │ │ │ │ └── OrganizationTransactions/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── OrganizationVenues/ │ │ │ │ │ │ └── OrganizationVenues/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── PluginStore/ │ │ │ │ │ │ ├── PluginModal/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── PluginStore/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── UploadPluginModal/ │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ ├── components/ │ │ │ │ │ │ │ ├── PluginCard/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ ├── PluginList/ │ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ │ └── UninstallConfirmationModal/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── hooks/ │ │ │ │ │ │ ├── useInstallTimer/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── useInstallTimer.md │ │ │ │ │ │ ├── usePluginActions/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── usePluginActions.md │ │ │ │ │ │ └── usePluginFilters/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── usePluginFilters.md │ │ │ │ │ ├── Requests/ │ │ │ │ │ │ ├── Requests/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── RequestsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ │ ├── EMPTY_REQUEST_MOCKS.md │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS4.md │ │ │ │ │ │ ├── MOCKS_WITH_ERROR.md │ │ │ │ │ │ └── UPDATED_MOCKS.md │ │ │ │ │ ├── SubTags/ │ │ │ │ │ │ ├── SubTags/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── SubTagsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS_CREATE_TAG_ERROR.md │ │ │ │ │ │ ├── MOCKS_ERROR_SUB_TAGS.md │ │ │ │ │ │ └── emptyMocks.md │ │ │ │ │ └── Users/ │ │ │ │ │ ├── Organization.mocks/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── generateMockUser.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCK_USERS.md │ │ │ │ │ │ ├── createAddress.md │ │ │ │ │ │ └── createCreator.md │ │ │ │ │ ├── User.mocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ └── MOCKS2.md │ │ │ │ │ ├── Users/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ ├── default.md │ │ │ │ │ │ ├── isValidFilteringOption.md │ │ │ │ │ │ └── isValidSortingOption.md │ │ │ │ │ └── UsersMocks.mocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ ├── MOCKS_NEW.md │ │ │ │ │ ├── MOCKS_NEW_2.md │ │ │ │ │ └── USER_UNDEFINED_MOCK.md │ │ │ │ ├── Auth/ │ │ │ │ │ ├── ForgotPassword/ │ │ │ │ │ │ └── ForgotPassword/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── LoginPage/ │ │ │ │ │ │ └── LoginPage/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── VerifyEmail/ │ │ │ │ │ └── VerifyEmail/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── Public/ │ │ │ │ │ ├── Invitation/ │ │ │ │ │ │ └── AcceptInvitation/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── PageNotFound/ │ │ │ │ │ └── PageNotFound/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ └── UserPortal/ │ │ │ │ ├── Campaigns/ │ │ │ │ │ ├── Campaigns/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── CampaignWithStatus.md │ │ │ │ │ ├── CampaignsMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS_WITH_FUND_NO_CAMPAIGNS.md │ │ │ │ │ │ ├── MOCKS_WITH_NO_FUNDS.md │ │ │ │ │ │ ├── MOCKS_WITH_NULL_ORGANIZATION.md │ │ │ │ │ │ ├── MOCKS_WITH_PENDING_CAMPAIGN.md │ │ │ │ │ │ ├── MOCKS_WITH_UNDEFINED_CAMPAIGNS.md │ │ │ │ │ │ └── USER_FUND_CAMPAIGNS_ERROR.md │ │ │ │ │ └── PledgeModal/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ ├── areOptionsEqual.md │ │ │ │ │ │ └── getMemberLabel.md │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ └── InterfacePledgeModal.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── Chat/ │ │ │ │ │ └── Chat/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── Donate/ │ │ │ │ │ └── Donate/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── Events/ │ │ │ │ │ └── Events/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── computeCalendarFromStartDate.md │ │ │ │ │ └── default.md │ │ │ │ ├── LeaveOrganization/ │ │ │ │ │ └── LeaveOrganization/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── variables/ │ │ │ │ │ ├── userEmail.md │ │ │ │ │ └── userId.md │ │ │ │ ├── Organizations/ │ │ │ │ │ └── Organizations/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── People/ │ │ │ │ │ └── People/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── Pledges/ │ │ │ │ │ ├── Pledges/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── PledgesMocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── MOCKS.md │ │ │ │ ├── Transactions/ │ │ │ │ │ └── Transactions/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── UserGlobalScreen/ │ │ │ │ │ └── UserGlobalScreen/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── UserScreen/ │ │ │ │ │ └── UserScreen/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ └── Volunteer/ │ │ │ │ ├── Actions/ │ │ │ │ │ ├── Actions/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── Actions.mocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ ├── ERROR_MOCKS.md │ │ │ │ │ └── MOCKS.md │ │ │ │ ├── Groups/ │ │ │ │ │ ├── GroupModal/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceGroupModal.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── Groups/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── Groups.mocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ └── UPDATE_ERROR_MOCKS.md │ │ │ │ ├── Invitations/ │ │ │ │ │ └── Invitations/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── UpcomingEvents/ │ │ │ │ │ ├── RecurringEventVolunteerModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── UpcomingEvents/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── getStatusBadgeProps.md │ │ │ │ │ ├── UpcomingEvents.mockEvents/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── baseRecurringEvent.md │ │ │ │ │ │ ├── duplicateInstanceEvent.md │ │ │ │ │ │ ├── event1.md │ │ │ │ │ │ ├── event2.md │ │ │ │ │ │ ├── event3.md │ │ │ │ │ │ ├── nullVolunteerGroups.md │ │ │ │ │ │ ├── pastEvent.md │ │ │ │ │ │ └── recurringInstanceEvent.md │ │ │ │ │ ├── UpcomingEvents.mockHelpers/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ ├── createEventVolunteer.md │ │ │ │ │ │ │ └── createMembershipRecord.md │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceEventVolunteerOverride.md │ │ │ │ │ │ └── InterfaceMembershipOptions.md │ │ │ │ │ └── UpcomingEvents.mocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── EMPTY_MOCKS.md │ │ │ │ │ ├── ERROR_MOCKS.md │ │ │ │ │ ├── MEMBERSHIP_LOOKUP_MOCKS.md │ │ │ │ │ └── MOCKS.md │ │ │ │ └── VolunteerManagement/ │ │ │ │ └── functions/ │ │ │ │ └── default.md │ │ │ ├── setup/ │ │ │ │ ├── askAndSetDockerOption/ │ │ │ │ │ └── askAndSetDockerOption/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── askAndUpdatePort/ │ │ │ │ │ └── askAndUpdatePort/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── askForCustomPort/ │ │ │ │ │ └── askForCustomPort/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── askForCustomPort.md │ │ │ │ │ ├── reservedPortWarning.md │ │ │ │ │ └── validatePort.md │ │ │ │ ├── askForDocker/ │ │ │ │ │ └── askForDocker/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── askAndUpdateTalawaApiUrl.md │ │ │ │ │ └── askForDocker.md │ │ │ │ ├── askForTalawaApiUrl/ │ │ │ │ │ └── askForTalawaApiUrl/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── askForTalawaApiUrl.md │ │ │ │ ├── backupEnvFile/ │ │ │ │ │ └── backupEnvFile/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── backupEnvFile.md │ │ │ │ ├── checkConnection/ │ │ │ │ │ └── checkConnection/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── checkConnection.md │ │ │ │ ├── checkEnvFile/ │ │ │ │ │ └── checkEnvFile/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── checkEnvFile.md │ │ │ │ │ └── modifyEnvFile.md │ │ │ │ ├── setup/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ ├── askAndSetLogErrors.md │ │ │ │ │ │ ├── askAndSetRecaptcha.md │ │ │ │ │ │ └── main.md │ │ │ │ │ └── variables/ │ │ │ │ │ ├── ENV_KEYS.md │ │ │ │ │ └── ENV_VALUES.md │ │ │ │ ├── updateEnvFile/ │ │ │ │ │ └── updateEnvFile/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── updateEnvFile.md │ │ │ │ └── validateRecaptcha/ │ │ │ │ └── validateRecaptcha/ │ │ │ │ └── functions/ │ │ │ │ └── validateRecaptcha.md │ │ │ ├── shared-components/ │ │ │ │ ├── ActionItems/ │ │ │ │ │ ├── ActionItem.mocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── MOCKS.md │ │ │ │ │ │ ├── MOCKS_ERROR.md │ │ │ │ │ │ ├── actionItemCategory1.md │ │ │ │ │ │ ├── actionItemCategory2.md │ │ │ │ │ │ ├── actionItemCategoryListQuery.md │ │ │ │ │ │ ├── actionItemListQuery.md │ │ │ │ │ │ ├── actionItemListQueryError.md │ │ │ │ │ │ ├── baseActionItem.md │ │ │ │ │ │ ├── completeActionForInstanceMutation.md │ │ │ │ │ │ ├── completeActionForInstanceMutationError.md │ │ │ │ │ │ ├── deleteActionItemForInstanceMutation.md │ │ │ │ │ │ ├── deleteActionItemForInstanceMutationError.md │ │ │ │ │ │ ├── deleteActionItemMutation.md │ │ │ │ │ │ ├── deleteActionItemMutationError.md │ │ │ │ │ │ ├── itemWithEmptyAssigneeName.md │ │ │ │ │ │ ├── itemWithUser1.md │ │ │ │ │ │ ├── itemWithUser2.md │ │ │ │ │ │ ├── itemWithVolunteerGroup.md │ │ │ │ │ │ ├── itemWithoutAssignee.md │ │ │ │ │ │ ├── itemWithoutCategory.md │ │ │ │ │ │ ├── markActionAsPendingForInstanceMutation.md │ │ │ │ │ │ ├── markActionAsPendingForInstanceMutationError.md │ │ │ │ │ │ ├── markActionItemAsPendingMutation.md │ │ │ │ │ │ ├── markActionItemAsPendingMutationError.md │ │ │ │ │ │ ├── memberListQuery.md │ │ │ │ │ │ └── updateActionItemMutation.md │ │ │ │ │ ├── ActionItemDeleteModal/ │ │ │ │ │ │ └── ActionItemDeleteModal/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── IItemDeleteModalProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── ActionItemModal/ │ │ │ │ │ │ └── ActionItemModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── ActionItemUpdateModal/ │ │ │ │ │ │ └── ActionItemUpdateStatusModal/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── IItemUpdateStatusModalProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── ActionItemViewModal/ │ │ │ │ │ └── ActionItemViewModal/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ └── IViewModalProps.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── Auth/ │ │ │ │ │ ├── EmailField/ │ │ │ │ │ │ └── EmailField/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── EmailField.md │ │ │ │ │ ├── FormField/ │ │ │ │ │ │ └── FormField/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── FormField.md │ │ │ │ │ └── PasswordField/ │ │ │ │ │ └── PasswordField/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── PasswordField.md │ │ │ │ ├── Avatar/ │ │ │ │ │ └── Avatar/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── BaseModal/ │ │ │ │ │ └── BaseModal/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── BreadcrumbsComponent/ │ │ │ │ │ ├── SafeBreadcrumbs/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── functions/ │ │ │ │ │ └── BreadcrumbsComponent.md │ │ │ │ ├── Button/ │ │ │ │ │ ├── Button.types/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceButtonProps.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── ButtonIconPosition.md │ │ │ │ │ │ ├── ButtonProps.md │ │ │ │ │ │ ├── ButtonSize.md │ │ │ │ │ │ └── ButtonVariant.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── Button.md │ │ │ │ ├── CRUDModalTemplate/ │ │ │ │ │ ├── CRUDModalTemplate/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── CRUDModalTemplate.md │ │ │ │ │ ├── CreateModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── CreateModal.md │ │ │ │ │ ├── CreateModal.stories/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── BasicUsage.md │ │ │ │ │ │ ├── ComplexForm.md │ │ │ │ │ │ ├── LoadingState.md │ │ │ │ │ │ ├── SubmitDisabled.md │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── DeleteModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── DeleteModal.md │ │ │ │ │ ├── DeleteModal.stories/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── BasicUsage.md │ │ │ │ │ │ ├── DeleteOrganization.md │ │ │ │ │ │ ├── RecurringEvent.md │ │ │ │ │ │ ├── WithWarning.md │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── EditModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── EditModal.md │ │ │ │ │ ├── EditModal.stories/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── BasicUsage.md │ │ │ │ │ │ ├── ComplexForm.md │ │ │ │ │ │ ├── LoadingData.md │ │ │ │ │ │ ├── SubmitDisabled.md │ │ │ │ │ │ ├── SubmittingState.md │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── ViewModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── ViewModal.md │ │ │ │ │ ├── ViewModal.stories/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── BasicUsage.md │ │ │ │ │ │ ├── LoadingState.md │ │ │ │ │ │ ├── OrganizationDetails.md │ │ │ │ │ │ ├── UserProfile.md │ │ │ │ │ │ ├── WithCustomActions.md │ │ │ │ │ │ └── default.md │ │ │ │ │ └── hooks/ │ │ │ │ │ ├── useFormModal/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── useFormModal.md │ │ │ │ │ ├── useModalState/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── useModalState.md │ │ │ │ │ └── useMutationModal/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── useMutationModal.md │ │ │ │ ├── CheckIn/ │ │ │ │ │ ├── CheckInMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── checkInMutationSuccess.md │ │ │ │ │ │ ├── checkInMutationSuccessRecurring.md │ │ │ │ │ │ ├── checkInMutationUnsuccess.md │ │ │ │ │ │ └── checkInQueryMock.md │ │ │ │ │ ├── CheckInWrapper/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── CheckInWrapper.md │ │ │ │ │ ├── Modal/ │ │ │ │ │ │ ├── CheckInModal/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── CheckInModal.md │ │ │ │ │ │ └── Row/ │ │ │ │ │ │ └── TableRow/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── TableRow.md │ │ │ │ │ └── tagTemplate/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── tagTemplate.md │ │ │ │ ├── DataGridWrapper/ │ │ │ │ │ ├── DataGridErrorOverlay/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── DataGridErrorOverlay.md │ │ │ │ │ ├── DataGridLoadingOverlay/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── DataGridLoadingOverlay.md │ │ │ │ │ ├── DataGridWrapper/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ ├── DataGridWrapper.md │ │ │ │ │ │ └── convertTokenColumns.md │ │ │ │ │ └── DataGridWrapper.stories/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── BasicUsage.md │ │ │ │ │ ├── CompleteExample.md │ │ │ │ │ ├── EmptyState.md │ │ │ │ │ ├── ErrorState.md │ │ │ │ │ ├── LoadingState.md │ │ │ │ │ ├── SearchWithNoResults.md │ │ │ │ │ ├── WithActionColumn.md │ │ │ │ │ ├── WithPagination.md │ │ │ │ │ ├── WithRowClick.md │ │ │ │ │ ├── WithSearch.md │ │ │ │ │ ├── WithSorting.md │ │ │ │ │ └── default.md │ │ │ │ ├── DataTable/ │ │ │ │ │ ├── BulkActionsBar/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── BulkActionsBar.md │ │ │ │ │ ├── DataTable/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ ├── DataTable.md │ │ │ │ │ │ └── defaultCompare.md │ │ │ │ │ ├── DataTableSkeleton/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── DataTableSkeleton.md │ │ │ │ │ ├── DataTableTable/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── DataTableTable.md │ │ │ │ │ ├── LoadingMoreRows/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── LoadingMoreRows.md │ │ │ │ │ ├── Pagination/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── PaginationControls.md │ │ │ │ │ ├── SearchBar/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── SearchBar.md │ │ │ │ │ ├── TableLoader/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── TableLoader.md │ │ │ │ │ ├── cells/ │ │ │ │ │ │ └── ActionsCell/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── ActionsCell.md │ │ │ │ │ ├── hooks/ │ │ │ │ │ │ ├── useDataTableFiltering/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── useDataTableFiltering.md │ │ │ │ │ │ ├── useDataTableSelection/ │ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ │ └── useDataTableSelection.md │ │ │ │ │ │ ├── useSimpleTableData/ │ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ │ └── useSimpleTableData.md │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ ├── IUseSimpleTableDataOptions.md │ │ │ │ │ │ │ └── IUseSimpleTableDataResult.md │ │ │ │ │ │ └── useTableData/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── useTableData.md │ │ │ │ │ └── utils/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── getCellValue.md │ │ │ │ │ ├── renderCellValue.md │ │ │ │ │ ├── renderHeader.md │ │ │ │ │ └── toSearchableString.md │ │ │ │ ├── DatePicker/ │ │ │ │ │ └── DatePicker/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── DateRangePicker/ │ │ │ │ │ └── DateRangePicker/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── DropDownButton/ │ │ │ │ │ ├── DropDownButton.mocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── baseProps.md │ │ │ │ │ │ ├── basicOptions.md │ │ │ │ │ │ ├── customLabelProps.md │ │ │ │ │ │ ├── disabledDropdownProps.md │ │ │ │ │ │ ├── disabledOptionProps.md │ │ │ │ │ │ ├── dropUpProps.md │ │ │ │ │ │ ├── mockOnSelect.md │ │ │ │ │ │ ├── noSelectionProps.md │ │ │ │ │ │ ├── noTestIdProps.md │ │ │ │ │ │ ├── optionsWithDisabled.md │ │ │ │ │ │ ├── optionsWithNonStringLabel.md │ │ │ │ │ │ ├── searchableMinimalProps.md │ │ │ │ │ │ ├── searchableOptionsForCoverage.md │ │ │ │ │ │ ├── styledProps.md │ │ │ │ │ │ ├── variantProps.md │ │ │ │ │ │ ├── withIconProps.md │ │ │ │ │ │ ├── withIconSearchProps.md │ │ │ │ │ │ └── withNonStringLabelProps.md │ │ │ │ │ ├── SearchToggle/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── DropDownButton.md │ │ │ │ ├── EmptyState/ │ │ │ │ │ ├── EmptyState/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── EmptyStateMocks/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── emptyStateBaseForActionMock.md │ │ │ │ │ ├── emptyStateBaseMock.md │ │ │ │ │ ├── emptyStateWithAllPropsMock.md │ │ │ │ │ ├── emptyStateWithCustomCSSMock.md │ │ │ │ │ ├── emptyStateWithCustomDataTestIdMock.md │ │ │ │ │ ├── emptyStateWithCustomIconMock.md │ │ │ │ │ ├── emptyStateWithDescriptionMock.md │ │ │ │ │ └── emptyStateWithIconMock.md │ │ │ │ ├── ErrorBoundaryWrapper/ │ │ │ │ │ └── ErrorBoundaryWrapper/ │ │ │ │ │ └── classes/ │ │ │ │ │ └── ErrorBoundaryWrapper.md │ │ │ │ ├── ErrorPanel/ │ │ │ │ │ └── ErrorPanel/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ └── InterfaceErrorPanelProps.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── EventForm/ │ │ │ │ │ ├── EventForm/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── formatRecurrenceForPayload.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── RecurrenceDropdown/ │ │ │ │ │ │ └── RecurrenceDropdown/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── VisibilitySelector/ │ │ │ │ │ │ └── VisibilitySelector/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── utils/ │ │ │ │ │ ├── recurrenceOptions/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── buildRecurrenceOptions.md │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceRecurrenceOption.md │ │ │ │ │ ├── timeUtils/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── timeToDayJs.md │ │ │ │ │ └── visibilityUtils/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── getVisibilityType.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── EventVisibility.md │ │ │ │ ├── EventListCard/ │ │ │ │ │ ├── EventListCard/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── EventListCardProps.mock/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── props.md │ │ │ │ │ └── Modal/ │ │ │ │ │ ├── Delete/ │ │ │ │ │ │ └── EventListCardDeleteModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── EventListCardMocks/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── ERROR_MOCKS.md │ │ │ │ │ │ └── MOCKS.md │ │ │ │ │ ├── EventListCardModals/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── Preview/ │ │ │ │ │ │ └── EventListCardPreviewModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── updateLogic/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── useUpdateEventHandler.md │ │ │ │ ├── FormFieldGroup/ │ │ │ │ │ ├── FormCheckField/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── FormCheckField.md │ │ │ │ │ ├── FormFieldGroup/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── FormFieldGroup.md │ │ │ │ │ ├── FormSelectField/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── FormSelectField.md │ │ │ │ │ └── FormTextField/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── FormTextField.md │ │ │ │ ├── InfiniteScrollLoader/ │ │ │ │ │ └── InfiniteScrollLoader/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── LoadingState/ │ │ │ │ │ └── LoadingState/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── Navbar/ │ │ │ │ │ └── Navbar/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── NotificationToast/ │ │ │ │ │ └── NotificationToast/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── NotificationToastContainer.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── NotificationToast.md │ │ │ │ ├── OrganizationCard/ │ │ │ │ │ └── OrganizationCard/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceOrganizationCardPropsPG.md │ │ │ │ ├── PaginationList/ │ │ │ │ │ └── PaginationList/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── PeopleTabNavbar/ │ │ │ │ │ └── PeopleTabNavbar/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── PeopleTabNavbarButton/ │ │ │ │ │ └── PeopleTabNavbarButton/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── PeopleTabUserEvents/ │ │ │ │ │ └── PeopleTabUserEvents/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── PeopleTabUserOrganization/ │ │ │ │ │ └── PeopleTabUserOrganizations/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── PostViewModal/ │ │ │ │ │ └── PostViewModal/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── ProfileAvatarDisplay/ │ │ │ │ │ └── ProfileAvatarDisplay/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── ProfileAvatarDisplay.md │ │ │ │ ├── Recurrence/ │ │ │ │ │ ├── CustomRecurrenceModal/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── RecurrenceEndOptionsSection/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── RecurrenceEndOptionsSection.md │ │ │ │ │ ├── RecurrenceFrequencySection/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── RecurrenceFrequencySection.md │ │ │ │ │ ├── RecurrenceMonthlySection/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── RecurrenceMonthlySection.md │ │ │ │ │ ├── RecurrenceWeeklySection/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── RecurrenceWeeklySection.md │ │ │ │ │ └── RecurrenceYearlySection/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── RecurrenceYearlySection.md │ │ │ │ ├── ReportingTable/ │ │ │ │ │ └── ReportingTable/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ └── adjustColumnsForCompactMode.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── SearchBar/ │ │ │ │ │ └── SearchBar/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── SearchFilterBar/ │ │ │ │ │ └── SearchFilterBar/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── SidebarBase/ │ │ │ │ │ └── SidebarBase/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── SidebarNavItem/ │ │ │ │ │ └── SidebarNavItem/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── SidebarOrgSection/ │ │ │ │ │ └── SidebarOrgSection/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── SidebarPluginSection/ │ │ │ │ │ └── SidebarPluginSection/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── SortingButton/ │ │ │ │ │ └── SortingButton/ │ │ │ │ │ ├── namespaces/ │ │ │ │ │ │ └── default/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── propTypes.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── StatusBadge/ │ │ │ │ │ └── StatusBadge/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── TableLoader/ │ │ │ │ │ └── TableLoader/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── TimePicker/ │ │ │ │ │ └── TimePicker/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── TruncatedText/ │ │ │ │ │ └── TruncatedText/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── VolunteerGroupViewModal/ │ │ │ │ │ └── VolunteerGroupViewModal/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── pinnedPosts/ │ │ │ │ │ ├── pinnedPostCard/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── pinnedPostsLayout/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ ├── postCard/ │ │ │ │ │ └── PostCard/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── posts/ │ │ │ │ │ ├── createPostModal/ │ │ │ │ │ │ └── createPostModal/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── helperFunctions/ │ │ │ │ │ │ └── functions/ │ │ │ │ │ │ └── formatPostForCard.md │ │ │ │ │ └── posts/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ └── useDebounce/ │ │ │ │ └── useDebounce/ │ │ │ │ └── functions/ │ │ │ │ └── default.md │ │ │ ├── state/ │ │ │ │ ├── action-creators/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── updateTargets.md │ │ │ │ ├── helpers/ │ │ │ │ │ └── Action/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceAction.md │ │ │ │ ├── hooks/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── useAppDispatch.md │ │ │ │ ├── reducers/ │ │ │ │ │ ├── routesReducer/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ ├── default.md │ │ │ │ │ │ │ └── generateRoutes.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── ComponentType.md │ │ │ │ │ │ ├── SubTargetType.md │ │ │ │ │ │ └── TargetsType.md │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ └── RootState.md │ │ │ │ │ ├── userRoutesReducer/ │ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ │ └── default.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── ComponentType.md │ │ │ │ │ │ ├── SubTargetType.md │ │ │ │ │ │ └── TargetsType.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── reducers.md │ │ │ │ └── store/ │ │ │ │ ├── type-aliases/ │ │ │ │ │ └── AppDispatch.md │ │ │ │ └── variables/ │ │ │ │ └── store.md │ │ │ ├── test-utils/ │ │ │ │ ├── AsyncComponent/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── ComplexLoader/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── CustomDashboardLoader/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── CustomLoader/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── I18nextProviderMock/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── I18nextProvider.md │ │ │ │ ├── MockBrowserRouter/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── default.md │ │ │ │ ├── TestErrorBoundary/ │ │ │ │ │ └── classes/ │ │ │ │ │ └── TestErrorBoundary.md │ │ │ │ ├── TestWrapper/ │ │ │ │ │ └── functions/ │ │ │ │ │ └── TestWrapper.md │ │ │ │ ├── check-i18n/ │ │ │ │ │ └── check-i18n.test-utils/ │ │ │ │ │ ├── functions/ │ │ │ │ │ │ ├── cleanupTempDirs.md │ │ │ │ │ │ ├── makeTempDir.md │ │ │ │ │ │ ├── runScript.md │ │ │ │ │ │ └── writeTempFile.md │ │ │ │ │ └── variables/ │ │ │ │ │ ├── fixturesDir.md │ │ │ │ │ └── scriptPath.md │ │ │ │ ├── localStorageMock/ │ │ │ │ │ └── functions/ │ │ │ │ │ ├── createLocalStorageMock.md │ │ │ │ │ └── setupLocalStorageMock.md │ │ │ │ └── mocks/ │ │ │ │ └── react-bootstrap/ │ │ │ │ ├── Dropdown/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── Dropdown.md │ │ │ │ ├── components/ │ │ │ │ │ ├── DropdownBase/ │ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ │ └── DivProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── DropdownItem/ │ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ │ └── BtnProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ ├── DropdownMenu/ │ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ │ └── DivProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── default.md │ │ │ │ │ └── DropdownToggle/ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ └── BtnProps.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── default.md │ │ │ │ └── types/ │ │ │ │ ├── interfaces/ │ │ │ │ │ └── InterfaceDropdown.md │ │ │ │ └── type-aliases/ │ │ │ │ ├── BtnProps.md │ │ │ │ └── DivProps.md │ │ │ ├── types/ │ │ │ │ ├── AdminPortal/ │ │ │ │ │ ├── Advertisement/ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ ├── InterfaceAddOnEntryProps.md │ │ │ │ │ │ │ ├── InterfaceAddOnRegisterProps.md │ │ │ │ │ │ │ └── InterfaceFormStateTypes.md │ │ │ │ │ │ └── type/ │ │ │ │ │ │ ├── enumerations/ │ │ │ │ │ │ │ └── AdvertisementType.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── Advertisement.md │ │ │ │ │ │ ├── AdvertisementAttachment.md │ │ │ │ │ │ ├── AdvertisementEdge.md │ │ │ │ │ │ ├── AdvertisementsConnection.md │ │ │ │ │ │ ├── CreateAdvertisementInput.md │ │ │ │ │ │ └── CreateAdvertisementPayload.md │ │ │ │ │ ├── Agenda/ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ ├── InterfaceAgendaDragAndDropProps.md │ │ │ │ │ │ │ ├── InterfaceAgendaFolderCreateFormStateType.md │ │ │ │ │ │ │ ├── InterfaceAgendaFolderCreateModalProps.md │ │ │ │ │ │ │ ├── InterfaceAgendaFolderDeleteModalProps.md │ │ │ │ │ │ │ ├── InterfaceAgendaFolderInfo.md │ │ │ │ │ │ │ ├── InterfaceAgendaFolderList.md │ │ │ │ │ │ │ ├── InterfaceAgendaFolderUpdateFormStateType.md │ │ │ │ │ │ │ ├── InterfaceAgendaFolderUpdateModalProps.md │ │ │ │ │ │ │ ├── InterfaceAgendaItemCategoryInfo.md │ │ │ │ │ │ │ ├── InterfaceAgendaItemCategoryList.md │ │ │ │ │ │ │ ├── InterfaceAgendaItemInfo.md │ │ │ │ │ │ │ ├── InterfaceAgendaItemsCreateModalProps.md │ │ │ │ │ │ │ ├── InterfaceAgendaItemsDeleteModalProps.md │ │ │ │ │ │ │ ├── InterfaceAgendaItemsPreviewModalProps.md │ │ │ │ │ │ │ ├── InterfaceAgendaItemsUpdateModalProps.md │ │ │ │ │ │ │ ├── InterfaceAttachment.md │ │ │ │ │ │ │ ├── InterfaceCreateFormStateType.md │ │ │ │ │ │ │ ├── InterfaceFormStateType.md │ │ │ │ │ │ │ ├── InterfaceItemFormStateType.md │ │ │ │ │ │ │ └── InterfaceUseAgendaMutationsProps.md │ │ │ │ │ │ └── type/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── AgendaCategory.md │ │ │ │ │ ├── ApplyToSelector/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceApplyToSelectorProps.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── ApplyToType.md │ │ │ │ │ ├── AssignmentTypeSelector/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceAssignmentTypeSelectorProps.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── AssignmentType.md │ │ │ │ │ ├── Contribution/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceContriStatsProps.md │ │ │ │ │ │ └── InterfaceOrgContriCardsProps.md │ │ │ │ │ ├── EventRegistrantsModal/ │ │ │ │ │ │ ├── AddOnSpot/ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ ├── InterfaceAddOnSpotAttendeeProps.md │ │ │ │ │ │ │ └── InterfaceFormData.md │ │ │ │ │ │ ├── InviteByEmail/ │ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ └── InterfaceInviteByEmailModalProps.md │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceAutocompleteMockProps.md │ │ │ │ │ │ ├── InterfaceBaseModalProps.md │ │ │ │ │ │ └── InterfaceEventRegistrantsModalProps.md │ │ │ │ │ ├── EventRegistrantsWrapper/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceEventRegistrantsWrapperProps.md │ │ │ │ │ ├── MemberDetail/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── InterfaceAddressFieldConfig.md │ │ │ │ │ │ │ ├── InterfacePhoneFieldConfig.md │ │ │ │ │ │ │ └── InterfaceResolveAvatarFileParams.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── InterfaceMemberDetailProps.md │ │ │ │ │ ├── OrgUpdate/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceMutationUpdateOrganizationInput.md │ │ │ │ │ │ ├── InterfaceOrgUpdateProps.md │ │ │ │ │ │ └── InterfaceOrganization.md │ │ │ │ │ ├── Organization/ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ ├── InterfaceOrgPeopleListCardProps.md │ │ │ │ │ │ │ └── InterfaceOrgPostCardProps.md │ │ │ │ │ │ └── type/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── Organization.md │ │ │ │ │ │ ├── OrganizationCustomField.md │ │ │ │ │ │ └── OrganizationInput.md │ │ │ │ │ ├── OrganizationDashCards/ │ │ │ │ │ │ └── CardItem/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceCardItem.md │ │ │ │ │ ├── OrganizationPeople/ │ │ │ │ │ │ └── addMember/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceAddMemberProps.md │ │ │ │ │ ├── PluginStore/ │ │ │ │ │ │ └── UninstallConfirmationModal/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── IUninstallConfirmationModalProps.md │ │ │ │ │ ├── Tag/ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ ├── InterfaceAddPeopleToTagProps.md │ │ │ │ │ │ │ ├── InterfaceBaseFetchMoreOptions.md │ │ │ │ │ │ │ ├── InterfaceBaseQueryResult.md │ │ │ │ │ │ │ ├── InterfaceMemberData.md │ │ │ │ │ │ │ ├── InterfacePaginationVariables.md │ │ │ │ │ │ │ ├── InterfaceQueryUserTagsMembersToAssignTo.md │ │ │ │ │ │ │ ├── InterfaceTagMembersData.md │ │ │ │ │ │ │ └── InterfaceTagUsersToAssignToQuery.md │ │ │ │ │ │ └── utils/ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── TAGS_QUERY_DATA_CHUNK_SIZE.md │ │ │ │ │ │ └── dataGridStyle.md │ │ │ │ │ ├── TagActions/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceTagActionsProps.md │ │ │ │ │ ├── UpdateSession/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceUpdateSessionProps.md │ │ │ │ │ ├── UserDetails/ │ │ │ │ │ │ ├── UserEvent/ │ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ │ ├── InterfaceGQLEventLite.md │ │ │ │ │ │ │ │ │ ├── InterfaceGQLOrganization.md │ │ │ │ │ │ │ │ │ ├── InterfaceGQLUser.md │ │ │ │ │ │ │ │ │ ├── InterfaceGetUserEventsData.md │ │ │ │ │ │ │ │ │ ├── InterfaceUserEvent.md │ │ │ │ │ │ │ │ │ └── InterfaceUserEventsGQL.md │ │ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ │ │ └── ParticipationFilter.md │ │ │ │ │ │ │ └── type/ │ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ │ └── PeopleTabUserEventsProps.md │ │ │ │ │ │ ├── UserOrganization/ │ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ │ ├── InterfaceJoinedOrgEdge.md │ │ │ │ │ │ │ │ └── InterfaceJoinedOrganizationsData.md │ │ │ │ │ │ │ └── type/ │ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ │ ├── InterfaceOrgRelationType.md │ │ │ │ │ │ │ ├── InterfaceUserOrg.md │ │ │ │ │ │ │ └── InterfaceUserOrganizationsProps.md │ │ │ │ │ │ └── UserTags/ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ │ ├── InterfaceGetUserTagsData.md │ │ │ │ │ │ │ ├── InterfaceUserTag.md │ │ │ │ │ │ │ └── InterfaceUserTagGQL.md │ │ │ │ │ │ └── type/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── InterfaceUserTagsProps.md │ │ │ │ │ ├── UserTableRow/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── InterfaceActionButton.md │ │ │ │ │ │ │ ├── InterfaceUserInfo.md │ │ │ │ │ │ │ └── InterfaceUserTableRowProps.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── InterfaceActionVariant.md │ │ │ │ │ ├── VolunteerDeleteModal/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceVolunteerDeleteModalProps.md │ │ │ │ │ ├── VolunteerViewModal/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceVolunteerViewModalProps.md │ │ │ │ │ ├── actionItem/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── ActionItem.md │ │ │ │ │ │ ├── ActionItemCategory.md │ │ │ │ │ │ ├── CreateActionItemInput.md │ │ │ │ │ │ └── UpdateActionItemInput.md │ │ │ │ │ ├── address/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── Address.md │ │ │ │ │ │ └── AddressInput.md │ │ │ │ │ ├── membership/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── MembershipRequest.md │ │ │ │ │ ├── pagination/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── DefaultConnectionPageInfo.md │ │ │ │ │ └── venue/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── EditVenueInput.md │ │ │ │ │ ├── Venue.md │ │ │ │ │ └── VenueInput.md │ │ │ │ ├── Auth/ │ │ │ │ │ ├── LoginForm/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceLoginFormData.md │ │ │ │ │ │ ├── InterfaceLoginFormProps.md │ │ │ │ │ │ └── InterfaceSignInResult.md │ │ │ │ │ ├── OrgSelector/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceOrgOption.md │ │ │ │ │ │ └── InterfaceOrgSelectorProps.md │ │ │ │ │ ├── PasswordStrengthIndicator/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfacePasswordStrengthIndicatorProps.md │ │ │ │ │ ├── RegistrationForm/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── IRegistrationFormData.md │ │ │ │ │ │ └── IRegistrationFormProps.md │ │ │ │ │ ├── ValidationInterfaces/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfacePasswordRequirements.md │ │ │ │ │ │ └── InterfaceValidationResult.md │ │ │ │ │ ├── auth/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── IOAuthProviderConfig.md │ │ │ │ │ │ │ ├── InterfaceAuthenticationPayload.md │ │ │ │ │ │ │ ├── InterfaceOAuthAccount.md │ │ │ │ │ │ │ ├── InterfaceOAuthLinkResponse.md │ │ │ │ │ │ │ └── InterfaceOAuthLoginInput.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── OAuthProviderKey.md │ │ │ │ │ ├── useFieldValidation/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── IUseFieldValidationReturn.md │ │ │ │ │ │ │ └── IValidationResult.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── ValidationTrigger.md │ │ │ │ │ ├── useLogin/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── ILoginCredentials.md │ │ │ │ │ │ └── IUseLoginOptions.md │ │ │ │ │ └── usePasswordVisibility/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── IUsePasswordVisibilityReturn.md │ │ │ │ ├── Comment/ │ │ │ │ │ └── type/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── Comment.md │ │ │ │ │ └── CommentInput.md │ │ │ │ ├── CursorPagination/ │ │ │ │ │ └── interface/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── InterfaceConnectionData.md │ │ │ │ │ │ ├── InterfaceCursorPaginationManagerProps.md │ │ │ │ │ │ └── InterfaceCursorPaginationManagerRef.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── PaginationVariables.md │ │ │ │ ├── DataGridWrapper/ │ │ │ │ │ └── interface/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ └── InterfaceDataGridWrapperProps.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── TokenAwareGridColDef.md │ │ │ │ ├── DropDown/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceCollapsibleDropdown.md │ │ │ │ │ └── InterfaceDropDownProps.md │ │ │ │ ├── Event/ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ ├── enumerations/ │ │ │ │ │ │ │ └── UserRole.md │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── IAttendanceStatisticsModalProps.md │ │ │ │ │ │ │ ├── ICalendarProps.md │ │ │ │ │ │ │ ├── ICreateEventInput.md │ │ │ │ │ │ │ ├── IDeleteEventModalProps.md │ │ │ │ │ │ │ ├── IEvent.md │ │ │ │ │ │ │ ├── IEventEdge.md │ │ │ │ │ │ │ ├── IEventHeaderProps.md │ │ │ │ │ │ │ ├── IEventListCard.md │ │ │ │ │ │ │ ├── IMember.md │ │ │ │ │ │ │ ├── IOrgList.md │ │ │ │ │ │ │ ├── IPreviewEventModalProps.md │ │ │ │ │ │ │ ├── IStatsModal.md │ │ │ │ │ │ │ └── IUpdateEventModalProps.md │ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ │ ├── InterfaceAttendanceStatisticsModalProps.md │ │ │ │ │ │ │ ├── InterfaceCalendarProps.md │ │ │ │ │ │ │ ├── InterfaceDeleteEventModalProps.md │ │ │ │ │ │ │ ├── InterfaceEvent.md │ │ │ │ │ │ │ ├── InterfaceEventEdge.md │ │ │ │ │ │ │ ├── InterfaceEventHeaderProps.md │ │ │ │ │ │ │ ├── InterfaceIOrgList.md │ │ │ │ │ │ │ ├── InterfaceMember.md │ │ │ │ │ │ │ ├── InterfacePreviewEventModalProps.md │ │ │ │ │ │ │ ├── InterfaceStatsModal.md │ │ │ │ │ │ │ └── InterfaceUpdateEventModalProps.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ └── FilterPeriod.md │ │ │ │ │ ├── type/ │ │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ │ ├── Event.md │ │ │ │ │ │ │ ├── EventAttendeeInput.md │ │ │ │ │ │ │ ├── EventInput.md │ │ │ │ │ │ │ ├── EventOrderByInput.md │ │ │ │ │ │ │ ├── EventVolunteer.md │ │ │ │ │ │ │ ├── EventVolunteerInput.md │ │ │ │ │ │ │ ├── EventVolunteerResponse.md │ │ │ │ │ │ │ ├── EventWhereInput.md │ │ │ │ │ │ │ ├── Feedback.md │ │ │ │ │ │ │ ├── FeedbackInput.md │ │ │ │ │ │ │ ├── UpdateEventVolunteerInput.md │ │ │ │ │ │ │ └── User.md │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ ├── EventOrderByInputEnum.md │ │ │ │ │ │ └── EventVolunteerResponseEnum.md │ │ │ │ │ └── utils/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ └── InterfaceHoliday.md │ │ │ │ │ └── variables/ │ │ │ │ │ ├── holidays.md │ │ │ │ │ └── weekdays.md │ │ │ │ ├── EventForm/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── IEventFormProps.md │ │ │ │ │ ├── IEventFormSubmitPayload.md │ │ │ │ │ └── IEventFormValues.md │ │ │ │ ├── FormFieldGroup/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── IFormTextFieldProps.md │ │ │ │ │ └── InterfaceFormFieldGroupProps.md │ │ │ │ ├── OrganizationCard/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceOrganizationCardProps.md │ │ │ │ ├── PeopleTab/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfacePageHeaderProps.md │ │ │ │ │ ├── InterfacePeopleTab.md │ │ │ │ │ ├── InterfacePeopleTabNavbar.md │ │ │ │ │ ├── InterfacePeopleTabNavbarProps.md │ │ │ │ │ ├── InterfacePeopleTabUserOrganizationProps.md │ │ │ │ │ └── InterfacePeopletabUserEventsProps.md │ │ │ │ ├── Post/ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── ICreatePostModalProps.md │ │ │ │ │ │ ├── InterfaceAttachment.md │ │ │ │ │ │ ├── InterfaceCreator.md │ │ │ │ │ │ ├── InterfaceMutationCreatePostInput.md │ │ │ │ │ │ ├── InterfaceOrganization.md │ │ │ │ │ │ ├── InterfaceOrganizationPostListData.md │ │ │ │ │ │ ├── InterfacePageInfo.md │ │ │ │ │ │ ├── InterfacePinnedPostCardProps.md │ │ │ │ │ │ ├── InterfacePinnedPostsLayoutProps.md │ │ │ │ │ │ ├── InterfacePost.md │ │ │ │ │ │ ├── InterfacePostCard.md │ │ │ │ │ │ ├── InterfacePostConnection.md │ │ │ │ │ │ ├── InterfacePostCreator.md │ │ │ │ │ │ ├── InterfacePostEdge.md │ │ │ │ │ │ └── InterfacePostNode.md │ │ │ │ │ └── type/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── ICreatePostData.md │ │ │ │ │ │ ├── ICreatePostInput.md │ │ │ │ │ │ └── IFileMetadataInput.md │ │ │ │ │ ├── type-aliases/ │ │ │ │ │ │ ├── Post.md │ │ │ │ │ │ ├── PostComments.md │ │ │ │ │ │ ├── PostInput.md │ │ │ │ │ │ ├── PostLikes.md │ │ │ │ │ │ ├── PostNode.md │ │ │ │ │ │ ├── PostOrderByInput.md │ │ │ │ │ │ ├── PostUpdateInput.md │ │ │ │ │ │ └── PostWhereInput.md │ │ │ │ │ └── variables/ │ │ │ │ │ └── PostOrderByInputEnum.md │ │ │ │ ├── Recurrence/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceCustomRecurrenceModalProps.md │ │ │ │ ├── ReportingTable/ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── InfiniteScrollProps.md │ │ │ │ │ │ ├── ReportingRow.md │ │ │ │ │ │ ├── ReportingTableColumn.md │ │ │ │ │ │ ├── ReportingTableGridProps.md │ │ │ │ │ │ └── ReportingTableProps.md │ │ │ │ │ └── utils/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── PAGE_SIZE.md │ │ │ │ │ ├── ROW_HEIGHT.md │ │ │ │ │ └── dataGridStyle.md │ │ │ │ ├── SearchBar/ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceSearchBarProps.md │ │ │ │ │ │ ├── InterfaceSearchBarRef.md │ │ │ │ │ │ └── InterfaceSearchMeta.md │ │ │ │ │ └── type/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── SearchBarSize.md │ │ │ │ │ ├── SearchBarTrigger.md │ │ │ │ │ └── SearchBarVariant.md │ │ │ │ ├── SidebarBase/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── ISidebarBaseProps.md │ │ │ │ ├── SidebarNavItem/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── ISidebarNavItemProps.md │ │ │ │ ├── SidebarPluginSection/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── ISidebarPluginSectionProps.md │ │ │ │ ├── UseUserProfile/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceUseUserProfileReturn.md │ │ │ │ ├── UserPortal/ │ │ │ │ │ ├── Chat/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── InterfaceChatUser.md │ │ │ │ │ │ │ ├── InterfaceContactCardProps.md │ │ │ │ │ │ │ ├── InterfaceGroupChatDetailsProps.md │ │ │ │ │ │ │ ├── InterfaceMockMessage.md │ │ │ │ │ │ │ └── InterfaceOrganizationMember.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── Chat.md │ │ │ │ │ ├── CommentCard/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceCommentCardProps.md │ │ │ │ │ ├── CreateDirectChat/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ └── InterfaceCreateDirectChatProps.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── ChatsListRefetch.md │ │ │ │ │ │ ├── CreateChatMembershipMutation.md │ │ │ │ │ │ └── CreateChatMutation.md │ │ │ │ │ ├── Donation/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceDonation.md │ │ │ │ │ │ └── InterfaceDonationCardProps.md │ │ │ │ │ ├── EmptyChatState/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceEmptyChatStateProps.md │ │ │ │ │ ├── EventCard/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceEventCardProps.md │ │ │ │ │ ├── GroupModal/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceGroupModalProps.md │ │ │ │ │ ├── RecurringEventVolunteerModal/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceRecurringEventVolunteerModalProps.md │ │ │ │ │ ├── UserPortalCard/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceUserPortalCardProps.md │ │ │ │ │ ├── UserPortalNavigationBar/ │ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ │ ├── InterfaceLanguageSelectorProps.md │ │ │ │ │ │ │ │ ├── InterfaceUserDropdownProps.md │ │ │ │ │ │ │ │ └── InterfaceUserPortalNavbarProps.md │ │ │ │ │ │ │ └── variables/ │ │ │ │ │ │ │ ├── DEFAULT_ORGANIZATION_MODE_PROPS.md │ │ │ │ │ │ │ └── DEFAULT_USER_MODE_PROPS.md │ │ │ │ │ │ └── types/ │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── BrandingConfig.md │ │ │ │ │ │ ├── Language.md │ │ │ │ │ │ ├── NavigationLink.md │ │ │ │ │ │ ├── OrganizationData.md │ │ │ │ │ │ ├── OrganizationListQueryResponse.md │ │ │ │ │ │ ├── UserPortalNavbarState.md │ │ │ │ │ │ └── UserProfileMenuItem.md │ │ │ │ │ └── UserProfile/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── InterfaceUserProfileProps.md │ │ │ │ ├── Volunteer/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceCreateVolunteerGroupData.md │ │ │ │ │ ├── InterfaceEventEdge.md │ │ │ │ │ ├── InterfaceEventVolunteerInfo.md │ │ │ │ │ ├── InterfaceMappedEvent.md │ │ │ │ │ ├── InterfaceVolunteerData.md │ │ │ │ │ ├── InterfaceVolunteerGroupData.md │ │ │ │ │ ├── InterfaceVolunteerMembership.md │ │ │ │ │ └── InterfaceVolunteerStatus.md │ │ │ │ ├── docker/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── DockerMode.md │ │ │ │ ├── jsx/ │ │ │ │ │ └── namespaces/ │ │ │ │ │ └── JSX/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── Element.md │ │ │ │ │ ├── ElementAttributesProperty.md │ │ │ │ │ ├── ElementChildrenAttribute.md │ │ │ │ │ ├── ElementClass.md │ │ │ │ │ ├── IntrinsicAttributes.md │ │ │ │ │ ├── IntrinsicClassAttributes.md │ │ │ │ │ ├── IntrinsicElements.md │ │ │ │ │ └── LibraryManagedAttributes.md │ │ │ │ └── shared-components/ │ │ │ │ ├── ActionItems/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── IActionItemCategoryInfo.md │ │ │ │ │ ├── IActionItemCategoryList.md │ │ │ │ │ ├── IActionItemInfo.md │ │ │ │ │ ├── IActionItemList.md │ │ │ │ │ ├── ICreateActionItemInput.md │ │ │ │ │ ├── ICreateActionItemVariables.md │ │ │ │ │ ├── IDeleteActionItemInput.md │ │ │ │ │ ├── IEventVolunteerGroup.md │ │ │ │ │ ├── IFormStateType.md │ │ │ │ │ ├── IItemModalProps.md │ │ │ │ │ ├── IMarkActionItemAsPendingInput.md │ │ │ │ │ ├── IUpdateActionForInstanceInput.md │ │ │ │ │ ├── IUpdateActionItemForInstanceInput.md │ │ │ │ │ ├── IUpdateActionItemForInstanceVariables.md │ │ │ │ │ └── IUpdateActionItemInput.md │ │ │ │ ├── ActionsCell/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceActionsCellProps.md │ │ │ │ ├── Auth/ │ │ │ │ │ ├── EmailField/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceEmailFieldProps.md │ │ │ │ │ ├── FormField/ │ │ │ │ │ │ └── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── InterfaceFormFieldProps.md │ │ │ │ │ └── PasswordField/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfacePasswordFieldProps.md │ │ │ │ ├── Avatar/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceAvatarProps.md │ │ │ │ ├── BaseModal/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── IBaseModalProps.md │ │ │ │ ├── BreadcrumbsComponent/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── IBreadcrumbItem.md │ │ │ │ │ └── IBreadcrumbsComponentProps.md │ │ │ │ ├── BulkActionsBar/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceBulkActionsBarProps.md │ │ │ │ ├── CRUDModalTemplate/ │ │ │ │ │ └── interface/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── InterfaceCRUDModalTemplateProps.md │ │ │ │ │ │ ├── InterfaceCreateModalProps.md │ │ │ │ │ │ ├── InterfaceCrudModalBaseProps.md │ │ │ │ │ │ ├── InterfaceDeleteModalProps.md │ │ │ │ │ │ ├── InterfaceEditModalProps.md │ │ │ │ │ │ ├── InterfaceModalFormState.md │ │ │ │ │ │ ├── InterfaceRecurringEventProps.md │ │ │ │ │ │ ├── InterfaceUseFormModalReturn.md │ │ │ │ │ │ ├── InterfaceUseModalStateReturn.md │ │ │ │ │ │ ├── InterfaceUseMutationModalReturn.md │ │ │ │ │ │ └── InterfaceViewModalProps.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── ModalSize.md │ │ │ │ ├── CheckIn/ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceAttendeeCheckIn.md │ │ │ │ │ │ ├── InterfaceAttendeeQueryResponse.md │ │ │ │ │ │ ├── InterfaceModalProp.md │ │ │ │ │ │ ├── InterfaceTableCheckIn.md │ │ │ │ │ │ ├── InterfaceTableData.md │ │ │ │ │ │ └── InterfaceUser.md │ │ │ │ │ └── type/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── CheckIn.md │ │ │ │ │ ├── CheckInInput.md │ │ │ │ │ └── CheckInStatus.md │ │ │ │ ├── CheckInWrapper/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceCheckInWrapperProps.md │ │ │ │ ├── DataTable/ │ │ │ │ │ ├── column/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ └── IColumnDef.md │ │ │ │ │ ├── hooks/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── IBulkAction.md │ │ │ │ │ │ ├── IRowAction.md │ │ │ │ │ │ ├── IUseDataTableFilteringOptions.md │ │ │ │ │ │ ├── IUseDataTableSelectionOptions.md │ │ │ │ │ │ ├── IUseTableDataOptions.md │ │ │ │ │ │ └── IUseTableDataResult.md │ │ │ │ │ ├── pagination/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── InterfacePageInfo.md │ │ │ │ │ │ │ └── InterfacePaginationControlsProps.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ ├── Connection.md │ │ │ │ │ │ ├── Edge.md │ │ │ │ │ │ └── PageInfo.md │ │ │ │ │ ├── props/ │ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ │ ├── InterfaceBaseDataTableProps.md │ │ │ │ │ │ │ ├── InterfaceDataTableSkeletonProps.md │ │ │ │ │ │ │ ├── InterfaceDataTableTableProps.md │ │ │ │ │ │ │ ├── InterfaceLoadingMoreRowsProps.md │ │ │ │ │ │ │ ├── InterfaceSearchBarProps.md │ │ │ │ │ │ │ └── InterfaceTableLoaderProps.md │ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ │ └── InterfaceDataTableProps.md │ │ │ │ │ └── types/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── IFilterState.md │ │ │ │ │ │ ├── ISortChangeEvent.md │ │ │ │ │ │ ├── ISortState.md │ │ │ │ │ │ └── ITableState.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── Accessor.md │ │ │ │ │ ├── HeaderRender.md │ │ │ │ │ ├── Key.md │ │ │ │ │ └── SortDirection.md │ │ │ │ ├── DatePicker/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceDatePickerProps.md │ │ │ │ ├── DateRangePicker/ │ │ │ │ │ └── interface/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── IDateRangePreset.md │ │ │ │ │ │ ├── IDateRangeValue.md │ │ │ │ │ │ └── InterfaceDateRangePickerProps.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── DateOrNull.md │ │ │ │ ├── DropDownButton/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceDropDownButtonProps.md │ │ │ │ │ ├── InterfaceDropDownOption.md │ │ │ │ │ ├── InterfaceDropDownProps.md │ │ │ │ │ └── InterfaceSearchToggleProps.md │ │ │ │ ├── EmptyState/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceEmptyStateProps.md │ │ │ │ ├── ErrorBoundaryWrapper/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceErrorBoundaryWrapperProps.md │ │ │ │ │ ├── InterfaceErrorBoundaryWrapperState.md │ │ │ │ │ └── InterfaceErrorFallbackProps.md │ │ │ │ ├── EventListCard/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceEventListCard.md │ │ │ │ │ ├── InterfaceEventListCardModalsProps.md │ │ │ │ │ ├── InterfaceEventUpdateInput.md │ │ │ │ │ ├── InterfaceFormState.md │ │ │ │ │ └── InterfaceUpdateEventHandlerProps.md │ │ │ │ ├── FormFieldGroup/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceFormCheckFieldProps.md │ │ │ │ │ └── InterfaceFormSelectFieldProps.md │ │ │ │ ├── LoadingState/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── InterfaceLoadingStateProps.md │ │ │ │ ├── Navbar/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfacePageHeaderProps.md │ │ │ │ ├── NotificationToast/ │ │ │ │ │ └── interface/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── InterfaceNotificationToastHelpers.md │ │ │ │ │ │ ├── InterfaceNotificationToastI18nMessage.md │ │ │ │ │ │ └── InterfacePromiseMessages.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── NotificationToastContainerProps.md │ │ │ │ │ ├── NotificationToastMessage.md │ │ │ │ │ ├── NotificationToastNamespace.md │ │ │ │ │ └── PromiseFunction.md │ │ │ │ ├── PaginationList/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfacePaginationListProps.md │ │ │ │ ├── PeopleTabNavbar/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfacePeopleTabNavbarProps.md │ │ │ │ ├── PluginRouteRenderer/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfacePluginRouteRendererProps.md │ │ │ │ ├── PluginRoutes/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfacePluginRoutesProps.md │ │ │ │ ├── PostViewModal/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfacePostViewModalProps.md │ │ │ │ ├── ProfileAvatarDisplay/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceProfileAvatarDisplayProps.md │ │ │ │ ├── ProfileCard/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceProfileCardProps.md │ │ │ │ ├── ProfileDropdown/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceProfileDropdownProps.md │ │ │ │ ├── Recurrence/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceRecurrenceEndOptionsSectionProps.md │ │ │ │ │ ├── InterfaceRecurrenceFrequencySectionProps.md │ │ │ │ │ └── InterfaceRecurrenceMonthlySectionProps.md │ │ │ │ ├── RecurrenceDropdown/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceRecurrenceDropdownProps.md │ │ │ │ ├── SearchFilterBar/ │ │ │ │ │ └── interface/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ ├── InterfaceDropdownConfig.md │ │ │ │ │ │ ├── InterfaceSearchFilterBarAdvanced.md │ │ │ │ │ │ ├── InterfaceSearchFilterBarSimple.md │ │ │ │ │ │ ├── InterfaceSearchFilterBarTranslations.md │ │ │ │ │ │ └── InterfaceSortingOption.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── InterfaceSearchFilterBarProps.md │ │ │ │ ├── SidebarOrgSection/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── IOrganizationData.md │ │ │ │ │ └── ISidebarOrgSectionProps.md │ │ │ │ ├── SortingButton/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ ├── InterfaceSortingButtonProps.md │ │ │ │ │ └── InterfaceSortingOption.md │ │ │ │ ├── StatusBadge/ │ │ │ │ │ └── interface/ │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ └── InterfaceStatusBadgeProps.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── SemanticVariant.md │ │ │ │ │ ├── StatusSize.md │ │ │ │ │ └── StatusVariant.md │ │ │ │ ├── TableLoader/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceTableLoaderProps.md │ │ │ │ ├── TimePicker/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceTimePickerProps.md │ │ │ │ ├── TruncatedText/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceTruncatedTextProps.md │ │ │ │ ├── User/ │ │ │ │ │ ├── interface/ │ │ │ │ │ │ └── interfaces/ │ │ │ │ │ │ ├── InterfaceUser.md │ │ │ │ │ │ └── InterfaceUserAttendee.md │ │ │ │ │ └── type/ │ │ │ │ │ └── type-aliases/ │ │ │ │ │ ├── Address.md │ │ │ │ │ ├── AppUserProfile.md │ │ │ │ │ ├── CreateUserFamilyInput.md │ │ │ │ │ ├── User.md │ │ │ │ │ ├── UserInput.md │ │ │ │ │ └── UserPhone.md │ │ │ │ ├── VisibilitySelector/ │ │ │ │ │ └── interface/ │ │ │ │ │ └── interfaces/ │ │ │ │ │ └── InterfaceVisibilitySelectorProps.md │ │ │ │ └── VolunteerGroupViewModal/ │ │ │ │ └── interface/ │ │ │ │ └── interfaces/ │ │ │ │ └── InterfaceVolunteerGroupViewModalProps.md │ │ │ └── utils/ │ │ │ ├── MinioDownload/ │ │ │ │ └── functions/ │ │ │ │ └── useMinioDownload.md │ │ │ ├── MinioUpload/ │ │ │ │ └── functions/ │ │ │ │ └── useMinioUpload.md │ │ │ ├── SanitizeInput/ │ │ │ │ └── functions/ │ │ │ │ └── sanitizeInput.md │ │ │ ├── StaticMockLink/ │ │ │ │ ├── classes/ │ │ │ │ │ └── StaticMockLink.md │ │ │ │ ├── functions/ │ │ │ │ │ └── mockSingleLink.md │ │ │ │ └── interfaces/ │ │ │ │ └── InterfaceMockApolloLink.md │ │ │ ├── adminPluginInstaller/ │ │ │ │ ├── functions/ │ │ │ │ │ ├── getInstalledAdminPlugins.md │ │ │ │ │ ├── installAdminPluginFromZip.md │ │ │ │ │ ├── removeAdminPlugin.md │ │ │ │ │ ├── validateAdminPluginStructure.md │ │ │ │ │ └── validateAdminPluginZip.md │ │ │ │ └── interfaces/ │ │ │ │ ├── IAdminPluginInstallationOptions.md │ │ │ │ ├── IAdminPluginInstallationResult.md │ │ │ │ ├── IAdminPluginManifest.md │ │ │ │ └── IAdminPluginZipStructure.md │ │ │ ├── autocompleteHelpers/ │ │ │ │ └── functions/ │ │ │ │ ├── areOptionsEqual.md │ │ │ │ └── getMemberLabel.md │ │ │ ├── chartToPdf/ │ │ │ │ └── functions/ │ │ │ │ ├── exportDemographicsToCSV.md │ │ │ │ ├── exportToCSV.md │ │ │ │ └── exportTrendsToCSV.md │ │ │ ├── currency/ │ │ │ │ └── variables/ │ │ │ │ ├── currencyOptions.md │ │ │ │ └── currencySymbols.md │ │ │ ├── dateFormatter/ │ │ │ │ └── functions/ │ │ │ │ └── formatDate.md │ │ │ ├── errorHandler/ │ │ │ │ └── functions/ │ │ │ │ └── errorHandler.md │ │ │ ├── fieldTypes/ │ │ │ │ └── variables/ │ │ │ │ └── default.md │ │ │ ├── fileValidation/ │ │ │ │ └── functions/ │ │ │ │ └── validateFile.md │ │ │ ├── filehash/ │ │ │ │ └── functions/ │ │ │ │ └── calculateFileHash.md │ │ │ ├── formEnumFields/ │ │ │ │ └── variables/ │ │ │ │ ├── countryOptions.md │ │ │ │ ├── educationGradeEnum.md │ │ │ │ ├── employmentStatusEnum.md │ │ │ │ ├── genderEnum.md │ │ │ │ └── maritalStatusEnum.md │ │ │ ├── getRefreshToken/ │ │ │ │ └── functions/ │ │ │ │ ├── handleTokenRefresh.md │ │ │ │ └── refreshToken.md │ │ │ ├── interfaces/ │ │ │ │ ├── enumerations/ │ │ │ │ │ ├── AdvertisementTypePg.md │ │ │ │ │ ├── Iso3166Alpha2CountryCode.md │ │ │ │ │ ├── UserEducationGrade.md │ │ │ │ │ ├── UserEmploymentStatus.md │ │ │ │ │ ├── UserMaritalStatus.md │ │ │ │ │ ├── UserNatalSex.md │ │ │ │ │ └── UserRole.md │ │ │ │ ├── interfaces/ │ │ │ │ │ ├── IEvent.md │ │ │ │ │ ├── InterfaceAddress.md │ │ │ │ │ ├── InterfaceAdvertisementAttachmentPg.md │ │ │ │ │ ├── InterfaceAdvertisementPg.md │ │ │ │ │ ├── InterfaceBaseEvent.md │ │ │ │ │ ├── InterfaceCampaignInfo.md │ │ │ │ │ ├── InterfaceCampaignInfoPG.md │ │ │ │ │ ├── InterfaceChatMessagePg.md │ │ │ │ │ ├── InterfaceChatPg.md │ │ │ │ │ ├── InterfaceComment.md │ │ │ │ │ ├── InterfaceCommentEdge.md │ │ │ │ │ ├── InterfaceCreateFund.md │ │ │ │ │ ├── InterfaceCreatePledge.md │ │ │ │ │ ├── InterfaceCreateVolunteerGroup.md │ │ │ │ │ ├── InterfaceCurrentUserTypePG.md │ │ │ │ │ ├── InterfaceCustomFieldData.md │ │ │ │ │ ├── InterfaceEventAttachmentPg.md │ │ │ │ │ ├── InterfaceEventVolunteerInfo.md │ │ │ │ │ ├── InterfaceFundInfo.md │ │ │ │ │ ├── InterfaceFundPg.md │ │ │ │ │ ├── InterfaceMapType.md │ │ │ │ │ ├── InterfaceMemberInfo.md │ │ │ │ │ ├── InterfaceMembersList.md │ │ │ │ │ ├── InterfaceOrgConnectionInfoType.md │ │ │ │ │ ├── InterfaceOrgConnectionInfoTypePG.md │ │ │ │ │ ├── InterfaceOrgInfoTypePG.md │ │ │ │ │ ├── InterfaceOrganizationAdvertisementsConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationAdvertisementsConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationBlockedUsersConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationBlockedUsersConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationEventsConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationEventsConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationFundsConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationFundsConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationMembersConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationMembersConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationPg.md │ │ │ │ │ ├── InterfaceOrganizationPinnedPostsConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationPinnedPostsConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationPostsConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationPostsConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationTagFoldersConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationTagFoldersConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationTagsConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationTagsConnectionPg.md │ │ │ │ │ ├── InterfaceOrganizationVenuesConnectionEdgePg.md │ │ │ │ │ ├── InterfaceOrganizationVenuesConnectionPg.md │ │ │ │ │ ├── InterfacePageInfoPg.md │ │ │ │ │ ├── InterfacePaginationArgs.md │ │ │ │ │ ├── InterfacePledgeInfo.md │ │ │ │ │ ├── InterfacePledgeInfoPG.md │ │ │ │ │ ├── InterfacePostCard.md │ │ │ │ │ ├── InterfacePostForm.md │ │ │ │ │ ├── InterfacePostPg.md │ │ │ │ │ ├── InterfaceQueryBlockPageMemberListItem.md │ │ │ │ │ ├── InterfaceQueryFundCampaignsPledges.md │ │ │ │ │ ├── InterfaceQueryMembershipRequestsListItem.md │ │ │ │ │ ├── InterfaceQueryOrganizationAdvertisementListItem.md │ │ │ │ │ ├── InterfaceQueryOrganizationEventListItem.md │ │ │ │ │ ├── InterfaceQueryOrganizationFundCampaigns.md │ │ │ │ │ ├── InterfaceQueryOrganizationListObject.md │ │ │ │ │ ├── InterfaceQueryOrganizationPostListItem.md │ │ │ │ │ ├── InterfaceQueryOrganizationUserTags.md │ │ │ │ │ ├── InterfaceQueryOrganizationUserTagsPG.md │ │ │ │ │ ├── InterfaceQueryOrganizationsListObject.md │ │ │ │ │ ├── InterfaceQueryUserListItem.md │ │ │ │ │ ├── InterfaceQueryUserListItemForAdmin.md │ │ │ │ │ ├── InterfaceQueryUserTagChildTags.md │ │ │ │ │ ├── InterfaceQueryUserTagsAssignedMembers.md │ │ │ │ │ ├── InterfaceQueryUserTagsMembersToAssignTo.md │ │ │ │ │ ├── InterfaceQueryVenueListItem.md │ │ │ │ │ ├── InterfaceTagData.md │ │ │ │ │ ├── InterfaceTagDataPG.md │ │ │ │ │ ├── InterfaceTagFolderPg.md │ │ │ │ │ ├── InterfaceTagPg.md │ │ │ │ │ ├── InterfaceUserCampaign.md │ │ │ │ │ ├── InterfaceUserEvents.md │ │ │ │ │ ├── InterfaceUserInfo.md │ │ │ │ │ ├── InterfaceUserInfoPG.md │ │ │ │ │ ├── InterfaceUserListQueryResponse.md │ │ │ │ │ ├── InterfaceUserPg.md │ │ │ │ │ ├── InterfaceUserType.md │ │ │ │ │ ├── InterfaceUserTypePG.md │ │ │ │ │ ├── InterfaceVenuePg.md │ │ │ │ │ ├── InterfaceVolunteerGroupInfo.md │ │ │ │ │ ├── InterfaceVolunteerMembership.md │ │ │ │ │ └── InterfaceVolunteerRank.md │ │ │ │ └── type-aliases/ │ │ │ │ ├── VoteState.md │ │ │ │ └── VoteType.md │ │ │ ├── languages/ │ │ │ │ └── variables/ │ │ │ │ ├── languageArray.md │ │ │ │ └── languages.md │ │ │ ├── linkValidator/ │ │ │ │ └── functions/ │ │ │ │ └── isValidLink.md │ │ │ ├── oauth/ │ │ │ │ └── oauthFlowHandler/ │ │ │ │ └── functions/ │ │ │ │ ├── handleOAuthLink.md │ │ │ │ └── handleOAuthLogin.md │ │ │ ├── organizationTagsUtils/ │ │ │ │ ├── interfaces/ │ │ │ │ │ ├── InterfaceOrganizationSubTagsQuery.md │ │ │ │ │ ├── InterfaceOrganizationTagsQuery.md │ │ │ │ │ ├── InterfaceOrganizationTagsQueryPG.md │ │ │ │ │ ├── InterfaceTagAssignedMembersQuery.md │ │ │ │ │ └── InterfaceTagUsersToAssignToQuery.md │ │ │ │ ├── type-aliases/ │ │ │ │ │ ├── SortedByType.md │ │ │ │ │ └── TagActionType.md │ │ │ │ └── variables/ │ │ │ │ ├── TAGS_QUERY_DATA_CHUNK_SIZE.md │ │ │ │ └── dataGridStyle.md │ │ │ ├── passwordValidator/ │ │ │ │ └── functions/ │ │ │ │ └── validatePassword.md │ │ │ ├── profileNavigation/ │ │ │ │ ├── functions/ │ │ │ │ │ └── resolveProfileNavigation.md │ │ │ │ ├── interfaces/ │ │ │ │ │ └── InterfaceProfileNavigationOptions.md │ │ │ │ └── type-aliases/ │ │ │ │ └── ProfilePortal.md │ │ │ ├── recaptcha/ │ │ │ │ └── functions/ │ │ │ │ ├── getRecaptchaToken.md │ │ │ │ └── loadRecaptchaScript.md │ │ │ ├── recurrenceUtils/ │ │ │ │ ├── recurrenceConstants/ │ │ │ │ │ └── variables/ │ │ │ │ │ ├── Days.md │ │ │ │ │ ├── dayNames.md │ │ │ │ │ ├── daysOptions.md │ │ │ │ │ ├── endsAfter.md │ │ │ │ │ ├── endsNever.md │ │ │ │ │ ├── endsOn.md │ │ │ │ │ ├── frequencies.md │ │ │ │ │ ├── monthNames.md │ │ │ │ │ └── recurrenceEndOptions.md │ │ │ │ ├── recurrenceTypes/ │ │ │ │ │ ├── enumerations/ │ │ │ │ │ │ ├── Frequency.md │ │ │ │ │ │ ├── RecurrenceEndOption.md │ │ │ │ │ │ └── WeekDays.md │ │ │ │ │ ├── interfaces/ │ │ │ │ │ │ └── InterfaceRecurrenceRule.md │ │ │ │ │ └── type-aliases/ │ │ │ │ │ └── RecurrenceEndOptionType.md │ │ │ │ └── recurrenceUtilityFunctions/ │ │ │ │ └── functions/ │ │ │ │ ├── areRecurrenceRulesEqual.md │ │ │ │ ├── createDefaultRecurrenceRule.md │ │ │ │ ├── formatRecurrenceForApi.md │ │ │ │ ├── getDayName.md │ │ │ │ ├── getEndTypeFromRecurrence.md │ │ │ │ ├── getMonthlyOptions.md │ │ │ │ ├── getOrdinalString.md │ │ │ │ ├── getOrdinalSuffix.md │ │ │ │ ├── getRecurrenceRuleText.md │ │ │ │ ├── getWeekOfMonth.md │ │ │ │ └── validateRecurrenceInput.md │ │ │ ├── sanitizeAvatar/ │ │ │ │ └── functions/ │ │ │ │ ├── sanitizeAvatarURL.md │ │ │ │ └── sanitizeAvatars.md │ │ │ ├── testConstants/ │ │ │ │ └── variables/ │ │ │ │ └── SIDEBAR_TEST_BG_COLOR.md │ │ │ ├── timezoneUtils/ │ │ │ │ ├── dateTimeConfig/ │ │ │ │ │ └── variables/ │ │ │ │ │ └── dateTimeFields.md │ │ │ │ └── dateTimeMiddleware/ │ │ │ │ └── variables/ │ │ │ │ ├── requestMiddleware.md │ │ │ │ └── responseMiddleware.md │ │ │ ├── tokenValues/ │ │ │ │ ├── functions/ │ │ │ │ │ ├── getSpacingValue.md │ │ │ │ │ └── isSpacingToken.md │ │ │ │ ├── type-aliases/ │ │ │ │ │ └── SpacingToken.md │ │ │ │ └── variables/ │ │ │ │ └── spacingTokens.md │ │ │ ├── urlToFile/ │ │ │ │ └── functions/ │ │ │ │ └── urlToFile.md │ │ │ ├── useLocalstorage/ │ │ │ │ ├── functions/ │ │ │ │ │ ├── clearAllItems.md │ │ │ │ │ ├── getItem.md │ │ │ │ │ ├── getStorageKey.md │ │ │ │ │ ├── removeItem.md │ │ │ │ │ ├── setItem.md │ │ │ │ │ └── useLocalStorage.md │ │ │ │ └── variables/ │ │ │ │ └── PREFIX.md │ │ │ ├── useSession/ │ │ │ │ └── functions/ │ │ │ │ └── default.md │ │ │ ├── userUpdateUtils/ │ │ │ │ └── functions/ │ │ │ │ ├── removeEmptyFields.md │ │ │ │ └── validateImageFile.md │ │ │ ├── validators/ │ │ │ │ └── authValidators/ │ │ │ │ ├── functions/ │ │ │ │ │ ├── getPasswordRequirements.md │ │ │ │ │ ├── validateEmail.md │ │ │ │ │ ├── validateName.md │ │ │ │ │ ├── validatePassword.md │ │ │ │ │ └── validatePasswordConfirmation.md │ │ │ │ └── variables/ │ │ │ │ └── PASSWORD_REGEX.md │ │ │ └── volunteerStatusMapper/ │ │ │ └── functions/ │ │ │ └── mapVolunteerStatusToVariant.md │ │ └── docs/ │ │ ├── developer-resources/ │ │ │ ├── actionitems-components.md │ │ │ ├── contributing.md │ │ │ ├── crud-modal-template.md │ │ │ ├── data-grid-wrapper.md │ │ │ ├── design-token-system.md │ │ │ ├── dropdown-button-api.md │ │ │ ├── e2e-testing.md │ │ │ ├── empty-state-migration.md │ │ │ ├── installation.md │ │ │ ├── introduction.md │ │ │ ├── linting.md │ │ │ ├── minio.md │ │ │ ├── operation.md │ │ │ ├── plugin-graphql.md │ │ │ ├── plugin.md │ │ │ ├── reusable-components.md │ │ │ ├── security.md │ │ │ ├── tables.md │ │ │ ├── testing.md │ │ │ └── troubleshooting.md │ │ ├── getting-started/ │ │ │ ├── configuration.md │ │ │ ├── installation.md │ │ │ ├── login.md │ │ │ ├── operation.md │ │ │ └── webserver.md │ │ ├── introduction.md │ │ └── plugins/ │ │ ├── implementing-plugins-example.md │ │ ├── implementing-plugins.md │ │ └── plugin-architecture.md │ ├── docusaurus.config.ts │ ├── package.json │ ├── sidebars.ts │ ├── src/ │ │ ├── components/ │ │ │ └── layout/ │ │ │ └── HeaderHero.tsx │ │ ├── css/ │ │ │ └── custom.css │ │ ├── pages/ │ │ │ └── index.tsx │ │ └── utils/ │ │ ├── ActionButton.tsx │ │ └── HomeCallToAction.tsx │ └── static/ │ ├── .nojekyll │ └── CNAME ├── eslint.config.js ├── index.html ├── knip.deps.json ├── knip.json ├── package.json ├── public/ │ ├── locales/ │ │ ├── en/ │ │ │ ├── common.json │ │ │ ├── errors.json │ │ │ └── translation.json │ │ ├── es/ │ │ │ ├── common.json │ │ │ ├── errors.json │ │ │ └── translation.json │ │ ├── fr/ │ │ │ ├── common.json │ │ │ ├── errors.json │ │ │ └── translation.json │ │ ├── hi/ │ │ │ ├── common.json │ │ │ ├── errors.json │ │ │ └── translation.json │ │ └── zh/ │ │ ├── common.json │ │ ├── errors.json │ │ └── translation.json │ ├── manifest.json │ └── robots.txt ├── pyproject.toml ├── schema.graphql ├── scripts/ │ ├── __fixtures__/ │ │ ├── correct.tsx │ │ ├── edge-cases.tsx │ │ ├── false-positives.tsx │ │ └── violations.tsx │ ├── __mocks__/ │ │ ├── @dicebear/ │ │ │ ├── collection.ts │ │ │ └── core.ts │ │ ├── @pdfme/ │ │ │ ├── generator.spec.ts │ │ │ └── generator.ts │ │ └── fileMock.js │ ├── check-css-imports.js │ ├── check-i18n.js │ ├── cypress/ │ │ └── run-with-coverage-report.cjs │ ├── delete-readmes.js │ ├── docker/ │ │ ├── resolve-docker-host.sh │ │ └── test/ │ │ └── resolve-docker-host.spec.sh │ ├── docs/ │ │ ├── fix-readme-links.js │ │ └── fix-repo-url.js │ ├── eslint/ │ │ ├── README.md │ │ ├── config/ │ │ │ ├── base.js │ │ │ ├── cypress.js │ │ │ ├── exemptions.js │ │ │ ├── prefer-crud-modal-template.js │ │ │ ├── special.js │ │ │ └── tests.js │ │ ├── index.js │ │ ├── index.spec.js │ │ ├── plugins/ │ │ │ └── eslint-plugin-vitest-isolation/ │ │ │ ├── index.d.ts │ │ │ ├── index.js │ │ │ ├── package.json │ │ │ ├── require-aftereach-cleanup.js │ │ │ └── require-aftereach-cleanup.spec.ts │ │ ├── rules/ │ │ │ ├── imports.js │ │ │ ├── modal-state.js │ │ │ ├── native-button.js │ │ │ ├── prefer-crud-modal-template.js │ │ │ ├── prefer-crud-modal-template.spec.js │ │ │ ├── rules.js │ │ │ ├── rules.spec.js │ │ │ ├── search-input.js │ │ │ └── security.js │ │ └── tsconfig.json │ ├── githooks/ │ │ ├── check-localstorage-usage.ts │ │ ├── check-mock-cleanup.sh │ │ ├── check-route-prefix.ts │ │ ├── check_pom.js │ │ └── update-toc.js │ ├── install/ │ │ ├── install.sh │ │ ├── install.spec.sh │ │ └── lib/ │ │ ├── common.sh │ │ ├── docker-detect.sh │ │ ├── docker-detect.spec.sh │ │ ├── node-install.sh │ │ ├── node-install.spec.sh │ │ ├── os-detect.sh │ │ └── os-detect.spec.sh │ ├── install.ps1 │ ├── install.sh │ ├── run-shard.js │ ├── start-server.js │ └── validate-tokens.ts ├── src/ │ ├── App.spec.tsx │ ├── App.tsx │ ├── Constant/ │ │ ├── common.spec.ts │ │ ├── common.ts │ │ ├── constant.spec.ts │ │ ├── constant.ts │ │ └── fileUpload.ts │ ├── GraphQl/ │ │ ├── Mutations/ │ │ │ ├── ActionItemCategoryMutations.ts │ │ │ ├── ActionItemMutations.ts │ │ │ ├── AdvertisementMutations.ts │ │ │ ├── AgendaFolderMutations.ts │ │ │ ├── AgendaItemMutations.ts │ │ │ ├── CampaignMutation.ts │ │ │ ├── CommentMutations.ts │ │ │ ├── EventAttendeeMutations.ts │ │ │ ├── EventMutations.ts │ │ │ ├── EventVolunteerMutation.ts │ │ │ ├── FundMutation.ts │ │ │ ├── OrganizationMutations.ts │ │ │ ├── PledgeMutation.ts │ │ │ ├── PluginMutations.ts │ │ │ ├── TagMutations.ts │ │ │ ├── VenueMutations.ts │ │ │ └── mutations.ts │ │ └── Queries/ │ │ ├── ActionItemCategoryQueries.ts │ │ ├── ActionItemQueries.ts │ │ ├── AdvertisementQueries.ts │ │ ├── AgendaCategoryQueries.ts │ │ ├── AgendaFolderQueries.ts │ │ ├── CommentQueries.ts │ │ ├── EventVolunteerQueries.ts │ │ ├── NotificationQueries.ts │ │ ├── OrganizationQueries.ts │ │ ├── PlugInQueries.ts │ │ ├── Queries.ts │ │ ├── VenueQueries.spec.ts │ │ ├── fundQueries.ts │ │ └── userTagQueries.ts │ ├── assets/ │ │ ├── css/ │ │ │ ├── app.css │ │ │ └── scrollStyles.css │ │ ├── scss/ │ │ │ ├── _colors.scss │ │ │ ├── _general.scss │ │ │ ├── _talawa.scss │ │ │ ├── _utilities.scss │ │ │ ├── _variables.scss │ │ │ ├── app.scss │ │ │ ├── components/ │ │ │ │ ├── _accordion.scss │ │ │ │ ├── _alert.scss │ │ │ │ ├── _badge.scss │ │ │ │ ├── _breadcrumb.scss │ │ │ │ ├── _buttons.scss │ │ │ │ ├── _card.scss │ │ │ │ ├── _carousel.scss │ │ │ │ ├── _close.scss │ │ │ │ ├── _dropdown.scss │ │ │ │ ├── _list-group.scss │ │ │ │ ├── _modal.scss │ │ │ │ ├── _nav.scss │ │ │ │ ├── _navbar.scss │ │ │ │ ├── _offcanvas.scss │ │ │ │ ├── _pagination.scss │ │ │ │ ├── _placeholder.scss │ │ │ │ ├── _progress.scss │ │ │ │ └── _spinners.scss │ │ │ ├── content/ │ │ │ │ ├── _table.scss │ │ │ │ └── _typography.scss │ │ │ └── forms/ │ │ │ ├── _check-radios.scss │ │ │ ├── _floating-label.scss │ │ │ ├── _form-control.scss │ │ │ ├── _input-group.scss │ │ │ ├── _range.scss │ │ │ ├── _select.scss │ │ │ └── _validation.scss │ │ └── svgs/ │ │ └── social-icons/ │ │ └── index.tsx │ ├── components/ │ │ ├── AdminPortal/ │ │ │ ├── AddPeopleToTag/ │ │ │ │ ├── AddPeopleToTag.module.css │ │ │ │ ├── AddPeopleToTag.spec.tsx │ │ │ │ ├── AddPeopleToTag.tsx │ │ │ │ └── AddPeopleToTagsMocks.ts │ │ │ ├── Advertisements/ │ │ │ │ ├── Advertisements.spec.tsx │ │ │ │ ├── Advertisements.tsx │ │ │ │ ├── AdvertisementsMocks.ts │ │ │ │ ├── core/ │ │ │ │ │ ├── AdvertisementEntry/ │ │ │ │ │ │ ├── AdvertisementEntry.module.css │ │ │ │ │ │ ├── AdvertisementEntry.spec.tsx │ │ │ │ │ │ └── AdvertisementEntry.tsx │ │ │ │ │ └── AdvertisementRegister/ │ │ │ │ │ ├── AdvertisementRegister.module.css │ │ │ │ │ ├── AdvertisementRegister.spec.tsx │ │ │ │ │ ├── AdvertisementRegister.tsx │ │ │ │ │ └── AdvertisementRegisterMocks.ts │ │ │ │ └── skeleton/ │ │ │ │ ├── AdvertisementSkeleton.spec.tsx │ │ │ │ └── AdvertisementSkeleton.tsx │ │ │ ├── AgendaFolder/ │ │ │ │ ├── AgendaFolderContainer.spec.tsx │ │ │ │ ├── AgendaFolderContainer.tsx │ │ │ │ ├── Create/ │ │ │ │ │ ├── AgendaFolderCreateModal.module.css │ │ │ │ │ ├── AgendaFolderCreateModal.spec.tsx │ │ │ │ │ └── AgendaFolderCreateModal.tsx │ │ │ │ ├── Delete/ │ │ │ │ │ ├── AgendaFolderDeleteModal.module.css │ │ │ │ │ ├── AgendaFolderDeleteModal.spec.tsx │ │ │ │ │ └── AgendaFolderDeleteModal.tsx │ │ │ │ ├── DragAndDrop/ │ │ │ │ │ ├── AgendaDragAndDrop.module.css │ │ │ │ │ ├── AgendaDragAndDrop.spec.tsx │ │ │ │ │ └── AgendaDragAndDrop.tsx │ │ │ │ └── Update/ │ │ │ │ ├── AgendaFolderUpdateModal.module.css │ │ │ │ ├── AgendaFolderUpdateModal.spec.tsx │ │ │ │ └── AgendaFolderUpdateModal.tsx │ │ │ ├── AgendaItems/ │ │ │ │ ├── Create/ │ │ │ │ │ ├── AgendaItemsCreateModal.module.css │ │ │ │ │ ├── AgendaItemsCreateModal.spec.tsx │ │ │ │ │ └── AgendaItemsCreateModal.tsx │ │ │ │ ├── Delete/ │ │ │ │ │ ├── AgendaItemsDeleteModal.module.css │ │ │ │ │ ├── AgendaItemsDeleteModal.spec.tsx │ │ │ │ │ └── AgendaItemsDeleteModal.tsx │ │ │ │ ├── Preview/ │ │ │ │ │ ├── AgendaItemsPreviewModal.module.css │ │ │ │ │ ├── AgendaItemsPreviewModal.spec.tsx │ │ │ │ │ └── AgendaItemsPreviewModal.tsx │ │ │ │ └── Update/ │ │ │ │ ├── AgendaItemsUpdateModal.module.css │ │ │ │ ├── AgendaItemsUpdateModal.spec.tsx │ │ │ │ └── AgendaItemsUpdateModal.tsx │ │ │ ├── ApplyToSelector/ │ │ │ │ ├── ApplyToSelector.spec.tsx │ │ │ │ └── ApplyToSelector.tsx │ │ │ ├── AssignmentTypeSelector/ │ │ │ │ ├── AssignmentTypeSelector.spec.tsx │ │ │ │ └── AssignmentTypeSelector.tsx │ │ │ ├── ContriStats/ │ │ │ │ ├── ContriStats.spec.tsx │ │ │ │ └── ContriStats.tsx │ │ │ ├── EventManagement/ │ │ │ │ ├── Dashboard/ │ │ │ │ │ ├── EventDashboard.mocks.ts │ │ │ │ │ ├── EventDashboard.module.css │ │ │ │ │ ├── EventDashboard.spec.tsx │ │ │ │ │ └── EventDashboard.tsx │ │ │ │ ├── EventActionItems/ │ │ │ │ │ ├── EventActionItems.module.css │ │ │ │ │ ├── EventActionItems.spec.tsx │ │ │ │ │ └── EventActionItems.tsx │ │ │ │ ├── EventAgenda/ │ │ │ │ │ ├── EventAgenda.module.css │ │ │ │ │ ├── EventAgenda.spec.tsx │ │ │ │ │ └── EventAgenda.tsx │ │ │ │ ├── EventAttendance/ │ │ │ │ │ ├── Attendance/ │ │ │ │ │ │ ├── EventAttendance.module.css │ │ │ │ │ │ ├── EventAttendance.spec.tsx │ │ │ │ │ │ └── EventAttendance.tsx │ │ │ │ │ ├── AttendanceList/ │ │ │ │ │ │ ├── AttendedEventList.spec.tsx │ │ │ │ │ │ └── AttendedEventList.tsx │ │ │ │ │ ├── EventAttendanceMocks.ts │ │ │ │ │ └── Statistics/ │ │ │ │ │ ├── EventStatistics.module.css │ │ │ │ │ ├── EventStatistics.spec.tsx │ │ │ │ │ └── EventStatistics.tsx │ │ │ │ └── EventRegistrant/ │ │ │ │ ├── EventRegistrants.spec.tsx │ │ │ │ ├── EventRegistrants.tsx │ │ │ │ └── Registrations.mocks.ts │ │ │ ├── EventRegistrantsModal/ │ │ │ │ ├── EventRegistrants.module.css │ │ │ │ ├── EventRegistrantsWrapper.module.css │ │ │ │ ├── EventRegistrantsWrapper.spec.tsx │ │ │ │ ├── EventRegistrantsWrapper.tsx │ │ │ │ └── Modal/ │ │ │ │ ├── AddOnSpot/ │ │ │ │ │ ├── AddOnSpotAttendee.module.css │ │ │ │ │ ├── AddOnSpotAttendee.spec.tsx │ │ │ │ │ └── AddOnSpotAttendee.tsx │ │ │ │ ├── EventRegistrantsModal.module.css │ │ │ │ ├── EventRegistrantsModal.spec.tsx │ │ │ │ ├── EventRegistrantsModal.tsx │ │ │ │ └── InviteByEmail/ │ │ │ │ ├── InviteByEmail.module.css │ │ │ │ ├── InviteByEmailModal.module.css │ │ │ │ ├── InviteByEmailModal.spec.tsx │ │ │ │ └── InviteByEmailModal.tsx │ │ │ ├── LeftDrawer/ │ │ │ │ ├── LeftDrawer.module.css │ │ │ │ ├── LeftDrawer.spec.tsx │ │ │ │ └── LeftDrawer.tsx │ │ │ ├── OrgContriCards/ │ │ │ │ ├── OrgContriCards.spec.tsx │ │ │ │ └── OrgContriCards.tsx │ │ │ ├── OrgPeopleListCard/ │ │ │ │ ├── OrgPeopleListCard.module.css │ │ │ │ ├── OrgPeopleListCard.spec.tsx │ │ │ │ └── OrgPeopleListCard.tsx │ │ │ ├── OrgSettings/ │ │ │ │ ├── ActionItemCategories/ │ │ │ │ │ ├── Modal/ │ │ │ │ │ │ ├── ActionItemCategoryModal.module.css │ │ │ │ │ │ ├── ActionItemCategoryModal.spec.tsx │ │ │ │ │ │ ├── ActionItemCategoryModal.tsx │ │ │ │ │ │ ├── ActionItemCategoryViewModal.spec.tsx │ │ │ │ │ │ └── ActionItemCategoryViewModal.tsx │ │ │ │ │ ├── OrgActionItemCategories.module.css │ │ │ │ │ ├── OrgActionItemCategories.spec.tsx │ │ │ │ │ ├── OrgActionItemCategories.tsx │ │ │ │ │ └── OrgActionItemCategoryMocks.ts │ │ │ │ ├── AgendaItemCategories/ │ │ │ │ │ └── OrganizationAgendaCategory.module.css │ │ │ │ └── General/ │ │ │ │ ├── DeleteOrg/ │ │ │ │ │ ├── DeleteOrg.module.css │ │ │ │ │ ├── DeleteOrg.spec.tsx │ │ │ │ │ └── DeleteOrg.tsx │ │ │ │ ├── GeneralSettings.spec.tsx │ │ │ │ ├── GeneralSettings.tsx │ │ │ │ └── OrgUpdate/ │ │ │ │ ├── OrgUpdate.module.css │ │ │ │ ├── OrgUpdate.spec.tsx │ │ │ │ ├── OrgUpdate.tsx │ │ │ │ └── OrgUpdateMocks.ts │ │ │ ├── OrganizationDashCards/ │ │ │ │ ├── CardItem/ │ │ │ │ │ ├── CardItem.module.css │ │ │ │ │ ├── CardItem.spec.tsx │ │ │ │ │ ├── CardItem.tsx │ │ │ │ │ └── Loader/ │ │ │ │ │ ├── CardItemLoading.module.css │ │ │ │ │ ├── CardItemLoading.spec.tsx │ │ │ │ │ └── CardItemLoading.tsx │ │ │ │ ├── DashboardCard.module.css │ │ │ │ ├── DashboardCard.spec.tsx │ │ │ │ ├── DashboardCard.tsx │ │ │ │ └── Loader/ │ │ │ │ ├── DashboardCardLoading.module.css │ │ │ │ ├── DashboardCardLoading.spec.tsx │ │ │ │ └── DashboardCardLoading.tsx │ │ │ ├── OrganizationScreen/ │ │ │ │ ├── OrganizationScreen.module.css │ │ │ │ ├── OrganizationScreen.spec.tsx │ │ │ │ └── OrganizationScreen.tsx │ │ │ ├── README.md │ │ │ ├── SecuredRoute/ │ │ │ │ ├── SecuredRoute.tsx │ │ │ │ └── securedRoute.spec.tsx │ │ │ ├── SuperAdminScreen/ │ │ │ │ ├── SuperAdminScreen.module.css │ │ │ │ ├── SuperAdminScreen.spec.tsx │ │ │ │ └── SuperAdminScreen.tsx │ │ │ ├── TagActions/ │ │ │ │ ├── Node/ │ │ │ │ │ ├── TagNode.module.css │ │ │ │ │ ├── TagNode.spec.tsx │ │ │ │ │ ├── TagNode.tsx │ │ │ │ │ └── TagNodeMocks.ts │ │ │ │ ├── TagAction.module.css │ │ │ │ ├── TagActions.module.css │ │ │ │ ├── TagActions.spec.tsx │ │ │ │ ├── TagActions.tsx │ │ │ │ └── TagActionsMocks.ts │ │ │ ├── UpdateSession/ │ │ │ │ ├── UpdateSession.module.css │ │ │ │ ├── UpdateSession.spec.tsx │ │ │ │ └── UpdateSession.tsx │ │ │ ├── UserTableRow/ │ │ │ │ ├── UserTableRow.module.css │ │ │ │ ├── UserTableRow.spec.tsx │ │ │ │ └── UserTableRow.tsx │ │ │ └── Venues/ │ │ │ ├── Modal/ │ │ │ │ ├── VenueModal.module.css │ │ │ │ ├── VenueModal.spec.tsx │ │ │ │ └── VenueModal.tsx │ │ │ ├── VenueCard.module.css │ │ │ ├── VenueCard.spec.tsx │ │ │ ├── VenueCard.tsx │ │ │ └── VenueCardMocks.ts │ │ ├── Auth/ │ │ │ ├── LoginForm/ │ │ │ │ ├── LoginForm.module.css │ │ │ │ ├── LoginForm.spec.tsx │ │ │ │ └── LoginForm.tsx │ │ │ ├── OAuthButton/ │ │ │ │ ├── OAuthButton.module.css │ │ │ │ ├── OAuthButton.spec.tsx │ │ │ │ └── OAuthButton.tsx │ │ │ ├── OrgSelector/ │ │ │ │ ├── OrgSelector.spec.tsx │ │ │ │ └── OrgSelector.tsx │ │ │ ├── PasswordStrengthIndicator/ │ │ │ │ ├── PasswordStrengthIndicator.spec.tsx │ │ │ │ ├── PasswordStrengthIndicator.tsx │ │ │ │ └── RequirementRow.tsx │ │ │ ├── RegistrationForm/ │ │ │ │ ├── RegistrationForm.module.css │ │ │ │ ├── RegistrationForm.spec.tsx │ │ │ │ └── RegistrationForm.tsx │ │ │ └── theme/ │ │ │ ├── oauthBrand.module.css │ │ │ ├── oauthBrand.spec.tsx │ │ │ └── oauthBrand.tsx │ │ ├── ChangeLanguageDropdown/ │ │ │ ├── ChangeLanguageDropDown.module.css │ │ │ ├── ChangeLanguageDropDown.spec.tsx │ │ │ └── ChangeLanguageDropDown.tsx │ │ ├── CollapsibleDropdown/ │ │ │ ├── CollapsibleDropdown.module.css │ │ │ ├── CollapsibleDropdown.spec.tsx │ │ │ └── CollapsibleDropdown.tsx │ │ ├── CursorPaginationManager/ │ │ │ ├── CursorPaginationManager.module.css │ │ │ ├── CursorPaginationManager.spec.tsx │ │ │ └── CursorPaginationManager.tsx │ │ ├── EventCalender/ │ │ │ ├── EventCalenderMocks.ts │ │ │ ├── Header/ │ │ │ │ ├── EventHeader.module.css │ │ │ │ ├── EventHeader.spec.tsx │ │ │ │ └── EventHeader.tsx │ │ │ ├── Monthly/ │ │ │ │ ├── EventCalendar.spec.tsx │ │ │ │ ├── EventCalender.module.css │ │ │ │ └── EventCalender.tsx │ │ │ └── Yearly/ │ │ │ ├── YearlyEventCalender.module.css │ │ │ ├── YearlyEventCalender.spec.tsx │ │ │ └── YearlyEventCalender.tsx │ │ ├── EventDashboardScreen/ │ │ │ ├── EventDashboardScreen.module.css │ │ │ ├── EventDashboardScreen.spec.tsx │ │ │ ├── EventDashboardScreen.tsx │ │ │ └── EventDashboardScreenMocks.ts │ │ ├── EventStats/ │ │ │ ├── EventStatsMocks.ts │ │ │ ├── Statistics/ │ │ │ │ ├── AverageRating/ │ │ │ │ │ ├── AverageRating.module.css │ │ │ │ │ ├── AverageRating.spec.tsx │ │ │ │ │ └── AverageRating.tsx │ │ │ │ ├── EventStats.module.css │ │ │ │ ├── EventStats.spec.tsx │ │ │ │ ├── EventStats.tsx │ │ │ │ ├── Feedback/ │ │ │ │ │ ├── Feedback.module.css │ │ │ │ │ ├── Feedback.spec.tsx │ │ │ │ │ └── Feedback.tsx │ │ │ │ └── Review/ │ │ │ │ ├── Review.module.css │ │ │ │ ├── Review.spec.tsx │ │ │ │ └── Review.tsx │ │ │ └── css/ │ │ │ ├── EventStats.module.css │ │ │ └── Loader.module.css │ │ ├── HolidayCards/ │ │ │ ├── HolidayCard.module.css │ │ │ ├── HolidayCard.spec.tsx │ │ │ └── HolidayCard.tsx │ │ ├── IconComponent/ │ │ │ ├── IconComponent.spec.tsx │ │ │ └── IconComponent.tsx │ │ ├── LeftDrawerOrg/ │ │ │ ├── LeftDrawerOrg.module.css │ │ │ ├── LeftDrawerOrg.spec.tsx │ │ │ └── LeftDrawerOrg.tsx │ │ ├── NotificationIcon/ │ │ │ ├── NotificationIcon.module.css │ │ │ ├── NotificationIcon.spec.tsx │ │ │ └── NotificationIcon.tsx │ │ ├── NotificationToast/ │ │ │ └── NotificationToast.tsx │ │ ├── Pagination/ │ │ │ └── Navigator/ │ │ │ ├── Pagination.module.css │ │ │ ├── Pagination.spec.tsx │ │ │ └── Pagination.tsx │ │ ├── ProfileCard/ │ │ │ ├── ProfileCard.module.css │ │ │ ├── ProfileCard.spec.tsx │ │ │ └── ProfileCard.tsx │ │ ├── ProfileDropdown/ │ │ │ ├── ProfileDropdown.module.css │ │ │ ├── ProfileDropdown.spec.tsx │ │ │ └── ProfileDropdown.tsx │ │ ├── SignOut/ │ │ │ ├── SignOut.spec.tsx │ │ │ └── SignOut.tsx │ │ ├── UserDetails/ │ │ │ ├── UserEvents.module.css │ │ │ ├── UserEvents.spec.tsx │ │ │ ├── UserEvents.tsx │ │ │ ├── UserOrganizations.module.css │ │ │ ├── UserOrganizations.spec.tsx │ │ │ ├── UserOrganizations.tsx │ │ │ ├── UserTags.module.css │ │ │ ├── UserTags.spec.tsx │ │ │ └── UserTags.tsx │ │ ├── UserPortal/ │ │ │ ├── ChatRoom/ │ │ │ │ ├── ChatHeader.module.css │ │ │ │ ├── ChatHeader.tsx │ │ │ │ ├── ChatRoom.module.css │ │ │ │ ├── ChatRoom.spec.tsx │ │ │ │ ├── ChatRoom.tsx │ │ │ │ ├── EmptyChatState.module.css │ │ │ │ ├── EmptyChatState.spec.tsx │ │ │ │ ├── EmptyChatState.tsx │ │ │ │ ├── MessageImage.module.css │ │ │ │ ├── MessageImage.tsx │ │ │ │ ├── MessageInput.module.css │ │ │ │ ├── MessageInput.tsx │ │ │ │ ├── MessageItem.module.css │ │ │ │ ├── MessageItem.tsx │ │ │ │ └── types.ts │ │ │ ├── CommentCard/ │ │ │ │ ├── CommentCard.module.css │ │ │ │ ├── CommentCard.spec.tsx │ │ │ │ └── CommentCard.tsx │ │ │ ├── ContactCard/ │ │ │ │ ├── ContactCard.module.css │ │ │ │ ├── ContactCard.spec.tsx │ │ │ │ └── ContactCard.tsx │ │ │ ├── CreateDirectChat/ │ │ │ │ ├── CreateDirectChat.module.css │ │ │ │ ├── CreateDirectChat.spec.tsx │ │ │ │ └── CreateDirectChat.tsx │ │ │ ├── CreateGroupChat/ │ │ │ │ ├── CreateGroupChat.module.css │ │ │ │ ├── CreateGroupChat.spec.tsx │ │ │ │ └── CreateGroupChat.tsx │ │ │ ├── DonationCard/ │ │ │ │ ├── DonationCard.module.css │ │ │ │ ├── DonationCard.spec.tsx │ │ │ │ └── DonationCard.tsx │ │ │ ├── EventCard/ │ │ │ │ ├── EventCard.module.css │ │ │ │ ├── EventCard.spec.tsx │ │ │ │ └── EventCard.tsx │ │ │ ├── GroupChatDetails/ │ │ │ │ ├── GroupChatDetails.module.css │ │ │ │ ├── GroupChatDetails.spec.tsx │ │ │ │ ├── GroupChatDetails.tsx │ │ │ │ └── GroupChatDetailsMocks.tsx │ │ │ ├── OrganizationSidebar/ │ │ │ │ ├── OrganizationSidebar.module.css │ │ │ │ ├── OrganizationSidebar.spec.tsx │ │ │ │ └── OrganizationSidebar.tsx │ │ │ ├── SecuredRouteForUser/ │ │ │ │ ├── SecuredRouteForUser.spec.tsx │ │ │ │ └── SecuredRouteForUser.tsx │ │ │ ├── UserNavbar/ │ │ │ │ ├── UserNavbar.module.css │ │ │ │ ├── UserNavbar.spec.tsx │ │ │ │ └── UserNavbar.tsx │ │ │ ├── UserPortalCard/ │ │ │ │ ├── UserPortalCard.module.css │ │ │ │ ├── UserPortalCard.spec.tsx │ │ │ │ └── UserPortalCard.tsx │ │ │ ├── UserPortalNavigationBar/ │ │ │ │ ├── LanguageSelector.module.css │ │ │ │ ├── LanguageSelector.tsx │ │ │ │ ├── UserDropdown.tsx │ │ │ │ ├── UserPortalNavigationBar.module.css │ │ │ │ ├── UserPortalNavigationBar.spec.tsx │ │ │ │ ├── UserPortalNavigationBar.tsx │ │ │ │ └── UserPortalNavigationBarMocks.ts │ │ │ ├── UserProfileSettings/ │ │ │ │ ├── UserProfile.module.css │ │ │ │ ├── UserProfile.spec.tsx │ │ │ │ └── UserProfile.tsx │ │ │ ├── UserSidebar/ │ │ │ │ ├── UserSidebar.module.css │ │ │ │ ├── UserSidebar.spec.tsx │ │ │ │ └── UserSidebar.tsx │ │ │ └── UserSidebarOrg/ │ │ │ ├── UserSidebarOrg.module.css │ │ │ ├── UserSidebarOrg.spec.tsx │ │ │ └── UserSidebarOrg.tsx │ │ └── UsersTableItem/ │ │ ├── UserTableItem.spec.tsx │ │ ├── UserTableItemMocks.ts │ │ ├── UsersTableItem.module.css │ │ └── UsersTableItem.tsx │ ├── config/ │ │ └── oauthProviders.ts │ ├── constants.ts │ ├── hooks/ │ │ ├── auth/ │ │ │ ├── useAuthNotifications.spec.ts │ │ │ ├── useAuthNotifications.ts │ │ │ ├── useLogin.spec.ts │ │ │ ├── useLogin.ts │ │ │ ├── useRegistration.spec.ts │ │ │ └── useRegistration.ts │ │ ├── useAvatarUpload.spec.ts │ │ ├── useAvatarUpload.ts │ │ ├── useFieldValidation.spec.ts │ │ ├── useFieldValidation.ts │ │ ├── usePasswordVisibility.spec.ts │ │ ├── usePasswordVisibility.ts │ │ ├── useUserProfile.spec.ts │ │ └── useUserProfile.ts │ ├── index.spec.tsx │ ├── index.tsx │ ├── install/ │ │ ├── index.spec.ts │ │ ├── index.ts │ │ ├── os/ │ │ │ ├── detector.spec.ts │ │ │ ├── detector.ts │ │ │ ├── linux.spec.ts │ │ │ ├── linux.ts │ │ │ ├── macos.spec.ts │ │ │ ├── macos.ts │ │ │ ├── windows.spec.ts │ │ │ └── windows.ts │ │ ├── packages/ │ │ │ ├── index.spec.ts │ │ │ └── index.ts │ │ ├── types.spec.ts │ │ ├── types.ts │ │ └── utils/ │ │ ├── checker.spec.ts │ │ ├── checker.ts │ │ ├── checkers/ │ │ │ ├── docker.ts │ │ │ ├── index.ts │ │ │ └── typescript.ts │ │ ├── exec.spec.ts │ │ ├── exec.ts │ │ ├── logger.spec.ts │ │ └── logger.ts │ ├── plugin/ │ │ ├── available/ │ │ │ └── readme.md │ │ ├── components/ │ │ │ ├── PluginInjector.module.css │ │ │ ├── PluginInjector.spec.tsx │ │ │ └── PluginInjector.tsx │ │ ├── graphql-service.ts │ │ ├── hooks.ts │ │ ├── index.ts │ │ ├── manager.ts │ │ ├── managers/ │ │ │ ├── discovery.ts │ │ │ ├── event-manager.spec.ts │ │ │ ├── event-manager.ts │ │ │ ├── extension-registry.ts │ │ │ ├── lifecycle.spec.ts │ │ │ └── lifecycle.ts │ │ ├── registry.module.css │ │ ├── registry.tsx │ │ ├── routes/ │ │ │ ├── PluginRouteRenderer.module.css │ │ │ ├── PluginRouteRenderer.spec.tsx │ │ │ ├── PluginRouteRenderer.tsx │ │ │ ├── PluginRoutes.module.css │ │ │ ├── PluginRoutes.spec.tsx │ │ │ └── PluginRoutes.tsx │ │ ├── services/ │ │ │ ├── AdminPluginFileService.ts │ │ │ └── InternalFileWriter.ts │ │ ├── tests/ │ │ │ ├── EventManager.spec.ts │ │ │ ├── graphql-service.spec.ts │ │ │ ├── hooks.spec.ts │ │ │ ├── manager.spec.ts │ │ │ ├── managers/ │ │ │ │ ├── discovery.spec.ts │ │ │ │ ├── event-manager.spec.ts │ │ │ │ └── extension-registry.spec.ts │ │ │ ├── registry.spec.ts │ │ │ ├── services/ │ │ │ │ ├── AdminPluginFileService.spec.ts │ │ │ │ └── InternalFileWriter.spec.ts │ │ │ ├── utils.spec.ts │ │ │ └── vite/ │ │ │ └── internalFileWriterPlugin.spec.ts │ │ ├── types.ts │ │ ├── utils.ts │ │ └── vite/ │ │ └── internalFileWriterPlugin.ts │ ├── reportWebVitals.spec.ts │ ├── reportWebVitals.ts │ ├── screens/ │ │ ├── AdminPortal/ │ │ │ ├── BlockUser/ │ │ │ │ ├── BlockUser.module.css │ │ │ │ ├── BlockUser.spec.tsx │ │ │ │ └── BlockUser.tsx │ │ │ ├── CommunityProfile/ │ │ │ │ ├── CommunityProfile.module.css │ │ │ │ ├── CommunityProfile.spec.tsx │ │ │ │ └── CommunityProfile.tsx │ │ │ ├── EventManagement/ │ │ │ │ ├── EventManagement.module.css │ │ │ │ ├── EventManagement.spec.tsx │ │ │ │ └── EventManagement.tsx │ │ │ ├── EventVolunteers/ │ │ │ │ ├── Requests/ │ │ │ │ │ ├── Requests.mocks.ts │ │ │ │ │ ├── Requests.module.css │ │ │ │ │ ├── Requests.spec.tsx │ │ │ │ │ └── Requests.tsx │ │ │ │ ├── VolunteerContainer.module.css │ │ │ │ ├── VolunteerContainer.spec.tsx │ │ │ │ ├── VolunteerContainer.tsx │ │ │ │ ├── VolunteerGroups/ │ │ │ │ │ ├── VolunteerGroups.module.css │ │ │ │ │ ├── VolunteerGroups.spec.tsx │ │ │ │ │ ├── VolunteerGroups.tsx │ │ │ │ │ ├── deleteModal/ │ │ │ │ │ │ ├── VolunteerGroupDeleteModal.module.css │ │ │ │ │ │ ├── VolunteerGroupDeleteModal.spec.tsx │ │ │ │ │ │ └── VolunteerGroupDeleteModal.tsx │ │ │ │ │ └── modal/ │ │ │ │ │ ├── VolunteerGroupModal.module.css │ │ │ │ │ ├── VolunteerGroupModal.spec.tsx │ │ │ │ │ ├── VolunteerGroupModal.tsx │ │ │ │ │ └── VolunteerGroups.mocks.ts │ │ │ │ └── Volunteers/ │ │ │ │ ├── Volunteers.mocks.ts │ │ │ │ ├── Volunteers.module.css │ │ │ │ ├── Volunteers.spec.tsx │ │ │ │ ├── Volunteers.tsx │ │ │ │ ├── createModal/ │ │ │ │ │ ├── VolunteerCreateModal.module.css │ │ │ │ │ ├── VolunteerCreateModal.spec.tsx │ │ │ │ │ └── VolunteerCreateModal.tsx │ │ │ │ ├── deleteModal/ │ │ │ │ │ ├── VolunteerDeleteModal.module.css │ │ │ │ │ ├── VolunteerDeleteModal.spec.tsx │ │ │ │ │ └── VolunteerDeleteModal.tsx │ │ │ │ └── viewModal/ │ │ │ │ ├── VolunteerViewModal.module.css │ │ │ │ ├── VolunteerViewModal.spec.tsx │ │ │ │ └── VolunteerViewModal.tsx │ │ │ ├── FundCampaignPledge/ │ │ │ │ ├── FundCampaignPledge.module.css │ │ │ │ ├── FundCampaignPledge.spec.tsx │ │ │ │ ├── FundCampaignPledge.tsx │ │ │ │ ├── PledgeColumns.module.css │ │ │ │ ├── PledgeColumns.spec.tsx │ │ │ │ ├── PledgeColumns.tsx │ │ │ │ ├── Pledges.mocks.ts │ │ │ │ ├── deleteModal/ │ │ │ │ │ ├── PledgeDeleteModal.module.css │ │ │ │ │ ├── PledgeDeleteModal.spec.tsx │ │ │ │ │ └── PledgeDeleteModal.tsx │ │ │ │ └── modal/ │ │ │ │ ├── PledgeModal.module.css │ │ │ │ ├── PledgeModal.spec.tsx │ │ │ │ └── PledgeModal.tsx │ │ │ ├── Leaderboard/ │ │ │ │ ├── Leaderboard.mocks.ts │ │ │ │ ├── Leaderboard.module.css │ │ │ │ ├── Leaderboard.spec.tsx │ │ │ │ └── Leaderboard.tsx │ │ │ ├── ManageTag/ │ │ │ │ ├── ManageTag.module.css │ │ │ │ ├── ManageTag.spec.tsx │ │ │ │ ├── ManageTag.tsx │ │ │ │ ├── ManageTagMockComponents/ │ │ │ │ │ ├── MockAddPeopleToTag.tsx │ │ │ │ │ └── MockTagActions.tsx │ │ │ │ ├── ManageTagMockUtils.spec.ts │ │ │ │ ├── ManageTagMockUtils.ts │ │ │ │ ├── ManageTagMocks.ts │ │ │ │ ├── ManageTagNonErrorMocks.ts │ │ │ │ ├── ManageTagNullFalsyMocks.ts │ │ │ │ ├── editModal/ │ │ │ │ │ ├── EditUserTagModal.module.css │ │ │ │ │ ├── EditUserTagModal.spec.tsx │ │ │ │ │ └── EditUserTagModal.tsx │ │ │ │ ├── removeModal/ │ │ │ │ │ ├── RemoveUserTagModal.module.css │ │ │ │ │ ├── RemoveUserTagModal.spec.tsx │ │ │ │ │ └── RemoveUserTagModal.tsx │ │ │ │ └── unassignModal/ │ │ │ │ ├── UnassignUserTagModal.module.css │ │ │ │ ├── UnassignUserTagModal.spec.tsx │ │ │ │ └── UnassignUserTagModal.tsx │ │ │ ├── MemberDetail/ │ │ │ │ ├── MemberDetail.module.css │ │ │ │ ├── MemberDetail.spec.tsx │ │ │ │ ├── MemberDetail.tsx │ │ │ │ ├── UserContactDetails.module.css │ │ │ │ ├── UserContactDetails.spec.tsx │ │ │ │ ├── UserContactDetails.tsx │ │ │ │ ├── fieldConfigs.ts │ │ │ │ ├── resolveAvatarFile.spec.ts │ │ │ │ └── resolveAvatarFile.ts │ │ │ ├── Notification/ │ │ │ │ ├── Notification.module.css │ │ │ │ ├── Notification.spec.tsx │ │ │ │ └── Notification.tsx │ │ │ ├── OrgContribution/ │ │ │ │ ├── OrgContribution.module.css │ │ │ │ ├── OrgContribution.spec.tsx │ │ │ │ └── OrgContribution.tsx │ │ │ ├── OrgList/ │ │ │ │ ├── OrgList.module.css │ │ │ │ ├── OrgList.spec.tsx │ │ │ │ ├── OrgList.tsx │ │ │ │ ├── OrgListMocks.ts │ │ │ │ └── modal/ │ │ │ │ ├── OrganizationModal.module.css │ │ │ │ ├── OrganizationModal.spec.tsx │ │ │ │ └── OrganizationModal.tsx │ │ │ ├── OrgSettings/ │ │ │ │ ├── OrgSettings.mocks.ts │ │ │ │ ├── OrgSettings.module.css │ │ │ │ ├── OrgSettings.spec.tsx │ │ │ │ └── OrgSettings.tsx │ │ │ ├── OrganizationDashboard/ │ │ │ │ ├── OrganizationDashboard.module.css │ │ │ │ ├── OrganizationDashboard.spec.tsx │ │ │ │ ├── OrganizationDashboard.tsx │ │ │ │ ├── OrganizationDashboardMocks.ts │ │ │ │ ├── OrganizationDashboardSecondaryMocks.ts │ │ │ │ └── components/ │ │ │ │ ├── DashboardStats.module.css │ │ │ │ ├── DashboardStats.spec.tsx │ │ │ │ ├── DashboardStats.tsx │ │ │ │ ├── UpcomingEventsCard.module.css │ │ │ │ ├── UpcomingEventsCard.spec.tsx │ │ │ │ └── UpcomingEventsCard.tsx │ │ │ ├── OrganizationEvents/ │ │ │ │ ├── CreateEventModal.spec.tsx │ │ │ │ ├── CreateEventModal.tsx │ │ │ │ ├── CustomRecurrenceModal.spec.tsx │ │ │ │ ├── CustomRecurrenceModal.tsx │ │ │ │ ├── OrganizationEvents.module.css │ │ │ │ ├── OrganizationEvents.spec.tsx │ │ │ │ ├── OrganizationEvents.tsx │ │ │ │ └── OrganizationEventsMocks.ts │ │ │ ├── OrganizationFundCampaign/ │ │ │ │ ├── OrganizationFundCampaign.spec.tsx │ │ │ │ ├── OrganizationFundCampaignMocks.ts │ │ │ │ ├── OrganizationFundCampaigns.module.css │ │ │ │ ├── OrganizationFundCampaigns.tsx │ │ │ │ └── modal/ │ │ │ │ ├── CampaignModal.module.css │ │ │ │ ├── CampaignModal.spec.tsx │ │ │ │ ├── CampaignModal.tsx │ │ │ │ └── types.ts │ │ │ ├── OrganizationFunds/ │ │ │ │ ├── OrganizationFunds.module.css │ │ │ │ ├── OrganizationFunds.spec.tsx │ │ │ │ ├── OrganizationFunds.tsx │ │ │ │ ├── OrganizationFundsMocks.ts │ │ │ │ └── modal/ │ │ │ │ ├── FundModal.module.css │ │ │ │ ├── FundModal.spec.tsx │ │ │ │ └── FundModal.tsx │ │ │ ├── OrganizationPeople/ │ │ │ │ ├── OrganizationPeople.module.css │ │ │ │ ├── OrganizationPeople.spec.tsx │ │ │ │ ├── OrganizationPeople.tsx │ │ │ │ └── addMember/ │ │ │ │ ├── AddMember.module.css │ │ │ │ ├── AddMember.spec.tsx │ │ │ │ ├── AddMember.tsx │ │ │ │ ├── types.spec.ts │ │ │ │ └── types.ts │ │ │ ├── OrganizationTags/ │ │ │ │ ├── OrganizationTags.module.css │ │ │ │ ├── OrganizationTags.spec.tsx │ │ │ │ ├── OrganizationTags.tsx │ │ │ │ └── OrganizationTagsMocks.ts │ │ │ ├── OrganizationTransactions/ │ │ │ │ ├── OrganizationTransactions.module.css │ │ │ │ ├── OrganizationTransactions.spec.tsx │ │ │ │ └── OrganizationTransactions.tsx │ │ │ ├── OrganizationVenues/ │ │ │ │ ├── OrganizationVenues.module.css │ │ │ │ ├── OrganizationVenues.spec.tsx │ │ │ │ └── OrganizationVenues.tsx │ │ │ ├── PluginStore/ │ │ │ │ ├── PluginModal.module.css │ │ │ │ ├── PluginModal.spec.tsx │ │ │ │ ├── PluginModal.tsx │ │ │ │ ├── PluginStore.module.css │ │ │ │ ├── PluginStore.spec.tsx │ │ │ │ ├── PluginStore.tsx │ │ │ │ ├── UploadPluginModal.module.css │ │ │ │ ├── UploadPluginModal.spec.tsx │ │ │ │ ├── UploadPluginModal.tsx │ │ │ │ ├── components/ │ │ │ │ │ ├── PluginCard.module.css │ │ │ │ │ ├── PluginCard.tsx │ │ │ │ │ ├── PluginList.module.css │ │ │ │ │ ├── PluginList.tsx │ │ │ │ │ ├── UninstallConfirmationModal.spec.tsx │ │ │ │ │ ├── UninstallConfirmationModal.tsx │ │ │ │ │ ├── index.ts │ │ │ │ │ └── tests/ │ │ │ │ │ └── PluginList.test.tsx │ │ │ │ └── hooks/ │ │ │ │ ├── index.ts │ │ │ │ ├── useInstallTimer.spec.ts │ │ │ │ ├── useInstallTimer.ts │ │ │ │ ├── usePluginActions.spec.ts │ │ │ │ ├── usePluginActions.ts │ │ │ │ ├── usePluginFilters.spec.ts │ │ │ │ └── usePluginFilters.ts │ │ │ ├── Requests/ │ │ │ │ ├── Requests.module.css │ │ │ │ ├── Requests.spec.tsx │ │ │ │ ├── Requests.tsx │ │ │ │ └── RequestsMocks.ts │ │ │ ├── SubTags/ │ │ │ │ ├── SubTags.module.css │ │ │ │ ├── SubTags.spec.tsx │ │ │ │ ├── SubTags.tsx │ │ │ │ └── SubTagsMocks.ts │ │ │ └── Users/ │ │ │ ├── Organization.mocks.ts │ │ │ ├── User.mocks.ts │ │ │ ├── Users.module.css │ │ │ ├── Users.spec.tsx │ │ │ ├── Users.tsx │ │ │ └── UsersMocks.mocks.ts │ │ ├── Auth/ │ │ │ ├── ForgotPassword/ │ │ │ │ ├── ForgotPassword.module.css │ │ │ │ ├── ForgotPassword.spec.tsx │ │ │ │ └── ForgotPassword.tsx │ │ │ ├── LoginPage/ │ │ │ │ ├── LoginPage.module.css │ │ │ │ ├── LoginPage.spec.tsx │ │ │ │ └── LoginPage.tsx │ │ │ └── VerifyEmail/ │ │ │ ├── VerifyEmail.module.css │ │ │ ├── VerifyEmail.spec.tsx │ │ │ └── VerifyEmail.tsx │ │ ├── Public/ │ │ │ ├── Invitation/ │ │ │ │ ├── AcceptInvitation.spec.tsx │ │ │ │ └── AcceptInvitation.tsx │ │ │ └── PageNotFound/ │ │ │ ├── PageNotFound.module.css │ │ │ ├── PageNotFound.spec.tsx │ │ │ └── PageNotFound.tsx │ │ └── UserPortal/ │ │ ├── Campaigns/ │ │ │ ├── Campaigns.module.css │ │ │ ├── Campaigns.spec.tsx │ │ │ ├── Campaigns.tsx │ │ │ ├── CampaignsMocks.ts │ │ │ ├── PledgeModal.module.css │ │ │ ├── PledgeModal.spec.tsx │ │ │ └── PledgeModal.tsx │ │ ├── Chat/ │ │ │ ├── Chat.module.css │ │ │ ├── Chat.spec.tsx │ │ │ └── Chat.tsx │ │ ├── Donate/ │ │ │ ├── Donate.module.css │ │ │ ├── Donate.spec.tsx │ │ │ └── Donate.tsx │ │ ├── Events/ │ │ │ ├── Events.module.css │ │ │ ├── Events.spec.tsx │ │ │ └── Events.tsx │ │ ├── LeaveOrganization/ │ │ │ ├── LeaveOrganization.localStorage.spec.tsx │ │ │ ├── LeaveOrganization.module.css │ │ │ ├── LeaveOrganization.spec.tsx │ │ │ └── LeaveOrganization.tsx │ │ ├── Organizations/ │ │ │ ├── Organizations.module.css │ │ │ ├── Organizations.spec.tsx │ │ │ └── Organizations.tsx │ │ ├── People/ │ │ │ ├── People.module.css │ │ │ ├── People.spec.tsx │ │ │ └── People.tsx │ │ ├── Pledges/ │ │ │ ├── Pledges.module.css │ │ │ ├── Pledges.spec.tsx │ │ │ ├── Pledges.tsx │ │ │ └── PledgesMocks.ts │ │ ├── Transactions/ │ │ │ ├── Transactions.module.css │ │ │ ├── Transactions.spec.tsx │ │ │ └── Transactions.tsx │ │ ├── UserGlobalScreen/ │ │ │ ├── UserGlobalScreen.module.css │ │ │ ├── UserGlobalScreen.spec.tsx │ │ │ └── UserGlobalScreen.tsx │ │ ├── UserScreen/ │ │ │ ├── UserScreen.module.css │ │ │ ├── UserScreen.spec.tsx │ │ │ └── UserScreen.tsx │ │ └── Volunteer/ │ │ ├── Actions/ │ │ │ ├── Actions.mocks.ts │ │ │ ├── Actions.module.css │ │ │ ├── Actions.spec.tsx │ │ │ └── Actions.tsx │ │ ├── Groups/ │ │ │ ├── GroupModal.module.css │ │ │ ├── GroupModal.spec.tsx │ │ │ ├── GroupModal.tsx │ │ │ ├── Groups.mocks.ts │ │ │ ├── Groups.module.css │ │ │ ├── Groups.spec.tsx │ │ │ └── Groups.tsx │ │ ├── Invitations/ │ │ │ ├── Invitations.module.css │ │ │ ├── Invitations.spec.tsx │ │ │ └── Invitations.tsx │ │ ├── UpcomingEvents/ │ │ │ ├── RecurringEventVolunteerModal.module.css │ │ │ ├── RecurringEventVolunteerModal.spec.tsx │ │ │ ├── RecurringEventVolunteerModal.tsx │ │ │ ├── UpcomingEvents.mockEvents.ts │ │ │ ├── UpcomingEvents.mockHelpers.ts │ │ │ ├── UpcomingEvents.mocks.ts │ │ │ ├── UpcomingEvents.module.css │ │ │ ├── UpcomingEvents.spec.tsx │ │ │ └── UpcomingEvents.tsx │ │ ├── VolunteerManagement.module.css │ │ ├── VolunteerManagement.spec.tsx │ │ └── VolunteerManagement.tsx │ ├── setup/ │ │ ├── askAndSetDockerOption/ │ │ │ ├── askAndSetDockerOption.spec.ts │ │ │ └── askAndSetDockerOption.ts │ │ ├── askAndUpdatePort/ │ │ │ ├── askAndUpdatePort.ts │ │ │ └── askForUpdatePort.spec.ts │ │ ├── askForCustomPort/ │ │ │ ├── askForCustomPort.spec.ts │ │ │ └── askForCustomPort.ts │ │ ├── askForDocker/ │ │ │ ├── askForDocker.spec.ts │ │ │ └── askForDocker.ts │ │ ├── askForTalawaApiUrl/ │ │ │ ├── askForTalawaApiUrl.spec.ts │ │ │ └── askForTalawaApiUrl.ts │ │ ├── backupEnvFile/ │ │ │ ├── backupEnvFile.spec.ts │ │ │ └── backupEnvFile.ts │ │ ├── checkConnection/ │ │ │ ├── checkConnection.spec.ts │ │ │ └── checkConnection.ts │ │ ├── checkEnvFile/ │ │ │ ├── checkEnvFile.spec.ts │ │ │ └── checkEnvFile.ts │ │ ├── setup.spec.ts │ │ ├── setup.ts │ │ ├── updateEnvFile/ │ │ │ ├── updateEnvFile.spec.ts │ │ │ └── updateEnvFile.ts │ │ └── validateRecaptcha/ │ │ ├── validateRecaptcha.spec.ts │ │ └── validateRecaptcha.ts │ ├── setupTests.spec.ts │ ├── setupTests.ts │ ├── shared-components/ │ │ ├── ActionItems/ │ │ │ ├── ActionItem.mocks.ts │ │ │ ├── ActionItemDeleteModal/ │ │ │ │ ├── ActionItemDeleteModal.spec.tsx │ │ │ │ └── ActionItemDeleteModal.tsx │ │ │ ├── ActionItemModal/ │ │ │ │ ├── ActionItemModal.module.css │ │ │ │ ├── ActionItemModal.spec.tsx │ │ │ │ └── ActionItemModal.tsx │ │ │ ├── ActionItemUpdateModal/ │ │ │ │ ├── ActionItemUpdateStatusModal.module.css │ │ │ │ ├── ActionItemUpdateStatusModal.spec.tsx │ │ │ │ └── ActionItemUpdateStatusModal.tsx │ │ │ └── ActionItemViewModal/ │ │ │ ├── ActionItemViewModal.module.css │ │ │ ├── ActionItemViewModal.spec.tsx │ │ │ └── ActionItemViewModal.tsx │ │ ├── Auth/ │ │ │ ├── EmailField/ │ │ │ │ ├── EmailField.spec.tsx │ │ │ │ └── EmailField.tsx │ │ │ ├── FormField/ │ │ │ │ ├── FormField.spec.tsx │ │ │ │ └── FormField.tsx │ │ │ └── PasswordField/ │ │ │ ├── PasswordField.spec.tsx │ │ │ └── PasswordField.tsx │ │ ├── Avatar/ │ │ │ ├── Avatar.module.css │ │ │ ├── Avatar.spec.tsx │ │ │ └── Avatar.tsx │ │ ├── BaseModal/ │ │ │ ├── BaseModal.module.css │ │ │ ├── BaseModal.spec.tsx │ │ │ ├── BaseModal.tsx │ │ │ └── index.ts │ │ ├── BreadcrumbsComponent/ │ │ │ ├── BreadcrumbsComponent.spec.tsx │ │ │ ├── BreadcrumbsComponent.tsx │ │ │ ├── SafeBreadcrumbs.spec.tsx │ │ │ ├── SafeBreadcrumbs.tsx │ │ │ └── index.ts │ │ ├── Button/ │ │ │ ├── Button.module.css │ │ │ ├── Button.test.tsx │ │ │ ├── Button.tsx │ │ │ ├── Button.types.ts │ │ │ └── index.ts │ │ ├── CRUDModalTemplate/ │ │ │ ├── CRUDModalTemplate.module.css │ │ │ ├── CRUDModalTemplate.spec.tsx │ │ │ ├── CRUDModalTemplate.tsx │ │ │ ├── CreateModal.stories.spec.tsx │ │ │ ├── CreateModal.stories.tsx │ │ │ ├── CreateModal.tsx │ │ │ ├── DeleteModal.stories.spec.tsx │ │ │ ├── DeleteModal.stories.tsx │ │ │ ├── DeleteModal.tsx │ │ │ ├── EditModal.stories.spec.tsx │ │ │ ├── EditModal.stories.tsx │ │ │ ├── EditModal.tsx │ │ │ ├── ViewModal.stories.spec.tsx │ │ │ ├── ViewModal.stories.tsx │ │ │ ├── ViewModal.tsx │ │ │ ├── hooks/ │ │ │ │ ├── index.ts │ │ │ │ ├── useFormModal.spec.ts │ │ │ │ ├── useFormModal.ts │ │ │ │ ├── useModalState.spec.ts │ │ │ │ ├── useModalState.ts │ │ │ │ ├── useMutationModal.spec.ts │ │ │ │ └── useMutationModal.ts │ │ │ └── index.ts │ │ ├── CheckIn/ │ │ │ ├── CheckInMocks.ts │ │ │ ├── CheckInWrapper.module.css │ │ │ ├── CheckInWrapper.spec.tsx │ │ │ ├── CheckInWrapper.tsx │ │ │ ├── Modal/ │ │ │ │ ├── CheckInModal.module.css │ │ │ │ ├── CheckInModal.spec.tsx │ │ │ │ ├── CheckInModal.tsx │ │ │ │ └── Row/ │ │ │ │ ├── TableRow.module.css │ │ │ │ ├── TableRow.spec.tsx │ │ │ │ └── TableRow.tsx │ │ │ └── tagTemplate.ts │ │ ├── DataGridWrapper/ │ │ │ ├── DataGridErrorOverlay.tsx │ │ │ ├── DataGridLoadingOverlay.spec.tsx │ │ │ ├── DataGridLoadingOverlay.tsx │ │ │ ├── DataGridWrapper.module.css │ │ │ ├── DataGridWrapper.spec.tsx │ │ │ ├── DataGridWrapper.stories.spec.tsx │ │ │ ├── DataGridWrapper.stories.tsx │ │ │ ├── DataGridWrapper.tsx │ │ │ └── index.ts │ │ ├── DataTable/ │ │ │ ├── BulkActionsBar.module.css │ │ │ ├── BulkActionsBar.tsx │ │ │ ├── DataTable.module.css │ │ │ ├── DataTable.pagination.spec.tsx │ │ │ ├── DataTable.spec.tsx │ │ │ ├── DataTable.tsx │ │ │ ├── DataTableShared.module.css │ │ │ ├── DataTableSkeleton.module.css │ │ │ ├── DataTableSkeleton.tsx │ │ │ ├── DataTableTable.module.css │ │ │ ├── DataTableTable.spec.tsx │ │ │ ├── DataTableTable.tsx │ │ │ ├── LoadingMoreRows.module.css │ │ │ ├── LoadingMoreRows.spec.tsx │ │ │ ├── LoadingMoreRows.tsx │ │ │ ├── Pagination.spec.tsx │ │ │ ├── Pagination.tsx │ │ │ ├── SearchBar.module.css │ │ │ ├── SearchBar.spec.tsx │ │ │ ├── SearchBar.tsx │ │ │ ├── TableLoader.module.css │ │ │ ├── TableLoader.spec.tsx │ │ │ ├── TableLoader.tsx │ │ │ ├── cells/ │ │ │ │ ├── ActionsCell.module.css │ │ │ │ ├── ActionsCell.spec.tsx │ │ │ │ └── ActionsCell.tsx │ │ │ ├── hooks/ │ │ │ │ ├── useDataTableFiltering.ts │ │ │ │ ├── useDataTableSelection.spec.tsx │ │ │ │ ├── useDataTableSelection.ts │ │ │ │ ├── useSimpleTableData.spec.tsx │ │ │ │ ├── useSimpleTableData.ts │ │ │ │ ├── useTableData.spec.tsx │ │ │ │ └── useTableData.ts │ │ │ ├── types.spec.ts │ │ │ ├── utils.spec.ts │ │ │ └── utils.ts │ │ ├── DatePicker/ │ │ │ ├── DatePicker.module.css │ │ │ ├── DatePicker.spec.tsx │ │ │ ├── DatePicker.tsx │ │ │ └── index.ts │ │ ├── DateRangePicker/ │ │ │ ├── DateRangePicker.module.css │ │ │ ├── DateRangePicker.spec.tsx │ │ │ ├── DateRangePicker.tsx │ │ │ └── index.ts │ │ ├── DropDownButton/ │ │ │ ├── DropDownButton.mocks.tsx │ │ │ ├── DropDownButton.module.css │ │ │ ├── DropDownButton.spec.tsx │ │ │ ├── DropDownButton.tsx │ │ │ ├── SearchToggle.module.css │ │ │ ├── SearchToggle.spec.tsx │ │ │ ├── SearchToggle.tsx │ │ │ └── index.ts │ │ ├── EmptyState/ │ │ │ ├── EmptyState.spec.tsx │ │ │ ├── EmptyState.tsx │ │ │ └── EmptyStateMocks.ts │ │ ├── ErrorBoundaryWrapper/ │ │ │ ├── ErrorBoundaryWrapper.module.css │ │ │ ├── ErrorBoundaryWrapper.spec.tsx │ │ │ └── ErrorBoundaryWrapper.tsx │ │ ├── ErrorPanel/ │ │ │ ├── ErrorPanel.module.css │ │ │ ├── ErrorPanel.spec.tsx │ │ │ ├── ErrorPanel.tsx │ │ │ └── index.ts │ │ ├── EventForm/ │ │ │ ├── EventForm.module.css │ │ │ ├── EventForm.spec.tsx │ │ │ ├── EventForm.tsx │ │ │ ├── RecurrenceDropdown/ │ │ │ │ ├── RecurrenceDropdown.spec.tsx │ │ │ │ └── RecurrenceDropdown.tsx │ │ │ ├── VisibilitySelector/ │ │ │ │ ├── VisibilitySelector.module.css │ │ │ │ ├── VisibilitySelector.spec.tsx │ │ │ │ └── VisibilitySelector.tsx │ │ │ └── utils/ │ │ │ ├── index.ts │ │ │ ├── recurrenceOptions.spec.ts │ │ │ ├── recurrenceOptions.ts │ │ │ ├── timeUtils.spec.ts │ │ │ ├── timeUtils.ts │ │ │ ├── visibilityUtils.spec.ts │ │ │ └── visibilityUtils.ts │ │ ├── EventListCard/ │ │ │ ├── EventListCard.module.css │ │ │ ├── EventListCard.spec.tsx │ │ │ ├── EventListCard.tsx │ │ │ ├── EventListCardProps.mock.ts │ │ │ ├── EventListCardProps.spec.ts │ │ │ └── Modal/ │ │ │ ├── Delete/ │ │ │ │ ├── EventListCardDeleteModal.module.css │ │ │ │ ├── EventListCardDeleteModal.spec.tsx │ │ │ │ └── EventListCardDeleteModal.tsx │ │ │ ├── EventListCardMocks.ts │ │ │ ├── EventListCardModals.module.css │ │ │ ├── EventListCardModals.spec.tsx │ │ │ ├── EventListCardModals.tsx │ │ │ ├── Preview/ │ │ │ │ ├── EventListCardPreviewModal.module.css │ │ │ │ ├── EventListCardPreviewModal.spec.tsx │ │ │ │ └── EventListCardPreviewModal.tsx │ │ │ ├── updateLogic.spec.ts │ │ │ └── updateLogic.ts │ │ ├── FormFieldGroup/ │ │ │ ├── FormCheckField.spec.tsx │ │ │ ├── FormCheckField.tsx │ │ │ ├── FormFieldGroup.spec.tsx │ │ │ ├── FormFieldGroup.tsx │ │ │ ├── FormSelectField.spec.tsx │ │ │ ├── FormSelectField.tsx │ │ │ └── FormTextField.tsx │ │ ├── InfiniteScrollLoader/ │ │ │ ├── InfiniteScrollLoader.spec.tsx │ │ │ └── InfiniteScrollLoader.tsx │ │ ├── LoadingState/ │ │ │ ├── LoadingState.module.css │ │ │ ├── LoadingState.spec.tsx │ │ │ └── LoadingState.tsx │ │ ├── Navbar/ │ │ │ ├── Navbar.module.css │ │ │ ├── Navbar.spec.tsx │ │ │ └── Navbar.tsx │ │ ├── NotificationToast/ │ │ │ ├── NotificationToast.module.css │ │ │ ├── NotificationToast.spec.tsx │ │ │ └── NotificationToast.tsx │ │ ├── OrganizationCard/ │ │ │ ├── OrganizationCard.module.css │ │ │ ├── OrganizationCard.spec.tsx │ │ │ └── OrganizationCard.tsx │ │ ├── PaginationList/ │ │ │ ├── PaginationList.module.css │ │ │ ├── PaginationList.spec.tsx │ │ │ └── PaginationList.tsx │ │ ├── PeopleTabNavbar/ │ │ │ ├── PeopleTabNavbar.module.css │ │ │ ├── PeopleTabNavbar.spec.tsx │ │ │ └── PeopleTabNavbar.tsx │ │ ├── PeopleTabNavbarButton/ │ │ │ ├── PeopleTabNavbarButton.spec.tsx │ │ │ └── PeopleTabNavbarButton.tsx │ │ ├── PeopleTabUserEvents/ │ │ │ ├── PeopleTabUserEvents.spec.tsx │ │ │ └── PeopleTabUserEvents.tsx │ │ ├── PeopleTabUserOrganization/ │ │ │ ├── PeopleTabUserOrganizations.spec.tsx │ │ │ └── PeopleTabUserOrganizations.tsx │ │ ├── PostViewModal/ │ │ │ ├── PostViewModal.module.css │ │ │ ├── PostViewModal.spec.tsx │ │ │ └── PostViewModal.tsx │ │ ├── ProfileAvatarDisplay/ │ │ │ ├── ProfileAvatarDisplay.module.css │ │ │ ├── ProfileAvatarDisplay.spec.tsx │ │ │ └── ProfileAvatarDisplay.tsx │ │ ├── Recurrence/ │ │ │ ├── CustomRecurrenceModal.spec.tsx │ │ │ ├── CustomRecurrenceModal.tsx │ │ │ ├── RecurrenceEndOptionsSection.module.css │ │ │ ├── RecurrenceEndOptionsSection.spec.tsx │ │ │ ├── RecurrenceEndOptionsSection.tsx │ │ │ ├── RecurrenceFrequencySection.module.css │ │ │ ├── RecurrenceFrequencySection.spec.tsx │ │ │ ├── RecurrenceFrequencySection.tsx │ │ │ ├── RecurrenceMonthlySection.module.css │ │ │ ├── RecurrenceMonthlySection.spec.tsx │ │ │ ├── RecurrenceMonthlySection.tsx │ │ │ ├── RecurrenceWeeklySection.spec.tsx │ │ │ ├── RecurrenceWeeklySection.tsx │ │ │ ├── RecurrenceYearlySection.spec.tsx │ │ │ └── RecurrenceYearlySection.tsx │ │ ├── ReportingTable/ │ │ │ ├── ReportingTable.spec.tsx │ │ │ └── ReportingTable.tsx │ │ ├── SearchBar/ │ │ │ ├── SearchBar.spec.tsx │ │ │ └── SearchBar.tsx │ │ ├── SearchFilterBar/ │ │ │ ├── SearchFilterBar.module.css │ │ │ ├── SearchFilterBar.spec.tsx │ │ │ └── SearchFilterBar.tsx │ │ ├── SharedPicker.module.css │ │ ├── SidebarBase/ │ │ │ ├── SidebarBase.module.css │ │ │ ├── SidebarBase.spec.tsx │ │ │ └── SidebarBase.tsx │ │ ├── SidebarNavItem/ │ │ │ ├── SidebarNavItem.module.css │ │ │ ├── SidebarNavItem.spec.tsx │ │ │ └── SidebarNavItem.tsx │ │ ├── SidebarOrgSection/ │ │ │ ├── SidebarOrgSection.module.css │ │ │ ├── SidebarOrgSection.spec.tsx │ │ │ └── SidebarOrgSection.tsx │ │ ├── SidebarPluginSection/ │ │ │ ├── SidebarPluginSection.module.css │ │ │ ├── SidebarPluginSection.spec.tsx │ │ │ └── SidebarPluginSection.tsx │ │ ├── SortingButton/ │ │ │ ├── SortingButton.module.css │ │ │ ├── SortingButton.spec.tsx │ │ │ └── SortingButton.tsx │ │ ├── StatusBadge/ │ │ │ ├── StatusBadge.module.css │ │ │ ├── StatusBadge.spec.tsx │ │ │ └── StatusBadge.tsx │ │ ├── TableLoader/ │ │ │ ├── TableLoader.module.css │ │ │ ├── TableLoader.spec.tsx │ │ │ └── TableLoader.tsx │ │ ├── TimePicker/ │ │ │ ├── TimePicker.module.css │ │ │ ├── TimePicker.spec.tsx │ │ │ ├── TimePicker.tsx │ │ │ └── index.ts │ │ ├── TruncatedText/ │ │ │ ├── TruncatedText.spec.tsx │ │ │ └── TruncatedText.tsx │ │ ├── VolunteerGroupViewModal/ │ │ │ ├── VolunteerGroupViewModal.module.css │ │ │ ├── VolunteerGroupViewModal.spec.tsx │ │ │ └── VolunteerGroupViewModal.tsx │ │ ├── pinnedPosts/ │ │ │ ├── pinnedPostCard.module.css │ │ │ ├── pinnedPostCard.spec.tsx │ │ │ ├── pinnedPostCard.tsx │ │ │ ├── pinnedPostsLayout.module.css │ │ │ ├── pinnedPostsLayout.spec.tsx │ │ │ └── pinnedPostsLayout.tsx │ │ ├── postCard/ │ │ │ ├── PostCard.module.css │ │ │ ├── PostCard.spec.tsx │ │ │ └── PostCard.tsx │ │ ├── posts/ │ │ │ ├── createPostModal/ │ │ │ │ ├── createPostModal.module.css │ │ │ │ ├── createPostModal.spec.tsx │ │ │ │ └── createPostModal.tsx │ │ │ ├── helperFunctions.ts │ │ │ ├── posts.module.css │ │ │ ├── posts.spec.tsx │ │ │ └── posts.tsx │ │ └── useDebounce/ │ │ ├── useDebounce.spec.ts │ │ └── useDebounce.tsx │ ├── state/ │ │ ├── action-creators/ │ │ │ └── index.ts │ │ ├── helpers/ │ │ │ ├── Action.spec.ts │ │ │ └── Action.ts │ │ ├── hooks.ts │ │ ├── reducers/ │ │ │ ├── index.ts │ │ │ ├── routesReducer.spec.ts │ │ │ ├── routesReducer.ts │ │ │ ├── userRoutersReducer.spec.ts │ │ │ └── userRoutesReducer.ts │ │ ├── store.spec.tsx │ │ └── store.ts │ ├── style/ │ │ ├── app-fixed.module.css │ │ └── tokens/ │ │ ├── borders.css │ │ ├── colors.css │ │ ├── index.css │ │ ├── layout.css │ │ ├── logosizes.css │ │ ├── spacing.css │ │ └── typography.css │ ├── test-utils/ │ │ ├── AsyncComponent.tsx │ │ ├── ComplexLoader.tsx │ │ ├── CustomDashboardLoader.tsx │ │ ├── CustomLoader.tsx │ │ ├── I18nextProviderMock.tsx │ │ ├── MockBrowserRouter.tsx │ │ ├── TestErrorBoundary.tsx │ │ ├── TestWrapper.spec.tsx │ │ ├── TestWrapper.tsx │ │ ├── check-i18n/ │ │ │ ├── check-i18n-basic.test.js │ │ │ ├── check-i18n-diff.test.js │ │ │ ├── check-i18n-enhanced.test.js │ │ │ ├── check-i18n.test-utils.js │ │ │ └── check-i18n.test-utils.spec.js │ │ ├── localStorageMock.spec.ts │ │ ├── localStorageMock.ts │ │ ├── mocks/ │ │ │ ├── react-bootstrap/ │ │ │ │ ├── Dropdown.tsx │ │ │ │ ├── components/ │ │ │ │ │ ├── DropdownBase.tsx │ │ │ │ │ ├── DropdownItem.tsx │ │ │ │ │ ├── DropdownMenu.tsx │ │ │ │ │ └── DropdownToggle.tsx │ │ │ │ └── types.ts │ │ │ └── react-bootstrap.tsx │ │ ├── oauth/ │ │ │ └── oauthProviders.test.ts │ │ ├── validate-tokens-patterns.test.ts │ │ └── validate-tokens.spec.ts │ ├── types/ │ │ ├── AdminPortal/ │ │ │ ├── Advertisement/ │ │ │ │ ├── interface.ts │ │ │ │ └── type.ts │ │ │ ├── Agenda/ │ │ │ │ ├── interface.ts │ │ │ │ └── type.ts │ │ │ ├── ApplyToSelector/ │ │ │ │ └── interface.ts │ │ │ ├── AssignmentTypeSelector/ │ │ │ │ └── interface.ts │ │ │ ├── Contribution/ │ │ │ │ └── interface.ts │ │ │ ├── EventRegistrantsModal/ │ │ │ │ ├── AddOnSpot.ts │ │ │ │ ├── InviteByEmail/ │ │ │ │ │ └── interface.ts │ │ │ │ └── interface.ts │ │ │ ├── EventRegistrantsWrapper/ │ │ │ │ └── interface.ts │ │ │ ├── MemberDetail/ │ │ │ │ └── interface.ts │ │ │ ├── OrgUpdate/ │ │ │ │ └── interface.ts │ │ │ ├── Organization/ │ │ │ │ ├── interface.ts │ │ │ │ └── type.ts │ │ │ ├── OrganizationDashCards/ │ │ │ │ └── CardItem/ │ │ │ │ └── interface.ts │ │ │ ├── OrganizationPeople/ │ │ │ │ └── addMember/ │ │ │ │ └── interface.ts │ │ │ ├── PluginStore/ │ │ │ │ └── UninstallConfirmationModal/ │ │ │ │ └── interface.ts │ │ │ ├── README.md │ │ │ ├── Tag/ │ │ │ │ ├── interface.ts │ │ │ │ └── utils.ts │ │ │ ├── TagActions/ │ │ │ │ └── interface.ts │ │ │ ├── UpdateSession/ │ │ │ │ └── interface.ts │ │ │ ├── UserDetails/ │ │ │ │ ├── UserEvent/ │ │ │ │ │ ├── interface.ts │ │ │ │ │ └── type.ts │ │ │ │ ├── UserOrganization/ │ │ │ │ │ ├── interface.ts │ │ │ │ │ └── type.ts │ │ │ │ └── UserTags/ │ │ │ │ ├── interface.ts │ │ │ │ └── type.ts │ │ │ ├── UserTableRow/ │ │ │ │ └── interface.ts │ │ │ ├── VolunteerDeleteModal/ │ │ │ │ └── interface.ts │ │ │ ├── VolunteerViewModal/ │ │ │ │ └── interface.ts │ │ │ ├── actionItem.ts │ │ │ ├── address.ts │ │ │ ├── membership.ts │ │ │ ├── pagination.ts │ │ │ └── venue.ts │ │ ├── Auth/ │ │ │ ├── LoginForm/ │ │ │ │ └── interface.ts │ │ │ ├── OrgSelector/ │ │ │ │ └── interface.ts │ │ │ ├── PasswordStrengthIndicator/ │ │ │ │ └── interface.ts │ │ │ ├── RegistrationForm/ │ │ │ │ └── interface.ts │ │ │ ├── ValidationInterfaces.ts │ │ │ ├── auth.ts │ │ │ ├── useFieldValidation.ts │ │ │ ├── useLogin/ │ │ │ │ └── interface.ts │ │ │ └── usePasswordVisibility.ts │ │ ├── Comment/ │ │ │ └── type.ts │ │ ├── CursorPagination/ │ │ │ └── interface.ts │ │ ├── DataGridWrapper/ │ │ │ └── interface.ts │ │ ├── DropDown/ │ │ │ └── interface.ts │ │ ├── Event/ │ │ │ ├── interface.ts │ │ │ ├── type.test.ts │ │ │ ├── type.ts │ │ │ └── utils.ts │ │ ├── EventForm/ │ │ │ └── interface.ts │ │ ├── FormFieldGroup/ │ │ │ └── interface.ts │ │ ├── OrganizationCard/ │ │ │ └── interface.ts │ │ ├── PeopleTab/ │ │ │ └── interface.ts │ │ ├── Post/ │ │ │ ├── interface.ts │ │ │ ├── type.spec.ts │ │ │ └── type.ts │ │ ├── Recurrence/ │ │ │ └── interface.ts │ │ ├── ReportingTable/ │ │ │ ├── interface.ts │ │ │ ├── utils.spec.ts │ │ │ └── utils.ts │ │ ├── SearchBar/ │ │ │ ├── interface.ts │ │ │ └── type.ts │ │ ├── SidebarBase/ │ │ │ └── interface.ts │ │ ├── SidebarNavItem/ │ │ │ └── interface.ts │ │ ├── SidebarPluginSection/ │ │ │ └── interface.ts │ │ ├── UseUserProfile.ts │ │ ├── UserPortal/ │ │ │ ├── Chat/ │ │ │ │ └── interface.ts │ │ │ ├── CommentCard/ │ │ │ │ └── interface.ts │ │ │ ├── CreateDirectChat/ │ │ │ │ └── interface.ts │ │ │ ├── Donation/ │ │ │ │ └── interface.ts │ │ │ ├── EmptyChatState/ │ │ │ │ └── interface.ts │ │ │ ├── EventCard/ │ │ │ │ └── interface.ts │ │ │ ├── GroupModal/ │ │ │ │ └── interface.ts │ │ │ ├── README.md │ │ │ ├── RecurringEventVolunteerModal/ │ │ │ │ └── interface.ts │ │ │ ├── UserPortalCard/ │ │ │ │ └── interface.ts │ │ │ ├── UserPortalNavigationBar/ │ │ │ │ ├── interface.ts │ │ │ │ └── types.ts │ │ │ └── UserProfile/ │ │ │ └── interface.ts │ │ ├── Volunteer/ │ │ │ └── interface.ts │ │ ├── docker.ts │ │ ├── jsx.d.ts │ │ └── shared-components/ │ │ ├── ActionItems/ │ │ │ └── interface.ts │ │ ├── ActionsCell/ │ │ │ └── interface.ts │ │ ├── Auth/ │ │ │ ├── EmailField/ │ │ │ │ └── interface.ts │ │ │ ├── FormField/ │ │ │ │ └── interface.ts │ │ │ └── PasswordField/ │ │ │ └── interface.ts │ │ ├── Avatar/ │ │ │ └── interface.ts │ │ ├── BaseModal/ │ │ │ └── interface.ts │ │ ├── BreadcrumbsComponent/ │ │ │ └── interface.ts │ │ ├── BulkActionsBar/ │ │ │ └── interface.ts │ │ ├── CRUDModalTemplate/ │ │ │ └── interface.ts │ │ ├── CheckIn/ │ │ │ ├── interface.ts │ │ │ └── type.ts │ │ ├── CheckInWrapper/ │ │ │ └── interface.ts │ │ ├── DataTable/ │ │ │ ├── column.ts │ │ │ ├── hooks.ts │ │ │ ├── interface.ts │ │ │ ├── pagination.ts │ │ │ ├── props.ts │ │ │ └── types.ts │ │ ├── DatePicker/ │ │ │ └── interface.ts │ │ ├── DateRangePicker/ │ │ │ ├── index.ts │ │ │ └── interface.ts │ │ ├── DropDownButton/ │ │ │ └── interface.ts │ │ ├── EmptyState/ │ │ │ └── interface.ts │ │ ├── ErrorBoundaryWrapper/ │ │ │ └── interface.ts │ │ ├── EventListCard/ │ │ │ └── interface.ts │ │ ├── FormFieldGroup/ │ │ │ └── interface.ts │ │ ├── LoadingState/ │ │ │ └── interface.ts │ │ ├── Navbar/ │ │ │ └── interface.ts │ │ ├── NotificationToast/ │ │ │ └── interface.ts │ │ ├── PaginationList/ │ │ │ └── interface.ts │ │ ├── PeopleTabNavbar/ │ │ │ └── interface.ts │ │ ├── PluginRouteRenderer/ │ │ │ └── interface.ts │ │ ├── PluginRoutes/ │ │ │ └── interface.ts │ │ ├── PostViewModal/ │ │ │ └── interface.ts │ │ ├── ProfileAvatarDisplay/ │ │ │ └── interface.ts │ │ ├── ProfileCard/ │ │ │ └── interface.ts │ │ ├── ProfileDropdown/ │ │ │ └── interface.ts │ │ ├── README.md │ │ ├── Recurrence/ │ │ │ └── interface.ts │ │ ├── RecurrenceDropdown/ │ │ │ └── interface.ts │ │ ├── SearchFilterBar/ │ │ │ └── interface.ts │ │ ├── SidebarOrgSection/ │ │ │ └── interface.ts │ │ ├── SortingButton/ │ │ │ └── interface.ts │ │ ├── StatusBadge/ │ │ │ └── interface.ts │ │ ├── TableLoader/ │ │ │ └── interface.ts │ │ ├── TimePicker/ │ │ │ └── interface.ts │ │ ├── TruncatedText/ │ │ │ └── interface.ts │ │ ├── User/ │ │ │ ├── interface.ts │ │ │ └── type.ts │ │ ├── VisibilitySelector/ │ │ │ └── interface.ts │ │ └── VolunteerGroupViewModal/ │ │ └── interface.ts │ ├── utils/ │ │ ├── MinioDownload.spec.ts │ │ ├── MinioDownload.ts │ │ ├── MinioUpload.spec.tsx │ │ ├── MinioUpload.ts │ │ ├── SanitizeInput.spec.tsx │ │ ├── SanitizeInput.tsx │ │ ├── StaticMockLink.spec.ts │ │ ├── StaticMockLink.ts │ │ ├── adminPluginInstaller.spec.ts │ │ ├── adminPluginInstaller.ts │ │ ├── autocompleteHelpers.ts │ │ ├── chartToPdf.spec.ts │ │ ├── chartToPdf.ts │ │ ├── currency.ts │ │ ├── dateFormatter.spec.ts │ │ ├── dateFormatter.ts │ │ ├── errorHandler.spec.tsx │ │ ├── errorHandler.tsx │ │ ├── fieldTypes.spec.ts │ │ ├── fieldTypes.ts │ │ ├── fileValidation.spec.ts │ │ ├── fileValidation.ts │ │ ├── filehash.spec.ts │ │ ├── filehash.ts │ │ ├── formEnumFields.ts │ │ ├── getRefreshToken.spec.ts │ │ ├── getRefreshToken.ts │ │ ├── i18n.ts │ │ ├── i18nForTest.ts │ │ ├── interfaces.spec.ts │ │ ├── interfaces.ts │ │ ├── languages.ts │ │ ├── linkValid.spec.tsx │ │ ├── linkValidator.ts │ │ ├── oauth/ │ │ │ ├── oauthFlowHandler.test.ts │ │ │ └── oauthFlowHandler.ts │ │ ├── organizationTagsUtils.ts │ │ ├── passwordValidator.spec.ts │ │ ├── passwordValidator.ts │ │ ├── profileNavigation.spec.ts │ │ ├── profileNavigation.ts │ │ ├── recaptcha.test.ts │ │ ├── recaptcha.ts │ │ ├── recurrenceUtils/ │ │ │ ├── index.ts │ │ │ ├── recurrenceConstants.ts │ │ │ ├── recurrenceTypes.ts │ │ │ ├── recurrenceUtilityFunctions.ts │ │ │ └── recurrenceUtils.spec.ts │ │ ├── sanitizeAvatar.spec.ts │ │ ├── sanitizeAvatar.ts │ │ ├── testConstants.ts │ │ ├── timezoneUtils/ │ │ │ ├── dateTimeConfig.ts │ │ │ ├── dateTimeMiddleware.spec.ts │ │ │ ├── dateTimeMiddleware.ts │ │ │ └── index.ts │ │ ├── tokenValues.spec.ts │ │ ├── tokenValues.ts │ │ ├── urlToFile.spec.ts │ │ ├── urlToFile.ts │ │ ├── useLocalstorage.spec.ts │ │ ├── useLocalstorage.ts │ │ ├── useSession.spec.tsx │ │ ├── useSession.tsx │ │ ├── userUpdateUtils.spec.ts │ │ ├── userUpdateUtils.ts │ │ ├── validators/ │ │ │ ├── authValidators.spec.ts │ │ │ └── authValidators.ts │ │ ├── volunteerStatusMapper.spec.ts │ │ └── volunteerStatusMapper.ts │ └── vite-env.d.ts ├── tsconfig.docs.json ├── tsconfig.json ├── typedoc.json ├── vitest.config.ts └── vitest.setup.ts ================================================ FILE CONTENTS ================================================ ================================================ FILE: .coderabbit/ast-grep-rules/assertions-must-use-waitfor.yml ================================================ id: assertions-after-async-must-use-waitfor language: typescript rule: follows: stopBy: end pattern: await userEvent.$METHOD($$$) regex: "expect\\(" not: inside: any: - pattern: waitFor(() => { $$$ }) - pattern: waitFor(async () => { $$$ }) - pattern: waitFor(() => $$$) message: 'Assertion after async operation must be inside waitFor' severity: error ================================================ FILE: .coderabbit/ast-grep-rules/hardcoded-timeout.yml ================================================ id: hardcoded-timeout-in-tests language: typescript rule: any: - pattern: setTimeout($_, $NUM) - pattern: await wait($NUM) - pattern: delay($NUM) inside: kind: function_declaration has: field: name regex: '^(it|test|describe)' message: 'Hardcoded timeout in test - use waitFor with assertions instead' severity: error ================================================ FILE: .coderabbit/ast-grep-rules/mutation-null-guards.yml ================================================ id: mutation-null-guard-check language: typescript rule: any: - pattern: | await $MUTATION({ variables: { $$$ id: $VAR?.$PROP $$$ } }) - pattern: | await $MUTATION({ variables: { $$$ $KEY: $VAR?.$PROP $$$ } }) not: precedes: # ← Changed from 'follows' pattern: | if (!$VAR?.$PROP) return; message: 'Missing null guard for optional property in mutation variables' severity: error ================================================ FILE: .coderabbit/ast-grep-rules/no-dynamic-timestamps-in-tests.yml ================================================ id: no-dynamic-timestamps-in-tests language: typescript files: '**/*.{spec,test}.{ts,tsx}' rule: any: - pattern: dayjs() - pattern: moment() - pattern: DateTime.now() - pattern: new Date() - pattern: Date.now() message: 'Non-deterministic timestamp in test - use fixed UTC string' severity: error ================================================ FILE: .coderabbit/ast-grep-rules/no-local-timezone-in-tests.yml ================================================ id: no-local-timezone-in-tests language: TypeScript severity: error message: | Avoid using local timezone date methods in tests. Use UTC methods instead: - Use .getUTCDate() instead of .getDate() - Use .getUTCMonth() instead of .getMonth() - Use .getUTCDay() instead of .getDay() - Use .getUTCHours() instead of .getHours() - Use .getUTCMinutes() instead of .getMinutes() - Use .getUTCSeconds() instead of .getSeconds() These local timezone methods cause flakiness in sharded CI environments where machines may have different timezone configurations. note: 'Timezone-dependent test assertion detected' rule: any: - pattern: $DATE.getDate() - pattern: $DATE.getMonth() - pattern: $DATE.getDay() - pattern: $DATE.getHours() - pattern: $DATE.getMinutes() - pattern: $DATE.getSeconds() - pattern: $DATE.getFullYear() files: - '**/*.test.ts' - '**/*.test.tsx' - '**/*.spec.ts' - '**/*.spec.tsx' fix: | # Manual fix required - replace with UTC equivalent: # .getDate() → .getUTCDate() # .getMonth() → .getUTCMonth() # .getDay() → .getUTCDay() # .getHours() → .getUTCHours() # .getMinutes() → .getUTCMinutes() # .getSeconds() → .getUTCSeconds() # .getFullYear() → .getUTCFullYear() ================================================ FILE: .coderabbit/ast-grep-rules/vitest-cleanup.yml ================================================ id: enforce-restore-all-mocks language: typescript rule: pattern: vi.clearAllMocks() kind: call_expression message: | ⚠️ INCOMPLETE CLEANUP - Use vi.restoreAllMocks() instead of vi.clearAllMocks() vi.clearAllMocks() only clears call history but keeps mock implementations. vi.restoreAllMocks() restores original implementations AND clears history. Required in sharded tests to prevent cross-test contamination. severity: error note: 'Change to: vi.restoreAllMocks()' fix: 'vi.restoreAllMocks()' ================================================ FILE: .coderabbit.yaml ================================================ # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json # Configuration Metadata # Version: 2.0 # Last Updated: 2026-01-08 # Purpose: Comprehensive review validation with reusable component architecture enforcement language: 'en-US' early_access: false chat: auto_reply: true issue_enrichment: auto_enrich: enabled: false # ADVISORY GUIDELINES (Guides the AI reviewer during manual reviews) reviews: profile: 'assertive' poem: false request_changes_workflow: false high_level_summary: true review_status: true review_details: false collapse_walkthrough: false auto_apply_labels: false suggested_labels: false assess_linked_issues: true auto_review: enabled: true drafts: false base_branches: - develop - main path_filters: - '!**/docs/docs/**' - '!*.html' - '!*.md' - '!*.svg' tools: ast-grep: enabled: true rule_dirs: - .coderabbit/ast-grep-rules essential_rules: true # Keep instructions concise and scoped by file patterns to stay far under limits path_instructions: # 1) Tests — Vitest + RTL + sharded stability - path: '**/*.{spec,test}.{ts,tsx}' instructions: | ═══════════════════════════════════════════════════════════════ 🚨 ANTI-PATTERNS TO FLAG IMMEDIATELY (Search for these first): ═══════════════════════════════════════════════════════════════ 1. PATTERN: vi.clearAllMocks() anywhere in test file FLAG AS: "❌ BLOCKING - Use vi.restoreAllMocks() at file:line" WHY: Incomplete cleanup causes sharded test failures 2. PATTERN: afterEach without both cleanup() AND vi.restoreAllMocks() FLAG AS: "❌ BLOCKING - Missing required cleanup at file:line" 3. PATTERN: setTimeout or hardcoded delays FLAG AS: "⚠️ RACE CONDITION - Replace with waitFor at file:line" 4. PATTERN: .catch(() => {}) without re-throw or assertion FLAG AS: "❌ SILENT ERROR - Add fallback assertion at file:line" 5. PATTERN: dayjs(), moment(), DateTime.now(), or new Date() without arguments in test data FLAG AS: "❌ BLOCKING - Non-deterministic timestamp at file:line - Use fixed UTC string" WHY: Captures current time, causes flakiness in sharded CI 6. PATTERN: expect(...) after await userEvent or await waitFor, not inside waitFor FLAG AS: "❌ BLOCKING - Race condition at file:line - Move assertion inside waitFor" WHY: State changes may not propagate before assertion runs ═══════════════════════════════════════════════════════════════ Post a single, structured comment with these sections: Issue Goals, Tests (incl. Flakiness), Components/Policy, GraphQL, i18n & a11y, Security, Action Items. Reference exact file:line for each finding. Issue goals (Priority `#1`): - Parse the first PR comment for "Fixes/Closes/Resolves #". Confirm every acceptance criterion is tested; list gaps with file:line. Timezone Safety & Test Determinism (CRITICAL): - REQUIRED: Use UTC date methods in all test assertions: - ✅ Use: `.getUTCDate()`, `.getUTCMonth()`, `.getUTCDay()`, `.getUTCHours()`, `.getUTCMinutes()`, `.getUTCSeconds()` - ❌ NEVER use: `.getDate()`, `.getMonth()`, `.getDay()`, `.getHours()`, `.getMinutes()`, `.getSeconds()` - All test dates must use fixed UTC timestamps (e.g., `"2025-01-01T10:00:00Z"`) - ❌ FORBIDDEN PATTERNS (capture current time): - `dayjs()` without arguments (use `dayjs('2025-01-01T10:00:00Z')`) - `moment()` without arguments (use `moment('2025-01-01T10:00:00Z')`) - `DateTime.now()` (luxon) (use `DateTime.fromISO('2025-01-01T10:00:00Z')`) - `new Date()` without arguments (use `new Date('2025-01-01T10:00:00.000Z')`) - `Date.now()` (use fixed timestamp number or mock timers) - Pattern to flag: `(dayjs|moment|DateTime\.now|new Date)\(\s*\)` in test data/mocks - Report as "🔴 NON-DETERMINISTIC TIMESTAMP at file:line — Replace with fixed UTC string" - Flag ANY usage of local timezone methods as CRITICAL - these cause CI flakiness in non-UTC environments Test quality (Vitest + RTL): - Use vi.mock; prefer accessible queries (getByRole/LabelText); use user-event. - Cover success, error (network/GraphQL/validation), edge/empty states, loading, and user interactions. - List uncovered line numbers in changed source files. Flaky test guard (12 shards) — CRITICAL PATTERNS: # MANDATORY CHECKLIST - Flag violations as BLOCKING ## 1. Cleanup (CRITICAL for sharded CI) [ ] afterEach contains cleanup() from `@testing-library/react` [ ] afterEach contains vi.restoreAllMocks() (NOT vi.clearAllMocks()) [ ] localStorage/sessionStorage cleared if used [ ] window state reset if modified ⚠️ FLAG: "INCOMPLETE CLEANUP at file:line - Missing vi.restoreAllMocks()" ⚠️ FLAG: "INCORRECT CLEANUP at file:line - Uses vi.clearAllMocks() instead of vi.restoreAllMocks()" RATIONALE: vi.clearAllMocks() only clears call history but keeps mock implementations. vi.restoreAllMocks() restores originals AND clears history. This prevents mock leakage between tests in parallel shards. # ENHANCED: More specific delay detection Hardcoded delays (ABSOLUTELY FORBIDDEN): - ❌ NEVER use: setTimeout, setInterval, delay(), sleep(), wait() helpers with fixed durations - ❌ Pattern to flag: "await wait(", "setTimeout(", "delay(" - ✅ ONLY use: waitFor(() => expect(...), { timeout: ... }) with explicit assertions - Report as "🔴 HARDCODED DELAY at file:line — Replace with waitFor assertion" - Exception: Only allow setTimeout in beforeEach/afterEach for test infrastructure setup (must have comment explaining why) Assertion placement (MANDATORY): - ALL assertions after async operations MUST be inside waitFor blocks. - Patterns to flag as BLOCKING: ❌ await userEvent.type(...); expect(...).toBeInTheDocument(); ❌ await waitFor(() => ...); expect(mockFn).toHaveBeenCalled(); ❌ fireEvent.click(...); expect(...).toHaveAttribute(...); ✅ await userEvent.type(...); await waitFor(() => expect(...).toBeInTheDocument()); - Specific patterns to search: * `expect\([^)]+\)\.(toHaveBeenCalled|toBeInTheDocument|toHaveAttribute)` NOT inside `waitFor\(` * Any `expect(` within 3 lines after `await userEvent.` or `fireEvent.` that's NOT in `waitFor` - Report as "🔴 RACE CONDITION at file:line — Assertion outside waitFor block after async operation" - Exception: Assertions before any async operations in test case are safe. Async patterns (NO RACE CONDITIONS): - NO hardcoded setTimeout or fixed delays; use waitFor with explicit assertions. - After clicking elements that open UI (dropdowns, modals, dialogs, tooltips): MUST waitFor the container/menu itself to be visible BEFORE checking child elements. Example: await user.click(toggle); await waitFor(() => expect(menu).toBeInTheDocument()); - After clicking elements that close UI: MUST waitFor close completion (aria-expanded="false" or element removed) BEFORE re-opening. Example: await waitFor(() => expect(toggle).toHaveAttribute('aria-expanded', 'false')); - In loops testing multiple UI states: re-open → wait for open → interact → wait for result → wait for close. No shortcuts. - ALL user-event clicks/types must be awaited; check that state changes are awaited with waitFor. Error handling (NO SILENT FAILURES): - NO .catch() blocks that swallow errors without re-throwing or explicit fallback assertions. - If .catch() is used, must have a comment explaining why + alternative assertion inside catch. - Prefer try/catch with explicit expect() in catch block over silent .catch(() => {}). Timer interactions (AVOID CONFLICTS): - If global vi.useFakeTimers() is active (check setupTests), check for conflicts with: * `@testing-library/user-event` async operations * waitFor timeouts * UI animations (dropdowns, modals, transitions) - Consider vi.useRealTimers() in beforeEach for tests with heavy user interaction. - Flag any test using both fake timers AND user-event without explicit timer management. DataTable-specific testing (CRITICAL for this codebase): - After finding datatable container (findByTestId('datatable')), MUST waitFor rows to populate: ❌ BAD: await screen.findByTestId('datatable'); const rows = getDataTableBodyRows(); ✅ GOOD: await screen.findByTestId('datatable'); await waitFor(() => expect(getDataTableBodyRows()).toHaveLength(N)); - DataTable shows skeleton first, then data asynchronously — tests MUST wait for transition. - Report as "⚠️ DATATABLE RACE CONDITION at file:line — Not waiting for rows after container". Double network requests (AVOID): - Flag if a handler (onClick, onChange) calls refetch() AND a useEffect also refetches with same dependency. - Example: handleChangeRowsPerPage calls refetch(...rowsPerPage...) BUT useEffect([rowsPerPage]) also refetches. - Report as "⚠️ DOUBLE REFETCH at file:line — Both handler and useEffect refetch on same state change". I18n Provider Requirement: - All component tests MUST wrap with I18nextProvider for consistent translation behavior - ❌ Relying on key fallbacks causes brittle tests that break on i18n changes - ✅ Wrap all renders: ```typescript import { I18nextProvider } from 'react-i18next'; import i18nForTest from 'utils/i18nForTest'; render( ); ``` - Detection: If test file imports a component that uses `useTranslation()` or `t()`, verify I18nextProvider is present Fake Timers for Debounce/Throttle Testing: - ❌ When testing debounced/throttled logic (search inputs, auto-save, etc.), NEVER use real waits - ✅ REQUIRE: `vi.useFakeTimers()` + `vi.advanceTimersByTime()` pattern - **Detection:** - If test involves "search" or "debounce" in description/comments - AND contains `wait()` or `setTimeout()` - Flag: "Use fake timers to control time progression deterministically" - Cleanup: - Every `vi.useFakeTimers()` must have corresponding `vi.useRealTimers()` in: * Same test block (try/finally) * afterEach hook * Never leave fake timers active between tests Avoid Testing Implementation Details: - ❌ Do not assert on internal constants, magic numbers, or implementation specifics: ```typescript // Brittle - breaks on refactors: expect(PAGE_SIZE).toBe(10); expect(DEBOUNCE_MS).toBe(300); expect(component.state.internalCounter).toBe(5); ``` - ✅ Assert observable behavior instead: ```typescript // Robust - tests actual behavior: expect(mockRequest.variables.first).toBeGreaterThan(0); expect(mockRequest).toHaveBeenCalledWith(expect.objectContaining({ variables: expect.objectContaining({ first: expect.any(Number) }) })); ``` - Detection: - Flag `expect(CONSTANT_NAME).toBe(...)` patterns - Suggest: "Test behavior, not constants. Assert what the component does, not how." Global State & Window/DOM Pollution: - ❌ CRITICAL: Any modification to global objects MUST be restored in teardown: ```typescript // These cause cross-test pollution: window.location = { ... }; window.localStorage.setItem(...); process.env.NODE_ENV = 'test'; global.fetch = mockFetch; document.body.innerHTML = '...'; ``` - ✅ REQUIRE: Save original and restore: ```typescript let originalLocation: Location; beforeEach(() => { originalLocation = window.location; }); afterEach(() => { window.location = originalLocation; }); ``` - Detection Pattern: - Search for: `window.location =`, `window.* =`, `global.* =`, `process.env.* =` - Verify corresponding save/restore in beforeEach/afterEach - Flag missing restoration as CRITICAL for sharded CI Anti-Pattern: Fixed Waits/Sleeps (CRITICAL for CI Flakiness): - ❌ CRITICAL: Flag ANY usage of fixed time delays in tests: ```typescript // These cause flakiness in variable-latency CI: await wait(200); await wait(1000); await sleep(500); setTimeout(..., 1000); await new Promise(resolve => setTimeout(resolve, 500)); ``` - ✅ REQUIRE: Condition-based async queries instead: ```typescript // Use findBy* (waits up to 1s by default): const element = await screen.findByTestId('datatable'); // Or waitFor with condition: await waitFor(() => expect(mockFn).toHaveBeenCalled()); // For debounce/throttle, use fake timers: vi.useFakeTimers(); await userEvent.type(input, 'search'); vi.advanceTimersByTime(300); // DEBOUNCE_MS await waitFor(() => expect(refetch).toHaveBeenCalled()); vi.useRealTimers(); ``` - Detection Pattern: - Search for: `wait(`, `sleep(`, `setTimeout(`, `new Promise.*setTimeout` - Exceptions: `waitFor(`, `findBy`, `findAllBy` (these are good) - Flag every fixed-time wait as HIGH PRIORITY for refactoring - Why This Matters: - Fixed waits assume consistent response times - CI sharding introduces variable latency - Root cause of most test flakiness in distributed environments Structure: - No it.skip/describe.skip unless commented with reason + linked issue. - Wrap state updates in act() when needed. REPORT FORMAT for flakiness issues: - "⚠️ RACE CONDITION at file:line — [description]" - "❌ SILENT ERROR SWALLOW at file:line — .catch() without fallback" - "⏱️ TIMER CONFLICT at file:line — fake timers + user-event" # React components/screens/pages — enforce architecture & policy - path: 'src/{components,screens,pages}/**/*.{ts,tsx}' instructions: | Post a single, structured comment; reference file:line for each item. If the file is a test (*.spec|*.test), apply the test checklist instead and skip this block. Issue goals: - Map changes to the linked issue’s acceptance criteria; flag unaddressed or out‑of‑scope work. ## Screen-specific: DataTable + useTableData Pattern (TableFix Migration) **Applies only to files in src/screens/** that import DataTable:** - All table-based screens migrating to DataTable MUST use useTableData hook: - ❌ Do not use `useQuery` + manual `useMemo` for data transformation: ```typescript // Incorrect: const { data } = useQuery(QUERY); const rows = useMemo(() => data?.items ?? [], [data]); ``` - ✅ Use useTableData wrapper: ```typescript // Correct: const { rows, loading, error, refetch } = useTableData( useQuery(QUERY, { variables }), { path: (data) => data?.items ?? [] } ); ``` - **Detection:** - If file path starts with `src/screens/` - AND imports DataTable from shared-components - AND imports useQuery from `@apollo/client` - BUT does NOT import useTableData - Flag: "Screens using DataTable should integrate with useTableData hook per migration standards" Reusable component policy (see: https://docs-admin.talawa.io/docs/developer-resources/reusable-components/): - Placement: Admin-only → src/components/AdminPortal/** (+ src/types/AdminPortal/**); User-only → src/components/UserPortal/** (+ src/types/UserPortal/**); Shared → src/shared-components/** (+ src/types/shared-components/**). - Naming: PascalCase folder/file/component; names must match. - Props: NO inline prop interfaces; define in src/types///interface.ts (e.g., InterfaceProps). - Restricted imports: use shared wrappers (DataGridWrapper, LoadingState, BaseModal, Date/Time pickers, etc.); direct imports allowed only inside wrappers. - Brief TSDoc on exported components and interfaces. TypeScript & React: - No any without JSDoc justification; strong types for props/params/returns/state/GQL types. - Hooks: proper cleanup in useEffect; avoid prop drilling (use Context/Redux). - MUI v7: import from `@mui/material`; styling via `@emotion/react`. i18n & a11y: - No hardcoded UI strings; use useTranslation with keys; add new keys to all 5 locales (en, es, fr, hi, zh). - Ensure roles/ARIA (aria-label/aria-describedby/aria-live), keyboard navigation, and semantic markup. # NEW: Null safety in mutations Null guard enforcement (CRITICAL for GraphQL mutations): - When calling mutations with variables containing optional properties (fund?.id, user?.id, etc.): MUST add null guard BEFORE the mutation call. - Pattern to flag: "variables.*: \{\s*id: \w+\?\.\w+" without preceding "if (!...?.id) return;" - Valid pattern: ✅ if (!fund?.id) return; await deleteFund({ variables: { id: fund.id } }); ❌ await deleteFund({ variables: { id: fund?.id } }); - Report as "🔴 MISSING NULL GUARD at file:line — Add null check before mutation with optional property" - Apply to all mutation calls: create*, update*, delete*, archive*, etc. # GraphQL operations - path: 'src/GraphQl/**/*.ts' instructions: | Post a single, structured comment; reference file:line. Organization & typing: - Queries in src/GraphQl/Queries/; mutations in src/GraphQl/Mutations/. - Use gql (graphql-tag) with typed variables/results; add brief JSDoc. Correctness & duplication: - No duplicate or conflicting operations; watch pagination params (first/last). - Components using these operations must handle loading and error states in UI. Schema compliance (CRITICAL): - For each mutation/query, verify ALL input fields in the schema are used by components. - For each component form, verify ALL form fields are sent in the mutation variables. - Flag any form field (input, select, checkbox) NOT present in the mutation schema. - Report as "🔴 SCHEMA MISMATCH at file:line — Field '' in form but not in mutation schema" - Flag any mutation accepting field X but component doesn't provide it. - Report as "⚠️ MISSING FIELD at file:line — Mutation expects '' but component doesn't send it" Query completeness (CRITICAL): - For each GraphQL query, trace ALL components that use the query data. - For each field accessed in component code (e.g., `event.fieldName`, `data.queryName[0].fieldName`): MUST verify the field is fetched in the query. - Common patterns to check: * Object property access: `data.events.map(e => e.fieldName)` * Destructuring: `const { fieldName } = event;` * Optional chaining: `event?.fieldName` - Flag if component accesses a field NOT in the query selection set. - Report as "🔴 MISSING QUERY FIELD at file:line — Component uses 'fieldName' but query doesn't fetch it" - Example violation: ❌ Query: `{ id name }` but Component: `event.isRecurringEventTemplate` ✅ Query: `{ id name isRecurringEventTemplate }` - Check both direct usage and passed to child components as props. - path: '**/*.module.css' instructions: | Post a single, structured comment; reference file:line. Design token usage: - Use CSS variables from design tokens (var(--space-*, --color-*, --radius-*, etc.)) - No hardcoded pixel values for spacing, colors, shadows, or border-radius - Flag any hardcoded values that could be tokens !important consistency (CRITICAL): - If a base selector uses !important for a property, ALL state selectors (:hover, :active, :focus, :disabled) must also use !important for that property - Pattern to flag: ❌ .btn { color: red !important; } .btn:hover { color: blue; } /* Missing !important */ ✅ .btn { color: red !important; } .btn:hover { color: blue !important; } - Report as "🔴 CSS SPECIFICITY BUG at file:line — :state selector missing !important when base has it" - Check properties: color, background, background-color, border, box-shadow, opacity BEM/Module naming: - Use camelCase for module class names - Keep selectors flat; avoid deep nesting - Use :global() sparingly and document why pre_merge_checks: # Enforce test file updates for modified source files custom_checks: - name: 'Test Coverage Gate' mode: 'error' instructions: | BLOCKING: Test coverage must be ≥95% for modified files. Run: pnpm run test:coverage Verify: coverage/coverage-summary.json shows no files below threshold. - name: 'TypeScript Compilation' mode: 'error' instructions: | BLOCKING: Zero TypeScript errors. Run: pnpm run typecheck Must pass without errors or warnings. - name: 'Component Architecture Compliance' mode: 'error' instructions: | BLOCKING: All components follow reusable component policy. Verify: No inline interfaces, correct portal placement, wrapper usage. See: https://docs-admin.talawa.io/docs/developer-resources/reusable-components/ - name: 'i18n Key Completeness' mode: 'error' instructions: | BLOCKING: All translation keys must exist in ALL 5 locales. For each t('key') or tCommon('key') usage: 1. Extract the key name 2. Verify it exists in public/locales/{en,es,fr,hi,zh}/translation.json 3. Flag if missing from ANY locale Common patterns to check: - t('namespace.key') - tCommon('key') - useTranslation hook with namespace Report format: - "🔴 MISSING i18n KEY at file:line — 'key' not found in locales: [es, fr]" - "🔴 NAMESPACE MISMATCH at file:line — Using 'common.required' but should be 'validation.required'" Must check all 5 locales: - public/locales/{en,es,fr,hi,zh}/translation.json - public/locales/{en,es,fr,hi,zh}/common.json - public/locales/{en,es,fr,hi,zh}/errors.json ================================================ FILE: .dockerignore ================================================ node_modules npm-debug.log Dockerfile .git .gitignore .env .env.* dist coverage .nyc_output *.md .github tests __tests__ *.test.* *.spec.* # Development files *.log *.lock .DS_Store .idea .vscode # Build artifacts build out # Python venv ================================================ FILE: .flake8 ================================================ [flake8] ignore = E402,E722,E203,F401,W503 max-line-length = 80 ================================================ FILE: .github/FUNDING.yml ================================================ # These are supported funding model platforms github: [palisadoes] patreon: # Replace with a single Patreon username open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry liberapay: # Replace with a single Liberapay username issuehunt: PalisadoesFoundation/talawa-api otechie: # Replace with a single Otechie username custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] ================================================ FILE: .github/ISSUE_TEMPLATE/bug-report.md ================================================ --- name: Bug Report about: Create a report to help us improve. title: Bug Report labels: bug assignees: '' --- **Describe the bug** A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: 1. 2. 3. 4. **Expected behavior** A clear and concise description of what you expected to happen. **Actual behavior** A clear and concise description of how the code performed w.r.t expectations. **Screenshots** If applicable, add screenshots to help explain your problem. **Additional details** Add any other context or screenshots about the feature request here. ================================================ FILE: .github/ISSUE_TEMPLATE/feature-request.md ================================================ --- name: Feature Request about: Suggest an idea for this project title: Feature Request labels: feature request assignees: '' --- **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. **Describe the solution you'd like** A clear and concise description of what you want to happen. **Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered. **Approach to be followed (optional)** A clear and concise description of approach to be followed. **Additional context** Add any other context or screenshots about the feature request here. ================================================ FILE: .github/dependabot.yaml ================================================ # Configuration for automated dependency updates using Dependabot version: 2 updates: # Define the target package ecosystem - package-ecosystem: 'npm' # Specify the root directory directory: '/' # Schedule automated updates schedule: interval: 'cron' cronjob: '0 0 1 * *' # Labels to apply to Dependabot PRs labels: - 'dependencies' # Specify the target branch for PRs target-branch: 'develop' # Customize commit message prefix commit-message: prefix: 'chore(deps):' ================================================ FILE: .github/pull_request_template.md ================================================ **What kind of change does this PR introduce?** **Issue Number:** Fixes # **Snapshots/Videos:** **If relevant, did you update the documentation?** **Summary** **Does this PR introduce a breaking change?** ## Checklist ### CodeRabbit AI Review - [ ] I have reviewed and addressed all critical issues flagged by CodeRabbit AI - [ ] I have implemented or provided justification for each non-critical suggestion - [ ] I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented ### Test Coverage - [ ] I have written tests for all new changes/features - [ ] I have verified that test coverage meets or exceeds 95% - [ ] I have run the test suite locally and all tests pass **Other information** **Have you read the [contributing guide](https://github.com/PalisadoesFoundation/talawa-admin/blob/master/CONTRIBUTING.md)?** ================================================ FILE: .github/workflows/README.md ================================================ # Talawa GitHub Workflows Guidelines Follow these guidelines when contributing to this directory. ## General Any changes to files in this directory are flagged when pull requests are run. Make changes only on the advice of a contributor. ## YAML Workflow Files The YAML files in this directory have very specific roles depending on the type of workflow. Whenever possible you must ensure that: 1. The file roles below are maintained 1. 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). ### File Roles Follow these guidelines when creating new YAML defined GitHub actions. This is done to make troubleshooting easier. 1. `Issue` Workflows: 1. Place all actions related to issues in the `issues.yml` file. 1. `issue-assigned.yml` - Removes unapproved labels when issues are assigned to contributors (exception; see “File Role Exceptions”). 1. `Pull Request` workflows to be run by: 1. Workflows to run **First Time** repo contributors: 1. Place all actions related to to this in the `pull-request-target.yml` file. 1. Workflows to be run by **ALL** repo contributors: 1. Place all actions related to pull requests in the `pull-request.yml` file. 1. `Push` workflows: 1. Place all actions related to pushes in the `push.yml` file. #### File Role Exceptions There are some exceptions to these rules in which jobs can be placed in dedicated separate files: 1. Jobs that require unique `cron:` schedules 1. Jobs that require unique `paths:` statements that operate only when files in a specific path are updated. 1. Jobs only work correctly if they have a dedicated file (eg. `CodeQL`) 1. 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`) ## Scripts Follow these guidelines when creating or modifying scripts in this directory. 1. All scripts in this directory must be written in python3 for consistency. 1. 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. 1. Pycodestyle 1. Pydocstyle 1. Pylint 1. Flake8 1. All scripts must run a main() function. ================================================ FILE: .github/workflows/auto-assign.yml ================================================ name: Auto Assign & Unassign (Org-wide Limit) on: issue_comment: types: [created] jobs: handle-comment: uses: PalisadoesFoundation/.github/.github/workflows/auto-assign.yml@main secrets: ORG_ACCESS_TOKEN: ${{ secrets.ORG_ACCESS_TOKEN }} ================================================ FILE: .github/workflows/auto-label.json5 ================================================ { labelsSynonyms: { 'ci/cd': ['.github', 'Workflow', 'ci/cd'], dependencies: [ 'dependabot', 'dependency', 'dependencies', 'package', 'packages', ], security: ['security'], 'ui/ux': ['layout', 'screen', 'design', 'figma'], }, defaultLabels: ['unapproved'], } ================================================ FILE: .github/workflows/check-tsdoc.js ================================================ import fs from 'fs/promises'; // Import fs.promises for async operations import path from 'path'; // List of files to skip const filesToSkip = [ 'index.tsx', 'EventActionItems.tsx', 'OrgPostCard.tsx', 'UsersTableItem.tsx', 'FundCampaignPledge.tsx' ]; // Recursively find all .tsx files, excluding files listed in filesToSkip async function findTsxFiles(dir) { let results = []; try { const list = await fs.readdir(dir); for (const file of list) { const filePath = path.join(dir, file); const stat = await fs.stat(filePath); if (stat.isDirectory()) { results = results.concat(await findTsxFiles(filePath)); } else if ( filePath.endsWith('.tsx') && !filePath.endsWith('.test.tsx') && !filePath.endsWith('.spec.tsx') && !filesToSkip.includes(path.relative(dir, filePath)) ) { results.push(filePath); } } } catch (err) { console.error(`Error reading directory ${dir}: ${err.message}`); } return results; } // Check if a file contains at least one TSDoc comment async function containsTsDocComment(filePath) { try { const content = await fs.readFile(filePath, 'utf8'); return /\/\*\*[\s\S]*?\*\//.test(content); } catch (err) { console.error(`Error reading file ${filePath}: ${err.message}`); return false; } } // Main function to run the validation async function run() { const dir = process.argv[2] || './src'; // Allow directory path as a command-line argument const files = await findTsxFiles(dir); const filesWithoutTsDoc = []; for (const file of files) { if (!await containsTsDocComment(file)) { filesWithoutTsDoc.push(file); } } if (filesWithoutTsDoc.length > 0) { filesWithoutTsDoc.forEach(file => { console.error(`No TSDoc comment found in file: ${file}`); }); process.exit(1); } } run(); ================================================ FILE: .github/workflows/codeql-codescan.yml ================================================ ############################################################################## ############################################################################## # # NOTE! # # Please read the README.md file in this directory that defines what should # be placed in this file # ############################################################################## ############################################################################## name: codeql codescan workflow on: pull_request: branches: - '**' push: branches: - '**' jobs: CodeQL: if: ${{ github.actor != 'dependabot[bot]' }} name: Analyse Code With CodeQL runs-on: ubuntu-latest strategy: fail-fast: false matrix: language: ['javascript'] steps: - name: Checkout repository uses: actions/checkout@v4 - name: Initialize CodeQL uses: github/codeql-action/init@v4 with: languages: ${{ matrix.language }} debug: true - name: Autobuild uses: github/codeql-action/autobuild@v4 - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v4 ================================================ FILE: .github/workflows/config/check-pr-issue-skip-usernames.txt ================================================ dependabot noman2002 palisadoes ================================================ FILE: .github/workflows/config/countline_excluded_file_list.txt ================================================ src/screens/Auth/LoginPage/LoginPage.tsx src/GraphQl/Queries/Queries.ts src/screens/OrgList/OrgList.tsx src/GraphQl/Mutations/mutations.ts src/components/EventListCard/EventListCardModals.tsx src/components/TagActions/TagActionsMocks.tsx src/utils/interfaces.ts src/components/OrgPostCard/OrgPostCard.tsx src/components/UsersTableItem/UsersTableItem.tsx src/components/UserPortal/ChatRoom/ChatRoom.tsx src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.tsx src/shared-components/ActionItems/ActionItemModal/ActionItemModal.tsx src/shared-components/postCard/PostCard.tsx ================================================ FILE: .github/workflows/config/sensitive_files.txt ================================================ .flake8$ .pydocstyle$ pyproject.toml$ .env..*$ vitest.config.js$ src/App.tsx$ ^.github/.* ^.coderabbit/.* ^.husky/.* ^scripts/.* ^docker/.* ^config/.* ^cypress/.* ^src/style/.* ^src/assets/.* schema.graphql$ package.json$ package-lock.json$ tsconfig.json$ ^.gitignore$ ^env.example$ .node-version$ .eslintrc.json$ .eslintignore$ .prettierrc$ .prettierignore$ vite.config.ts$ ^docker/docker-compose.prod.yaml$ ^docker/docker-compose.dev.yaml$ ^docker/docker-compose.rootless.prod.yaml$ ^docker/docker-compose.rootless.dev.yaml$ ^docker/Dockerfile.dev$ ^docker/Dockerfile.prod$ ^docker/Dockerfile.rootless.prod$ ^docker/Dockerfile.rootless.dev$ ^config/docker/setup/nginx.conf$ ^config/docker/setup/nginx.prod.conf$ CODEOWNERS$ LICENSE$ setup.ts$ .coderabbit.yaml$ CODE_OF_CONDUCT.md$ CODE_STYLE.md$ CONTRIBUTING.md$ DOCUMENTATION.md$ INSTALLATION.md$ ISSUE_GUIDELINES.md$ PR_GUIDELINES.md$ README.md$ index.html$ .*.pem$ .*.key$ .*.cert$ .*.password$ .*.secret$ .*.credentials$ .nojekyll$ yarn.lock$ knip.json$ knip.deps.json$ ^docs/docusaurus.config.ts$ ^docs/sidebar..* CNAME$ ================================================ FILE: .github/workflows/issue-assigned.yml ================================================ name: Issue Assignment Workflow on: issues: types: [assigned] jobs: issue-assigned: uses: PalisadoesFoundation/.github/.github/workflows/issue-assigned.yml@main # secrets: # ORG_ACCESS_TOKEN: ${{ secrets.ORG_ACCESS_TOKEN }} ================================================ FILE: .github/workflows/issue-unassigned.yml ================================================ name: Add Unapproved Label on Unassignment on: issues: types: [unassigned] jobs: issue-unassigned: uses: PalisadoesFoundation/.github/.github/workflows/issue-unassigned.yml@main ================================================ FILE: .github/workflows/issue.yml ================================================ name: Issue Workflow on: issues: types: [opened] jobs: issue-workflow: uses: PalisadoesFoundation/.github/.github/workflows/issue.yml@main ================================================ FILE: .github/workflows/pull-request-comment.yml ================================================ name: On PR Open - First Time Contributor Comment on: pull_request_target: types: [opened] permissions: pull-requests: write issues: write jobs: call-first-pr-comment: uses: PalisadoesFoundation/.github/.github/workflows/pull-request-comment.yml@main ================================================ FILE: .github/workflows/pull-request-review.yml ================================================ name: Pull Request Review on: pull_request_review: types: [submitted, edited, dismissed] jobs: Check-CodeRabbit-Approval: uses: PalisadoesFoundation/.github/.github/workflows/pull-request-review.yml@main ================================================ FILE: .github/workflows/pull-request-target.yml ================================================ name: PR Target Workflow on: pull_request_target: jobs: PR-Greeting: uses: PalisadoesFoundation/.github/.github/workflows/pull-request-target.yml@main # secrets: # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} ================================================ FILE: .github/workflows/pull-request.yml ================================================ ############################################################################## ############################################################################## # # NOTE! # # Please read the README.md file in this directory that defines what should # be placed in this file # ############################################################################## ############################################################################## name: PR Workflow on: pull_request: branches: - '**' env: CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }} jobs: Code-Quality-Checks: name: Performs linting, formatting, type-checking, unused file detection, checking for different source and target branch runs-on: ubuntu-latest steps: - name: Checkout the Repository uses: actions/checkout@v4 with: fetch-depth: 0 # Fetch all history for all branches and tags - name: Checkout centralized CI/CD scripts uses: actions/checkout@v4 with: repository: PalisadoesFoundation/.github ref: main path: .github-central - name: Install pnpm@10.4.1 uses: pnpm/action-setup@v4 with: version: 10.4.1 run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store run: pnpm fetch - name: Install Dependencies run: pnpm install --frozen-lockfile --prefer-offline - name: Count number of lines run: | chmod +x .github-central/.github/workflows/scripts/countline.py .github-central/.github/workflows/scripts/countline.py \ --lines 600 \ --files ./.github/workflows/config/countline_excluded_file_list.txt - name: Get changed TypeScript files id: changed-files run: | # Get the base branch ref BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}) # Get all changed files ALL_CHANGED_FILES=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | tr '\n' ' ') echo "all_changed_files=${ALL_CHANGED_FILES}" >> $GITHUB_OUTPUT # Count all changed files ALL_CHANGED_FILES_COUNT=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | wc -l | tr -d ' ') echo "all_changed_files_count=$ALL_CHANGED_FILES_COUNT" >> $GITHUB_OUTPUT # Check if any files changed if [ "$ALL_CHANGED_FILES_COUNT" -gt 0 ]; then echo "any_changed=true" >> $GITHUB_OUTPUT else echo "any_changed=false" >> $GITHUB_OUTPUT fi # Set only_changed to false by default (adjust logic as needed) echo "only_changed=false" >> $GITHUB_OUTPUT - name: Check formatting if: steps.changed-files.outputs.only_changed != 'true' run: pnpm format:check - name: Run formatting if check fails if: failure() run: pnpm format:fix - name: Check for type errors if: steps.changed-files.outputs.only_changed != 'true' run: pnpm typecheck - name: Check for linting errors in modified files if: steps.changed-files.outputs.only_changed != 'true' env: CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} run: pnpm exec eslint ${CHANGED_FILES} - name: Validate design tokens in modified files if: steps.changed-files.outputs.any_changed == 'true' env: CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} run: pnpm exec tsx scripts/validate-tokens.ts --files $CHANGED_FILES - name: Enforce CSS import policy if: steps.changed-files.outputs.any_changed == 'true' env: CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} run: pnpm exec tsx scripts/check-css-imports.js --files $CHANGED_FILES - name: Check for TSDoc comments run: pnpm check-tsdoc - name: Check for localStorage Usage run: pnpm exec tsx scripts/githooks/check-localstorage-usage.ts --scan-entire-repo - name: Check for unused dependencies run: pnpm knip --config knip.deps.json --include dependencies - name: Compare translation files run: | chmod +x .github/workflows/scripts/compare_translations.py python .github/workflows/scripts/compare_translations.py --directory public/locales - name: Get changed source files id: changed-src run: | BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}) CHANGED=$(git diff --name-only --diff-filter=ACMRT "$BASE_SHA" ${{ github.event.pull_request.head.sha }} \ | grep -E '^src/.*\.(ts|tsx|js|jsx)$' | tr '\n' ' ' || true) echo "files=$CHANGED" >> $GITHUB_OUTPUT if [ -z "$CHANGED" ]; then echo "none=true" >> $GITHUB_OUTPUT else echo "none=false" >> $GITHUB_OUTPUT fi # Diff-only i18n check to avoid existing legacy violations in untouched lines. - name: Check for non-internationalized text (diff only) if: steps.changed-src.outputs.none != 'true' 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 }} - name: Check if the source and target branches are different if: ${{ github.event.pull_request.base.ref == github.event.pull_request.head.ref }} run: | echo "Source Branch ${{ github.event.pull_request.head.ref }}" echo "Target Branch ${{ github.event.pull_request.base.ref }}" echo "Error: Source and Target Branches are the same. Please ensure they are different." echo "Error: Close this PR and try again." exit 1 - name: Check for unused files and exports in src/ and docs/src run: pnpm knip --include files,exports,nsExports,nsTypes - name: Lint shell scripts (ShellCheck) shell: bash run: | shopt -s globstar nullglob candidates=( scripts/**/*.sh .husky/pre-commit .husky/scripts/**/*.sh ) files=() for f in "${candidates[@]}"; do [[ -f "$f" ]] && files+=("$f") done if [ ${#files[@]} -eq 0 ]; then echo "No shell scripts found to lint." else shellcheck -S warning "${files[@]}" fi CSS-Policy-Check: name: CSS Policy Check runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up Python uses: actions/setup-python@v5 with: python-version: 3.11 - name: Get PR changed files run: | git diff --name-only --diff-filter=ACMRT \ origin/${{ github.base_ref }}...HEAD > pr_files.txt - name: Run CSS policy enforcement run: | if [ -s pr_files.txt ]; then FILTERED_FILES=$(grep -Ev '^src/(utils|types)/' pr_files.txt || true) if [ -n "$FILTERED_FILES" ]; then python .github/workflows/scripts/css_check.py \ --files $FILTERED_FILES else echo "No relevant files after exclusion" fi else echo "No files changed in this PR" fi Check-Mock-Isolation: name: Check for proper mock cleanup in test files needs: [Code-Quality-Checks] runs-on: ubuntu-latest steps: - name: Checkout the Repository uses: actions/checkout@v4 - name: Check for proper mock cleanup run: | chmod +x scripts/githooks/check-mock-cleanup.sh ./scripts/githooks/check-mock-cleanup.sh Check-AutoDocs: name: Generate and Validate Documentation needs: [Code-Quality-Checks] uses: PalisadoesFoundation/.github/.github/workflows/typescript-autodocs.yml@main Check-Sensitive-Files: if: ${{ github.actor != 'dependabot[bot]' }} name: Checks if sensitive files have been changed without authorization runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: fetch-depth: 0 # Fetch all history for all branches and tags - name: Checkout centralized CI/CD scripts uses: actions/checkout@v4 with: repository: PalisadoesFoundation/.github ref: main path: .github-central - name: Get PR labels id: check-labels env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | if [ -z "${{ github.event.pull_request.number }}" ]; then echo "skip=false" >> $GITHUB_OUTPUT exit 0 fi LABELS="$(gh api repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels --jq '.[].name' | tr '\n' ' ')" if echo "$LABELS" | grep -qw "ignore-sensitive-files-pr"; then echo "::notice::Skipping sensitive files check due to 'ignore-sensitive-files-pr' label." echo "skip=true" >> $GITHUB_OUTPUT else echo "skip=false" >> $GITHUB_OUTPUT fi - name: Set up Python if: steps.check-labels.outputs.skip != 'true' uses: actions/setup-python@v5 with: python-version: 3.11 - name: Get Changed Unauthorized files if: steps.check-labels.outputs.skip != 'true' id: changed-unauth-files run: | # Skip if not in PR context if [ -z "${{ github.event.pull_request.base.sha }}" ]; then echo "any_changed=false" >> $GITHUB_OUTPUT exit 0 fi # Determine base and head commits for comparison HEAD_SHA="${{ github.event.pull_request.head.sha || github.sha }}" BASE_SHA=$(git merge-base "${{ github.event.pull_request.base.sha }}" "$HEAD_SHA") # Get all changed files between base and head mapfile -d '' ALL_CHANGED_FILES < <(git diff --name-only -z --diff-filter=ACMR "$BASE_SHA" "$HEAD_SHA") # Check for sensitive files using the python script if [ ${#ALL_CHANGED_FILES[@]} -gt 0 ]; then chmod +x .github-central/.github/workflows/scripts/sensitive_file_check.py .github-central/.github/workflows/scripts/sensitive_file_check.py --config .github/workflows/config/sensitive_files.txt --files "${ALL_CHANGED_FILES[@]}" fi Count-Changed-Files: uses: PalisadoesFoundation/.github/.github/workflows/count-changed-files.yml@main Check-Disable-Statements: name: Check for disable statements (eslint-disable, istanbul-ignore, it.skip) runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: fetch-depth: 0 - name: Checkout centralized scripts uses: actions/checkout@v4 with: repository: PalisadoesFoundation/.github path: .github-central ref: main - name: Get changed files id: changed-files run: | 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 - name: Set up Python uses: actions/setup-python@v5 with: python-version: 3.11 - name: Run Disable Statements Check run: | python .github-central/.github/workflows/scripts/disable_statements_check.py --files ${{ steps.changed-files.outputs.all_changed_files }} Translation-Tag-Check: name: Translation Tag Check runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up Python 3.11 uses: actions/setup-python@v5 with: python-version: 3.11 - name: Install dependencies run: pip install -r .github/workflows/requirements.txt - name: Run Translation Checker run: | BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}) 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) if [ -n "$CHANGED_FILES" ]; then python3 .github/workflows/scripts/translation_check.py --files $CHANGED_FILES else echo "No relevant files changed, skipping check." fi MinIO-Compliance-Check: if: ${{ github.actor != 'dependabot[bot]' }} name: MinIO Compliance Check runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: fetch-depth: 0 - name: Get changed source files id: changed-src run: | BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}) CHANGED=$(git diff --name-only --diff-filter=ACMRT "$BASE_SHA" ${{ github.event.pull_request.head.sha }} \ | grep -E '^src/.*\.(ts|tsx|js|jsx)$' | tr '\n' ' ' || true) echo "files=$CHANGED" >> $GITHUB_OUTPUT if [ -z "$CHANGED" ]; then echo "none=true" >> $GITHUB_OUTPUT else echo "none=false" >> $GITHUB_OUTPUT fi - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' - name: Run MinIO compliance check if: steps.changed-src.outputs.none != 'true' run: node .github/workflows/scripts/check-minio-compliance.cjs Pre-Test-Checks-Pass: name: All Pre-Testing Checks Pass runs-on: ubuntu-latest needs: [ Code-Quality-Checks, Check-AutoDocs, Check-Disable-Statements, Check-Route-Prefix, Check-Mock-Isolation, CSS-Policy-Check, MinIO-Compliance-Check, Python-Compliance, Translation-Tag-Check, ] steps: - name: This job intentionally does nothing run: echo "This job intentionally does nothing" Check-Route-Prefix: name: Check Route Prefix needs: [Code-Quality-Checks] runs-on: ubuntu-latest steps: - name: Checkout the Repository uses: actions/checkout@v4 with: fetch-depth: 0 - name: Install pnpm uses: pnpm/action-setup@v4 with: run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store run: pnpm fetch - name: Install Dependencies run: pnpm install --frozen-lockfile --prefer-offline - name: Run route prefix check script env: CI: true run: npm run check-route-prefix -- --scan-entire-repo Test-Application: name: Test Application (Shard ${{ matrix.shard }}) timeout-minutes: 10 runs-on: ubuntu-latest needs: [Pre-Test-Checks-Pass] env: TOTAL_SHARDS: 12 strategy: fail-fast: false matrix: shard: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12] steps: - name: Checkout the Repository uses: actions/checkout@v4 with: fetch-depth: 0 - name: Install pnpm uses: pnpm/action-setup@v4 with: run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store run: pnpm fetch - name: Install Dependencies run: pnpm install --frozen-lockfile --prefer-offline - name: Get changed TypeScript files id: changed-files run: | # Get the base branch ref BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}) # Check if any files changed ANY_CHANGED=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | wc -l) if [ "$ANY_CHANGED" -gt 0 ]; then echo "any_changed=true" >> $GITHUB_OUTPUT else echo "any_changed=false" >> $GITHUB_OUTPUT fi # Get all changed files ALL_FILES=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | tr '\n' ' ') echo "all_files=$ALL_FILES" >> $GITHUB_OUTPUT # Get TypeScript files specifically TS_FILES=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | grep -E '\.tsx?$' | tr '\n' ' ') echo "ts_files=$TS_FILES" >> $GITHUB_OUTPUT - name: TypeScript compilation run: pnpm exec tsc --noEmit - name: Run Vitest Tests (Shard ${{ matrix.shard }}/${{ env.TOTAL_SHARDS }}) if: steps.changed-files.outputs.any_changed == 'true' env: NODE_V8_COVERAGE: './coverage/vitest' NODE_OPTIONS: '--max-old-space-size=4096 --disable-warning=ExperimentalWarning' SHARD_INDEX: ${{ matrix.shard }} SHARD_COUNT: ${{ env.TOTAL_SHARDS }} CI: true run: pnpm test:shard:coverage - name: Upload coverage artifact if: always() && steps.changed-files.outputs.any_changed == 'true' uses: actions/upload-artifact@v4 with: name: coverage-shard-${{ matrix.shard }} path: ./coverage/vitest/ retention-days: 1 Merge-Coverage: name: Merge Coverage Reports runs-on: ubuntu-latest needs: [Test-Application] if: success() steps: - name: Checkout the Repository uses: actions/checkout@v4 with: fetch-depth: 0 # Fetch all history for Codecov to calculate patch coverage - name: Fetch base branch for Codecov comparison run: | git fetch origin ${{ github.base_ref }} - name: Install pnpm uses: pnpm/action-setup@v4 with: run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store run: pnpm fetch - name: Install Dependencies run: pnpm install --frozen-lockfile --prefer-offline - name: Download all coverage artifacts id: download-artifacts continue-on-error: true uses: actions/download-artifact@v4 with: pattern: coverage-shard-* path: ./coverage-shards/ merge-multiple: false - name: Check if artifacts were downloaded id: check-artifacts run: | # Check if any coverage files exist if find coverage-shards -name "lcov.info" -type f | grep -q .; then echo "artifacts_found=true" >> $GITHUB_OUTPUT echo "Coverage artifacts found" else echo "artifacts_found=false" >> $GITHUB_OUTPUT echo "No coverage artifacts found - tests may have been skipped" fi - name: Merge coverage reports if: steps.check-artifacts.outputs.artifacts_found == 'true' run: | mkdir -p ./coverage/vitest mkdir -p ./coverage/tmp # Find all coverage directories from shards echo "Finding coverage data from shards..." SHARD_DIRS=$(find coverage-shards -type d -name "coverage-shard-*" 2>/dev/null || true) if [ -z "$SHARD_DIRS" ]; then echo "ERROR: No shard directories found!" ls -la coverage-shards/ || true exit 1 fi echo "Found shard directories:" echo "$SHARD_DIRS" # Check if we have JSON coverage files (better for merging) JSON_FILES=$(find coverage-shards -name "coverage-final.json" -type f 2>/dev/null || true) if [ -n "$JSON_FILES" ]; then echo "Using JSON coverage files for accurate merging..." # Copy all JSON files to a temp directory for nyc merge for shard_dir in coverage-shards/coverage-shard-*/; do if [ -f "${shard_dir}coverage-final.json" ]; then echo "Found JSON coverage in: $shard_dir" cp "${shard_dir}coverage-final.json" "./coverage/tmp/coverage-shard-$(basename $shard_dir).json" fi done # Validate JSON files before merging echo "Validating JSON coverage files..." JSON_COUNT=$(find ./coverage/tmp -name "*.json" -type f | wc -l) echo "Found $JSON_COUNT JSON files to merge" if [ "$JSON_COUNT" -eq 0 ]; then echo "ERROR: No JSON coverage files found!" exit 1 fi # Show sample of file count in each JSON for json_file in ./coverage/tmp/*.json; do FILE_COUNT=$(jq 'keys | length' "$json_file" 2>/dev/null || echo "0") echo " $(basename $json_file): $FILE_COUNT files" done # Merge using nyc (more accurate than lcov merge) echo "Merging coverage with nyc..." pnpm exec nyc merge ./coverage/tmp ./.nyc_output/coverage-final.json # Validate merged JSON MERGED_FILE_COUNT=$(jq 'keys | length' ./.nyc_output/coverage-final.json 2>/dev/null || echo "0") echo "Merged coverage contains $MERGED_FILE_COUNT files" else echo "ERROR: No JSON coverage files found! We expect coverage-final.json from shards." exit 1 fi - name: Validate merged coverage integrity if: steps.check-artifacts.outputs.artifacts_found == 'true' run: | echo "Validating merged coverage JSON..." if [ ! -f ./.nyc_output/coverage-final.json ]; then echo "ERROR: Merged coverage JSON not found at ./.nyc_output/coverage-final.json" exit 1 fi MERGED_FILE_COUNT=$(jq 'keys | length' ./.nyc_output/coverage-final.json 2>/dev/null || echo "0") echo "Merged coverage contains $MERGED_FILE_COUNT files" if [ "$MERGED_FILE_COUNT" -eq 0 ]; then echo "ERROR: Merged coverage JSON is empty!" exit 1 fi # Generate lcov from merged JSON - name: Generate lcov report if: steps.check-artifacts.outputs.artifacts_found == 'true' run: | echo "Generating lcov report from merged coverage..." pnpm exec nyc report --reporter=lcov --report-dir=./coverage/vitest - name: Analyze lcov structure if: steps.check-artifacts.outputs.artifacts_found == 'true' run: | echo "Analyzing lcov.info structure..." LCOV_FILE="./coverage/vitest/lcov.info" if [ ! -s "$LCOV_FILE" ]; then echo "ERROR: lcov.info is empty or missing" exit 1 fi # Check source paths echo "Checking source paths in lcov file (first 10 unique paths):" grep "^SF:" "$LCOV_FILE" | head -10 # Check for absolute vs relative paths if grep -q "^SF:/" "$LCOV_FILE"; then echo "WARNING: Found absolute paths in lcov file. This might confuse Codecov." grep "^SF:/" "$LCOV_FILE" | head -5 else echo "Good: All source paths appear to be relative." fi # Count total source files SF_COUNT=$(grep -c "^SF:" "$LCOV_FILE" || echo "0") echo "Total source files in lcov: $SF_COUNT" - name: Clean up individual shard coverage files if: steps.check-artifacts.outputs.artifacts_found == 'true' run: | echo "Cleaning up individual shard coverage files..." # Remove all individual coverage JSON files to prevent Codecov from finding them # This ensures only the merged lcov.info is uploaded find ./coverage -name "coverage-*.json" -type f -delete find ./coverage -name "coverage-final.json" -type f -delete rm -rf ./coverage/tmp ./.nyc_output 2>/dev/null || true echo "Cleanup complete. Remaining coverage files:" find ./coverage -type f \( -name "*.info" -o -name "*.json" \) echo "" echo "Final coverage file to upload:" ls -lh ./coverage/vitest/lcov.info - name: Calculate merge base for Codecov if: steps.check-artifacts.outputs.artifacts_found == 'true' id: get-merge-base run: | # Calculate the merge base MERGE_BASE=$(git merge-base origin/${{ github.base_ref }} HEAD) echo "Merge base commit: $MERGE_BASE" echo "merge_base=$MERGE_BASE" >> $GITHUB_OUTPUT # Verify the commit exists git show -s --format=%ci $MERGE_BASE - name: Present and upload merged coverage to Codecov if: steps.check-artifacts.outputs.artifacts_found == 'true' uses: codecov/codecov-action@v5 with: name: '${{env.CODECOV_UNIQUE_NAME}}-merged' token: ${{ secrets.CODECOV_TOKEN }} # Using fail_ci_if_error: true to match develop branch behavior # This is safe now because we validate the merged file is non-empty above fail_ci_if_error: true verbose: true exclude: 'docs/' gcov_ignore: 'docs/' files: ./coverage/vitest/lcov.info flags: vitest commit_parent: ${{ steps.get-merge-base.outputs.merge_base }} - name: Test acceptable level of code coverage if: steps.check-artifacts.outputs.artifacts_found == 'true' uses: VeryGoodOpenSource/very_good_coverage@v3 with: path: './coverage/vitest/lcov.info' min_coverage: 95.0 # Graphql-Inspector: # if: ${{ github.actor != 'dependabot[bot]' }} # name: Runs Introspection on the GitHub talawa-api repo on the schema.graphql file # runs-on: ubuntu-latest # steps: # - name: Checkout the Repository # uses: actions/checkout@v4 # - name: Set up Node.js # uses: actions/setup-node@v4 # with: # node-version: '24.x' # - name: resolve dependency # run: npm install -g @graphql-inspector/cli # - name: Clone API Repository # run: | # # Retrieve the complete branch name directly from the GitHub context # FULL_BRANCH_NAME=${{ github.base_ref }} # echo "FULL_Branch_NAME: $FULL_BRANCH_NAME" # # Clone the specified repository using the extracted branch name # git clone --branch $FULL_BRANCH_NAME https://github.com/PalisadoesFoundation/talawa-api && ls -a # - name: Validate Documents # run: graphql-inspector validate './src/GraphQl/**/*.ts' './talawa-api/schema.graphql' Start-App-Without-Docker: name: Check if Talawa Admin app starts (No Docker) runs-on: ubuntu-latest needs: [Merge-Coverage] if: github.actor != 'dependabot' steps: - name: Checkout the Repository uses: actions/checkout@v4 - name: Install pnpm uses: pnpm/action-setup@v4 with: run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store run: pnpm fetch - name: Install Dependencies run: pnpm install --frozen-lockfile --prefer-offline - name: Build Production App run: pnpm run build - name: Start Production App run: | pnpm run preview & echo $! > .pidfile_prod - name: Check if Production App is running run: | chmod +x .github/workflows/scripts/app_health_check.sh .github/workflows/scripts/app_health_check.sh 4173 120 - name: Stop Production App run: | if [ -f .pidfile_prod ]; then kill "$(cat .pidfile_prod)" fi - name: Start Development App run: | pnpm run serve & echo $! > .pidfile_dev - name: Check if Development App is running run: | chmod +x .github/workflows/scripts/app_health_check.sh .github/workflows/scripts/app_health_check.sh 4321 120 - name: Stop Development App if: always() run: | if [ -f .pidfile_dev ]; then kill "$(cat .pidfile_dev)" fi Start-App-Using-Docker: name: Check if Talawa Admin app starts in Docker runs-on: ubuntu-latest needs: [Merge-Coverage] if: github.actor != 'dependabot[bot]' steps: - name: Checkout the Repository uses: actions/checkout@v4 - name: Generate `.env` File with Hardcoded Values run: | cat < .env PORT=4321 REACT_APP_TALAWA_URL=http://localhost:4000/graphql REACT_APP_USE_RECAPTCHA= REACT_APP_RECAPTCHA_SITE_KEY= ALLOW_LOGS=NO USE_DOCKER=YES DOCKER_MODE=ROOTFUL DOCKER_PORT=4321 EOF - name: Set up Docker uses: docker/setup-buildx-action@v3 with: driver-opts: | image=moby/buildkit:latest - name: Build Docker images run: | set -e export PNPM_VERSION="${PNPM_VERSION:-10.4.1}" echo "Building Docker images..." docker compose -f docker/docker-compose.prod.yaml build docker compose -f docker/docker-compose.dev.yaml build echo "Docker images built successfully" - name: Run Docker Containers (Production) run: | set -e echo "Starting Docker container for production..." docker compose -f docker/docker-compose.prod.yaml up -d echo "Production Docker container started successfully" - name: Check if Talawa Admin App is running (Production) run: | chmod +x .github/workflows/scripts/app_health_check.sh .github/workflows/scripts/app_health_check.sh 4321 120 true - name: Stop prod Docker Containers if: always() run: | docker compose -f docker/docker-compose.prod.yaml down echo "Prod Docker container stopped and removed" - name: Run Docker Containers (Development) run: | set -e echo "Starting Docker container for development..." docker compose -f docker/docker-compose.dev.yaml up -d echo "Development Docker container started successfully" - name: Check if Talawa Admin App is running (Development) run: | chmod +x .github/workflows/scripts/app_health_check.sh .github/workflows/scripts/app_health_check.sh 4321 120 true - name: Stop dev Docker Containers if: always() run: | docker compose -f docker/docker-compose.dev.yaml down echo "Dev Docker containers stopped and removed" Start-App-Using-Docker-Rootless: name: Check if Talawa Admin app starts in Docker (Rootless) runs-on: ubuntu-latest needs: [Merge-Coverage] if: github.actor != 'dependabot[bot]' steps: - name: Checkout the Repository uses: actions/checkout@v4 - name: Generate `.env` File with Hardcoded Values run: | cat > .env <<'EOF' PORT=4321 REACT_APP_TALAWA_URL=http://localhost:4000/graphql REACT_APP_USE_RECAPTCHA= REACT_APP_RECAPTCHA_SITE_KEY= ALLOW_LOGS=NO USE_DOCKER=YES DOCKER_MODE=ROOTLESS DOCKER_PORT=4321 EOF - name: Install rootless prerequisites run: | set -euxo pipefail sudo apt-get update sudo apt-get install -y uidmap dbus-user-session slirp4netns fuse-overlayfs ca-certificates curl gnupg if ! command -v dockerd-rootless-setuptool.sh >/dev/null 2>&1; then sudo install -m 0755 -d /etc/apt/keyrings if [ ! -f /etc/apt/keyrings/docker.gpg ]; then curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg sudo chmod a+r /etc/apt/keyrings/docker.gpg fi echo \ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ sudo tee /etc/apt/sources.list.d/docker.list > /dev/null sudo apt-get update sudo apt-get install -y docker-ce-rootless-extras fi - name: Start rootless Docker daemon run: | set -euxo pipefail export XDG_RUNTIME_DIR="/run/user/$UID" sudo mkdir -p "$XDG_RUNTIME_DIR" sudo chown "$USER":"$USER" "$XDG_RUNTIME_DIR" if [ ! -f "$HOME/.config/systemd/user/docker.service" ]; then dockerd-rootless-setuptool.sh install --force fi systemctl --user daemon-reload || true systemctl --user start docker || true if ! systemctl --user --no-pager status docker >/dev/null 2>&1; then nohup dockerd-rootless.sh > "$RUNNER_TEMP/dockerd-rootless.log" 2>&1 & fi chmod +x scripts/docker/resolve-docker-host.sh eval "$(./scripts/docker/resolve-docker-host.sh --mode rootless --emit-export --warn-if-docker-group)" echo "DOCKER_HOST=$DOCKER_HOST" >> "$GITHUB_ENV" echo "XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR" >> "$GITHUB_ENV" echo "$HOME/bin" >> "$GITHUB_PATH" - name: Verify rootless daemon run: | set -euxo pipefail chmod +x scripts/docker/resolve-docker-host.sh eval "$(./scripts/docker/resolve-docker-host.sh --mode rootless --emit-export --warn-if-docker-group)" TIMEOUT=60 until docker info >/dev/null 2>&1 || [ "$TIMEOUT" -le 0 ]; do sleep 2 TIMEOUT=$((TIMEOUT - 2)) done if ! docker info >/dev/null 2>&1; then echo "Rootless Docker daemon did not start in time." if [ -f "$RUNNER_TEMP/dockerd-rootless.log" ]; then tail -n 200 "$RUNNER_TEMP/dockerd-rootless.log" fi exit 1 fi docker info docker info --format '{{json .SecurityOptions}}' | tee "$RUNNER_TEMP/rootless-security-options.json" grep -qi rootless "$RUNNER_TEMP/rootless-security-options.json" - name: Build Docker images (Rootless) run: | set -e export PNPM_VERSION="${PNPM_VERSION:-10.4.1}" export UID export GID="$(id -g)" echo "Building rootless Docker images..." docker compose -f docker/docker-compose.rootless.prod.yaml build docker compose -f docker/docker-compose.rootless.dev.yaml build echo "Rootless Docker images built successfully" - name: Run Docker Containers (Rootless Production) run: | set -e export UID export GID="$(id -g)" echo "Starting rootless Docker container for production..." docker compose -f docker/docker-compose.rootless.prod.yaml up -d echo "Rootless production Docker container started successfully" - name: Check if Talawa Admin App is running (Rootless Production) run: | chmod +x .github/workflows/scripts/app_health_check.sh .github/workflows/scripts/app_health_check.sh 4321 120 true - name: Stop rootless prod Docker Containers if: always() run: | export UID export GID="$(id -g)" docker compose -f docker/docker-compose.rootless.prod.yaml down echo "Rootless prod Docker container stopped and removed" - name: Run Docker Containers (Rootless Development) run: | set -e export UID export GID="$(id -g)" echo "Starting rootless Docker container for development..." docker compose -f docker/docker-compose.rootless.dev.yaml up -d echo "Rootless development Docker container started successfully" - name: Check if Talawa Admin App is running (Rootless Development) run: | chmod +x .github/workflows/scripts/app_health_check.sh .github/workflows/scripts/app_health_check.sh 4321 120 true - name: Stop rootless dev Docker Containers if: always() run: | export UID export GID="$(id -g)" docker compose -f docker/docker-compose.rootless.dev.yaml down echo "Rootless dev Docker containers stopped and removed" - name: Print rootless daemon logs on failure if: failure() run: | if [ -f "$RUNNER_TEMP/dockerd-rootless.log" ]; then tail -n 200 "$RUNNER_TEMP/dockerd-rootless.log" fi Test-Docusaurus-Deployment: name: Test Deployment to https://docs-admin.talawa.io runs-on: ubuntu-latest needs: [Merge-Coverage] # Run only if the develop branch and not dependabot if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.base.ref == 'develop' }} steps: - name: Checkout the Repository uses: actions/checkout@v4 - name: Install pnpm uses: pnpm/action-setup@v4 with: run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store working-directory: ./docs run: | if [ -f pnpm-lock.yaml ]; then echo "pnpm-lock.yaml found — running pnpm fetch" pnpm fetch else echo "No pnpm-lock.yaml found — running pnpm install to generate it" pnpm install --frozen-lockfile=false fi - name: Install dependencies (allow lockfile creation) working-directory: ./docs run: | if [ -f pnpm-lock.yaml ]; then pnpm install --frozen-lockfile --prefer-offline else echo "pnpm-lock.yaml not found — installing without --frozen-lockfile" pnpm install --prefer-offline fi - name: Test building the website working-directory: ./docs run: pnpm run build Check-Target-Branch: if: ${{ github.actor != 'dependabot[bot]' }} name: Check Target Branch runs-on: ubuntu-latest steps: - name: Check if the target branch is develop if: github.event.pull_request.base.ref != 'develop' run: | echo "Error: Pull request target branch must be 'develop'. Please refer PR_GUIDELINES.md" echo "Error: Close this PR and try again." exit 1 Python-Compliance: name: Check Python Code Style runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 - name: Checkout centralized CI/CD scripts uses: actions/checkout@v4 with: repository: PalisadoesFoundation/.github ref: main path: .github-central - name: Set up Python 3.11 uses: actions/setup-python@v4 with: python-version: 3.11 - name: Cache pip packages uses: actions/cache@v4 with: path: ~/.cache/pip key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} restore-keys: | ${{ runner.os }}-pip- - name: Install dependencies run: | python3 -m venv venv source venv/bin/activate python -m pip install --upgrade pip pip install -r .github/workflows/requirements.txt - name: Run Python tests for scripts run: | source venv/bin/activate pytest .github/workflows/scripts/test - name: Run Black Formatter Check run: | source venv/bin/activate black --check . - name: Run Flake8 Linter run: | source venv/bin/activate flake8 --docstring-convention google --ignore E402,E722,E203,F401,W503 .github - name: Run pydocstyle run: | source venv/bin/activate pydocstyle --convention=google --add-ignore=D415,D205 .github - name: Run docstring compliance check run: | source venv/bin/activate python .github-central/.github/workflows/scripts/check_docstrings.py \ --directories .github Test-Application-E2E: timeout-minutes: 35 runs-on: ubuntu-latest needs: [Merge-Coverage] env: REACT_APP_TALAWA_URL: http://127.0.0.1:4000/graphql steps: - name: Checkout Backend uses: actions/checkout@v4 with: repository: palisadoesFoundation/talawa-api ref: develop - name: Setup Devcontainer run: | npm install -g @devcontainers/cli cp envFiles/.env.devcontainer .env devcontainer up --workspace-folder . --config .devcontainer/default/devcontainer.json echo "Devcontainer started" - name: Wait for Postgres in devcontainer before migrations run: | set -euo pipefail POSTGRES_USER=postgres echo "Waiting for Postgres service via compose..." TIMEOUT=90 until docker compose exec -T postgres pg_isready -h localhost -p 5432 -U "$POSTGRES_USER" >/dev/null 2>&1 || [ "$TIMEOUT" -le 0 ]; do echo "Postgres not ready ($TIMEOUT s left)" sleep 1 TIMEOUT=$((TIMEOUT - 1)) done if [ "$TIMEOUT" -le 0 ]; then echo "Error: Postgres failed to start" docker compose ps docker compose logs postgres --tail 100 exit 1 fi - name: Apply Database Migrations run: | docker exec talawa-api-1 /bin/bash -c 'pnpm apply_drizzle_migrations' - name: Start Backend Server run: | docker exec -d talawa-api-1 /bin/bash -c 'pnpm run start_development_server' - name: Wait for backend to be ready run: | set -euo pipefail echo "Waiting for backend at http://localhost:4000/healthcheck" TIMEOUT=60 INTERVAL=3 ELAPSED=0 until docker exec talawa-api-1 curl -sf http://localhost:4000/healthcheck > /dev/null; do if [ "$ELAPSED" -ge "$TIMEOUT" ]; then echo "Backend failed to start within ${TIMEOUT}s" echo "=== Backend container logs ===" docker logs talawa-api-1 --tail 100 exit 1 fi echo "Backend not ready yet... (waited ${ELAPSED}s)" sleep $INTERVAL ELAPSED=$((ELAPSED + INTERVAL)) done echo "Backend is up and responding" - name: Wait for GraphQL endpoint to be ready if: success() run: | set -euo pipefail echo "Waiting for GraphQL endpoint at http://localhost:4000/graphql" TIMEOUT=60 INTERVAL=3 ELAPSED=0 until docker exec talawa-api-1 curl -sf -X POST \ http://localhost:4000/graphql \ -H "Content-Type: application/json" \ -d '{"query":"{ __typename }"}' | grep -q "__typename"; do if [ "$ELAPSED" -ge "$TIMEOUT" ]; then echo "GraphQL endpoint failed to become ready within ${TIMEOUT}s" echo "=== Backend container logs ===" docker logs talawa-api-1 --tail 100 exit 1 fi echo "GraphQL endpoint not ready yet... (waited ${ELAPSED}s)" sleep $INTERVAL ELAPSED=$((ELAPSED + INTERVAL)) done echo "GraphQL endpoint is up and responding" - name: Seed Sample Data run: | echo "=== Seeding Sample Data ===" if docker exec talawa-api-1 /bin/bash -c 'set -a; source ./.env; set +a; pnpm run add:sample_data'; then echo "Seeding completed successfully" else echo "Seeding failed - Debug Information:" echo "Container status:" docker ps | grep talawa echo "Recent container logs:" docker logs talawa-api-1 --tail 50 echo "=== Users table contents ===" docker exec talawa-postgres-1 psql -U talawa -d talawa \ -c "SELECT id, email_address, name, role FROM users;" 2>/dev/null || echo "Could not query users" exit 1 fi - name: Checkout Frontend uses: actions/checkout@v4 with: path: frontend - name: Install pnpm uses: pnpm/action-setup@v4 with: run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store working-directory: frontend run: pnpm fetch - name: Install Frontend Dependencies (frozen) working-directory: frontend run: pnpm install --frozen-lockfile --prefer-offline - name: Ensure Cypress binary is installed working-directory: frontend run: pnpm exec cypress install - name: Setup .env working-directory: frontend run: | pwd && cp .env.example .env echo $REACT_APP_TALAWA_URL curl -s -X POST http://127.0.0.1:4000/graphql \ -H "Content-Type: application/json" \ -d '{"query":"{__typename}"}' 2>/dev/null - name: Run Cypress Tests with Dev Server uses: cypress-io/github-action@v6 with: working-directory: frontend start: pnpm run serve wait-on: 'http://localhost:4321' wait-on-timeout: 120 config-file: cypress.config.ts install: false env: CYPRESS_BASE_URL: http://localhost:4321 CYPRESS_API_URL: http://127.0.0.1:4000/graphql # Best-effort artifact upload: continue even if upload fails due to # transient GitHub Actions infrastructure issues. The test result # should not be affected by artifact upload service hiccups. - name: Upload cypress screenshots on failure id: upload-screenshots uses: actions/upload-artifact@v4 if: failure() continue-on-error: true with: name: cypress-screenshots path: frontend/cypress/screenshots compression-level: 9 retention-days: 7 - name: Log artifact upload status if: always() && steps.upload-screenshots.outcome == 'failure' run: | echo "⚠️ Warning: Screenshot upload failed due to infrastructure issue" echo "This does not indicate a test failure - check test results above" ZAP-Security-Scan: name: ZAP Security Scan runs-on: ubuntu-latest needs: [ Test-Application, Test-Application-E2E, Start-App-Without-Docker, Start-App-Using-Docker, Start-App-Using-Docker-Rootless, ] permissions: contents: read steps: - name: Checkout the Repository uses: actions/checkout@v4 - name: Install pnpm uses: pnpm/action-setup@v4 with: run_install: false - name: Set up Node.js uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store run: pnpm fetch - name: Install Dependencies (frozen) run: pnpm install --frozen-lockfile --prefer-offline - name: Start Application run: | pnpm run serve & echo $! > .pidfile_dev - name: Check if Development App is running run: | chmod +x .github/workflows/scripts/app_health_check.sh .github/workflows/scripts/app_health_check.sh 4321 120 - name: ZAP Scan uses: zaproxy/action-full-scan@v0.12.0 with: target: 'http://localhost:4321' allow_issue_writing: false - name: Upload ZAP Report if: always() uses: actions/upload-artifact@v4 with: name: zap-scan-report path: report_html.html - name: Stop Development App if: always() run: | if [ -f .pidfile_dev ]; then kill "$(cat .pidfile_dev)" fi ================================================ FILE: .github/workflows/push-deploy-website.yml ================================================ ############################################################################## ############################################################################## # # NOTE! # # Please read the README.md file in this directory that defines what should # be placed in this file # ############################################################################## ############################################################################## name: PUSH Workflow - Website Deployment on: push: branches: - 'develop' paths: - docs/** env: CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }} jobs: Deploy-Docusaurus: name: Deploy https://docs-admin.talawa.io website runs-on: ubuntu-latest # Run only if the develop branch and not dependabot if: ${{ github.actor != 'dependabot[bot]' }} environment: # This "name" has to be the repos' branch that contains # the current active website. There must be an entry for # the same branch in the PalisadoesFoundation's # "Code and automation > Environments > github-pages" # menu. The branch "name" must match the branch in the # "on.push.branches" section at the top of this file name: develop url: https://docs-admin.talawa.io steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: '24.x' - uses: pnpm/action-setup@v4 with: version: 10.4.1 - name: Cache pnpm store uses: actions/cache@v4 id: pnpm-cache with: path: ~/.pnpm-store key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }} restore-keys: | ${{ runner.os }}-pnpm- - uses: webfactory/ssh-agent@v0.9.0 with: ssh-private-key: ${{ secrets.DEPLOY_GITHUB_PAGES }} - name: Deploy to GitHub Pages env: USE_SSH: true GIT_USER: git working-directory: ./docs run: | git config --global user.email "actions@github.com" git config --global user.name "gh-actions" pnpm install pnpm run deploy ================================================ FILE: .github/workflows/push.yml ================================================ ############################################################################## ############################################################################## # # NOTE! # # Please read the README.md file in this directory that defines what should # be placed in this file # ############################################################################## ############################################################################## name: PUSH Workflow - All Branches on: push: branches: - '**' env: CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }} jobs: Merge-Conflict-Check: runs-on: ubuntu-latest name: Find merge conflicts steps: - uses: actions/checkout@v4 - name: Merge conflict finder uses: olivernybroe/action-conflict-finder@v4.1 Check-Route-Prefix: name: Check Route Prefix needs: [Merge-Conflict-Check] runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: pnpm/action-setup@v4 with: version: 10.4.1 run_install: false - uses: actions/setup-node@v4 with: node-version: '24.x' cache: 'pnpm' - name: Prepare dependency store run: pnpm fetch - name: Install dependencies run: pnpm install --frozen-lockfile --prefer-offline - name: Run route prefix check env: CI: true run: npm run check-route-prefix -- --scan-entire-repo Code-Coverage: if: ${{ github.actor != 'dependabot[bot]' }} name: Test and Calculate Code Coverage needs: [Merge-Conflict-Check, Check-Route-Prefix] runs-on: ubuntu-latest strategy: matrix: node-version: [24.x] steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - uses: pnpm/action-setup@v4 with: version: 10.4.1 - name: Cache pnpm store uses: actions/cache@v4 id: pnpm-cache with: path: ~/.pnpm-store key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }} restore-keys: | ${{ runner.os }}-pnpm- - name: Install dependencies run: pnpm install - name: Run Vitest Tests env: NODE_V8_COVERAGE: './coverage/vitest' run: | pnpm run test:coverage ####################################################################### # DO NOT DELETE ANY references to env.CODECOV_UNIQUE_NAME in this # section. They are required for accurate calculations ####################################################################### - name: Present and upload coverage to Codecov as ${{env.CODECOV_UNIQUE_NAME}} uses: codecov/codecov-action@v5 with: name: '${{env.CODECOV_UNIQUE_NAME}}' token: ${{ secrets.CODECOV_TOKEN }} fail_ci_if_error: false verbose: true exclude: 'docs/' gcov_ignore: 'docs/' files: ./coverage/vitest/lcov.info ================================================ FILE: .github/workflows/requirements.txt ================================================ ############################################################################## # Python Dependencies for Shared Workflow Scripts ############################################################################## # # Required for GitHub Actions workflow Python checks # Standardized across all Talawa repositories (api, admin, mobile, plugin) # # Based on cross-repository analysis (2026-01-03): # - All repos use: black, pydocstyle, flake8, flake8-docstrings, docstring_parser # - Configuration files: pyproject.toml, .flake8, .pydocstyle # ############################################################################## # Code Formatting black==26.1.0 # Docstring Checking pydocstyle docstring_parser # Linting flake8 flake8-docstrings # Testing pytest ================================================ FILE: .github/workflows/scripts/app_health_check.sh ================================================ #!/bin/bash # This script performs a health check to ensure an application is running on a specified port. # The script uses netcat (nc) to check if the port is open, with a configurable timeout. # It also includes optional logic to fetch Docker container logs if the health check fails during a Docker-based test. # Variables: # port="$1" - The port to check (passed as the first argument to the script). # timeout="${2:-120}" - The maximum time in seconds to wait for the application to start. Defaults to 120 seconds if not provided. # is_docker_test="${3:-false}" - A flag to indicate whether the script is being run in a Docker-based test. Defaults to false. # Logic: # 1. Print a message indicating the start of the health check. # 2. Enter a loop to repeatedly check if the port is open using `nc -z localhost "${port}"`. # - If the port is not open and the timeout has not expired, sleep for 1 second and decrement the timeout. # - Print a status message every 10 seconds with the remaining time. # 3. If the timeout expires, print an error message and, if in Docker test mode, fetch Docker logs for debugging. # 4. If the port is detected as open, print a success message and exit. # Script: port="$1" timeout="${2:-120}" is_docker_test="${3:-false}" # Validate required port parameter if [ -z "${port}" ] || ! [[ "${port}" =~ ^[0-9]+$ ]] || [ "${port}" -lt 1 ] || [ "${port}" -gt 65535 ]; then echo "Error: Invalid or missing port number. Must be between 1-65535" exit 1 fi # Validate timeout parameter if ! [[ "${timeout}" =~ ^[0-9]+$ ]] || [ "${timeout}" -lt 1 ]; then echo "Error: Invalid timeout value. Must be a positive integer" exit 1 fi # Validate is_docker_test parameter if [ "${is_docker_test}" != "true" ] && [ "${is_docker_test}" != "false" ]; then echo "Error: is_docker_test must be either 'true' or 'false'" exit 1 fi echo "Starting health check with ${timeout}s timeout" while [ "${timeout}" -gt 0 ]; do if nc -z localhost "${port}" 2>/dev/null; then break elif [ $? -ne 1 ]; then echo "Error: Failed to check port ${port} (nc command failed)" exit 1 fi sleep 1 timeout=$((timeout-1)) if [ $((timeout % 10)) -eq 0 ]; then echo "Waiting for app to start on port ${port}... ${timeout}s remaining" # Try to get more information about the port status netstat -an | grep "${port}" || true fi done if [ "${timeout}" -eq 0 ]; then echo "Error: Timeout waiting for application to start on port ${port}" echo "System port status:" netstat -an | grep "${port}" || true if [ "${is_docker_test}" = "true" ]; then echo "Fetching Docker container logs..." if ! docker logs talawa-admin-app-container; then echo "Error: Failed to fetch logs from container talawa-admin-app-container" fi fi exit 1 fi echo "App started successfully on port ${port}" ================================================ FILE: .github/workflows/scripts/check-minio-compliance.cjs ================================================ /** * MinIO Compliance Enforcement Script * * Purpose: * Enforce the documented MinIO presigned URL file upload approach by * preventing legacy or unsupported upload patterns from being introduced. * * Enforced Rules: * - Disallow Base64-based uploads (convertToBase64) * - Disallow apollo-upload-client imports * - Disallow createUploadLink usage * * Behavior: * - Existing known violations are temporarily exempted via LEGACY_EXCEPTIONS * - Any NEW violations will cause the script to exit non-zero * * Related Issue: * Standardize MinIO File Management - All operations (MVP) #3966 */ const fs = require('fs'); const path = require('path'); /** * Files with known legacy violations. * These will be removed incrementally as migrations land. */ const LEGACY_EXCEPTIONS = new Set([ // Only index.tsx files remain - they use apollo-upload-client for Upload scalar support // These will be removed once all components migrate to presigned URLs 'src/index.tsx', 'src/index.spec.tsx', ]); /** * Explicit forbidden imports. * Maintainer requirement: lint for apollo-upload-client imports. * Uses regex patterns to avoid false positives from comments and strings. */ const FORBIDDEN_IMPORT_PATTERNS = [ /from\s+["']apollo-upload-client["']/, /require\s*\(\s*["']apollo-upload-client["']\s*\)/, ]; /** * Forbidden identifiers/usages. * Uses word boundaries to match whole identifiers only. */ const FORBIDDEN_IDENTIFIERS = [/\bconvertToBase64\b/, /\bcreateUploadLink\b/]; const ROOT_DIR = path.join(process.cwd(), 'src'); const violations = []; function scanFile(filePath) { const relativePath = path .relative(process.cwd(), filePath) .replace(/\\/g, '/'); let content; try { content = fs.readFileSync(filePath, 'utf8'); } catch (error) { console.warn(`Warning: Could not read ${relativePath}: ${error.message}`); return; } // Check forbidden imports FORBIDDEN_IMPORT_PATTERNS.forEach((pattern) => { if (pattern.test(content)) { if (!LEGACY_EXCEPTIONS.has(relativePath)) { violations.push({ file: relativePath, reason: 'apollo-upload-client import detected', }); } } }); // Check forbidden identifiers FORBIDDEN_IDENTIFIERS.forEach((identifier) => { if (identifier.test(content)) { if (!LEGACY_EXCEPTIONS.has(relativePath)) { const match = content.match(identifier); violations.push({ file: relativePath, reason: `forbidden identifier used: ${match[0]}`, }); } } }); } const EXCLUDED_DIRS = new Set([ 'node_modules', 'dist', 'build', '__mocks__', 'coverage', ]); const visitedPaths = new Set(); function walk(dir) { // Protect against symlink loops let realPath; try { realPath = fs.realpathSync(dir); } catch (error) { console.warn(`Warning: Could not resolve ${dir}: ${error.message}`); return; } if (visitedPaths.has(realPath)) { return; } visitedPaths.add(realPath); let entries; try { entries = fs.readdirSync(dir, { withFileTypes: true }); } catch (error) { console.warn(`Warning: Could not read directory ${dir}: ${error.message}`); return; } for (const entry of entries) { // Skip common build/dependency directories if (entry.isDirectory() && EXCLUDED_DIRS.has(entry.name)) { continue; } const fullPath = path.join(dir, entry.name); if (entry.isDirectory() && !entry.isSymbolicLink()) { walk(fullPath); } else if ( (fullPath.endsWith('.ts') || fullPath.endsWith('.tsx')) && !entry.isSymbolicLink() ) { scanFile(fullPath); } } } try { walk(ROOT_DIR); } catch (error) { console.error(`\nMinIO compliance check failed with error: ${error.message}`); process.exit(2); // Exit with different code to distinguish from violations } if (violations.length > 0) { console.error('\nMinIO compliance violations found:\n'); violations.forEach((v) => { console.error(`- ${v.file}: ${v.reason}`); }); process.exit(1); } console.log('MinIO compliance check passed'); ================================================ FILE: .github/workflows/scripts/compare_translations.py ================================================ """Script to encourage more efficient coding practices. Methodology: Utility for comparing translations between default and other languages. This module defines a function to compare two translations and print any missing keys in the other language's translation. Attributes: FileTranslation : Named tuple to represent a combination of file and missing translations. Fields: - file (str): The file name. - missing_translations (list): List of missing translations. Functions: compare_translations(default_translation, other_translation): Compare two translations and print missing keys. load_translation(filepath): Load translation from a file. check_translations(): Load the default translation and compare it with other translations. main(): The main function to run the script. Parses command-line arguments, checks for the existence of the specified directory, and then calls check_translations with the provided or default directory. Usage: This script can be executed to check and print missing translations in other languages based on the default English translation. Example: python compare_translations.py Note: This script complies with our python3 coding and documentation standards and should be used as a reference guide. It complies with: 1) Pylint 2) Pydocstyle 3) Pycodestyle 4) Flake8 """ # standard imports import argparse import json import os import sys import re from collections import namedtuple # Named tuple for file and missing # translations combination FileTranslation = namedtuple( "FileTranslation", ["file", "missing_translations"] ) def compare_translations( default_translation, other_translation, default_file, other_file ): """Compare two translations for missing and/or mismatched keys. Args: default_translation (dict): The default translation (en.json). other_translation (dict): The other language translation. default_file (str): The name of the default translation file. other_file (str): The name of the other translation file. Returns: list: A list of detailed error messages for each missing/mismatched key. """ errors = [] # Extract and match interpolation vars (ex: {{name}}) def _extract_interpolation_vars(text): """Extract interpolation variables like {{variable}} from text. Args: text (str): The text to extract variables from. Returns: set: A set of variable names found in the text. """ return set(re.findall(r"\{\{(\w+)\}\}", text)) def _check_interpolation_match(default_val, other_val, key): """Check if interpolation variables match between translations. Args: default_val (str): The default translation value. other_val (str): The other translation value. key (str): The translation key being checked. Returns: None: Modifies the errors list in outer scope. """ default_vars = _extract_interpolation_vars(default_val) other_vars = _extract_interpolation_vars(other_val) if default_vars != other_vars: missing_vars = default_vars - other_vars extra_vars = other_vars - default_vars if missing_vars: errors.append( f"Missing interpolation variables in key '{key}' in " f"'{other_file}': " f"{', '.join('{{' + var + '}}' for var in missing_vars)}" ) if extra_vars: errors.append( f"Extra interpolation variables in key '{key}' in " f"'{other_file}': " f"{', '.join('{{' + var + '}}' for var in extra_vars)}" ) # Get all unique keys from both translations all_keys = set(default_translation.keys()) | set(other_translation.keys()) for key in all_keys: # Check if key is missing in other_translation if key not in other_translation: error_msg = f"""\ Missing Key: '{key}' - This key from '{default_file}' \ is missing in '{other_file}'.""" errors.append(error_msg) continue # Check for missing keys in default_translation if key not in default_translation: error_msg = f"""\ Error Key: '{key}' - This key in '{other_file}' \ does not match any key in '{default_file}'.""" errors.append(error_msg) continue # Check for empty/null values if default_translation[key] == "" or default_translation[key] is None: error_msg = f"""\ Empty value: '{key}' - This key in '{default_file}' \ has incorrect value.""" errors.append(error_msg) if other_translation[key] == "" or other_translation[key] is None: error_msg = f"""\ Empty value: '{key}' - This key in '{other_file}' \ has incorrect value.""" errors.append(error_msg) # Check interpolation match if ( isinstance(default_translation[key], str) and default_translation[key] and isinstance(other_translation[key], str) and other_translation[key] ): _check_interpolation_match( default_translation[key], other_translation[key], key ) return errors def flatten_json(nested_json, parent_key=""): """Flattens a nested JSON, concatenating keys to represent the hierarchy. Args: nested_json (dict): The JSON object to flatten. parent_key (str): The base key for recursion to track key hierarchy. Returns: dict: A flattened dictionary with concatenated keys. """ flat_dict = {} for key, value in nested_json.items(): # Create the new key by concatenating parent and current key new_key = f"{parent_key}.{key}" if parent_key else key if isinstance(value, dict): # Recursively flatten the nested dictionary flat_dict.update(flatten_json(value, new_key)) else: # Assign the value to the flattened key flat_dict[new_key] = value return flat_dict def load_translation(filepath): """Load translation from a file. Args: filepath: Path to the translation file Returns: translation: Loaded translation """ try: with open(filepath, "r", encoding="utf-8") as file: content = file.read() if not content.strip(): raise ValueError(f"File {filepath} is empty.") translation = json.loads(content) flattened_translation = flatten_json(translation) return flattened_translation except json.JSONDecodeError as e: raise ValueError(f"Error decoding JSON from file {filepath}: {e}") def check_translations(directory): """Load default translation and compare with other translations. Args: directory (str): The directory containing translation files. Returns: None """ default_language_dir = os.path.join(directory, "en") default_files = ["common.json", "errors.json", "translation.json"] default_translations = {} for file in default_files: file_path = os.path.join(default_language_dir, file) default_translations[file] = load_translation(file_path) languages = os.listdir(directory) languages.remove("en") # Exclude default language directory error_found = False for language in languages: language_dir = os.path.join(directory, language) for file in default_files: default_translation = default_translations[file] other_file_path = os.path.join(language_dir, file) other_translation = load_translation(other_file_path) # Compare translations and get detailed error messages errors = compare_translations( default_translation, other_translation, f"en/{file}", f"{language}/{file}", ) if errors: error_found = True print(f"File {language}/{file} has missing translations for:") for error in errors: print(f" - {error}") if error_found: sys.exit(1) # Exit with an error status code else: print("All translations are present with correct interpolations.") sys.exit(0) def main(): """Compare translations. Parse command-line arguments, check for the existence of the specified directory and call check_translations with the provided or default directory. Args: None Returns: None """ # Initialize key variables parser = argparse.ArgumentParser(description="""\ Check and print missing translations for all non-default languages.""") parser.add_argument( "--directory", type=str, nargs="?", default=os.path.join(os.getcwd(), "public/locales"), help="""\ Directory containing translation files(relative to the root directory).""", ) args = parser.parse_args() if not os.path.exists(args.directory): print( f"Error: The specified directory '{args.directory}' does not exist." ) sys.exit(1) check_translations(args.directory) if __name__ == "__main__": main() ================================================ FILE: .github/workflows/scripts/css_check.py ================================================ #!/usr/bin/env python3 # -*- coding: UTF-8 -*- """Check TypeScript files for CSS violations and embedded CSS.""" import argparse import os import re import sys from collections import namedtuple # Define namedtuple for storing detailed violations DetailedViolation = namedtuple( "DetailedViolation", [ "file_path", "line_number", "violation_type", "code_snippet", "description", ], ) CSSCheckResult = namedtuple("CSSCheckResult", ["violations"]) def check_embedded_styles( content: str, file_path: str ) -> list[DetailedViolation]: """Check for embedded CSS and style violations in the content. Args: content: The content of the file to check. file_path: Path to the file being checked. Returns: list: A list of DetailedViolation objects found. """ violations = [] lines = content.splitlines() # Pattern definitions patterns = { "hex_color": { "regex": r"#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})\b", "description": """Hex color code found. Use CSS variables from stylesheet instead.""", }, "rgb_color": { "regex": ( r"\brgba?\s*\(\s*" r"\d+\s*,\s*" r"\d+\s*,\s*" r"\d+\s*" r"(?:,\s*[\d.]+\s*)?" r"\)" ), "description": """RGB/RGBA color code found. Use CSS variables from stylesheet instead.""", }, "hsl_color": { "regex": ( r"\bhsla?\s*\(\s*" r"\d+\s*,\s*" r"\d+%\s*,\s*" r"\d+%\s*" r"(?:,\s*[\d.]+\s*)?" r"\)" ), "description": """HSL/HSLA color code found. Use CSS variables from stylesheet instead.""", }, "inline_style_object": { "regex": r"style\s*=\s*\{\{", "description": """Inline style object found. Move styles to CSS file and use className instead.""", }, "inline_style_string": { "regex": r'style\s*=\s*["\']', "description": """Inline style string found. Move styles to CSS file and use className instead.""", }, "camelcase_css_property": { "regex": ( r"\b(?:" r"backgroundColor|fontSize|fontFamily|fontWeight|lineHeight|" r"marginTop|marginBottom|marginLeft|marginRight|" r"paddingTop|paddingBottom|paddingLeft|paddingRight|" r"borderRadius|boxShadow|textAlign|textDecoration|" r"zIndex|maxWidth|minWidth|maxHeight|minHeight" r")\s*[:=]" ), "description": """Camelcase CSS property found. Move styles to CSS file and use className instead.""", }, "pixel_value": { "regex": ( r":\s*" r"['\"]?" r"\d+(?:px|em|rem|vh|vw|%)" r"['\"]?" r"(?=\s*[,}])" ), "description": """Direct size value assignment found. Move styles to CSS file and use className instead.""", }, } in_block_comment = False for line_number, line in enumerate(lines, start=1): # Skip comments and import statements stripped_line = line.strip() if stripped_line.startswith(("import ", "import{", "import(")): continue result = "" i = 0 while i < len(line): if in_block_comment: if line[i : i + 2] == "*/": in_block_comment = False i += 2 else: i += 1 else: if line[i : i + 2] == "/*": in_block_comment = True i += 2 elif line[i : i + 2] == "//": break else: result += line[i] i += 1 code_line = result if not code_line.strip(): continue # Check for URL references (skip these as they're not style violations) if ( "url(" in code_line.lower() or "href=" in code_line.lower() or "src=" in code_line.lower() ): # Skip hex codes in URLs continue for violation_type, pattern_info in patterns.items(): matches = re.finditer(pattern_info["regex"], code_line) for match in matches: if violation_type == "camelcase_css_property": # Check if it's actually in a style context preceding_text = code_line[: match.start()].strip() if not any( keyword in preceding_text for keyword in ["style", "css", "Style", "CSS"] ): if "{" not in code_line[: match.start()]: continue if violation_type == "pixel_value": # Look for style-related keywords nearby context_window = code_line[ max(0, match.start() - 30) : min( len(code_line), match.end() + 30 ) ] if not any( keyword in context_window for keyword in [ "style", "Style", "width", "height", "size", "margin", "padding", ] ): continue violations.append( DetailedViolation( file_path=file_path, line_number=line_number, violation_type=violation_type, code_snippet=match.group(0), description=pattern_info["description"], ) ) return violations def process_typescript_file( file_path: str, all_violations: list[DetailedViolation] ) -> None: """Process a TypeScript file for CSS violations. Args: file_path: Path to the TypeScript file to process. all_violations: List to store violations found. Returns: None: This function modifies the provided list. """ try: with open(file_path, encoding="utf-8") as f: content = f.read() except (OSError, UnicodeDecodeError) as e: print(f"Error reading file {file_path}: {e}", file=sys.stderr) return # Check for embedded styles violations = check_embedded_styles(content, file_path) all_violations.extend(violations) def check_files( directories: list, files: list, exclude_files: list, exclude_directories: list, ) -> CSSCheckResult: """Scan directories and specific files for TS files and their violations. Args: directories: List of directories to scan for TypeScript files. files: List of specific files to check. exclude_files: List of file paths to exclude from the scan. exclude_directories: List of directories to exclude from the scan. Returns: CSSCheckResult: A result object containing violations found. """ all_violations = [] exclude_files = set(os.path.abspath(file) for file in exclude_files) exclude_directories = set( os.path.abspath(dir) for dir in exclude_directories ) for directory in directories: directory = os.path.abspath(directory) for root, _, files_in_dir in os.walk(directory): root_dirname = os.path.basename(root) if root_dirname in {"__tests__", "test", "tests"} or any( root.startswith(exclude_dir) for exclude_dir in exclude_directories ): continue for file in files_in_dir: file_path = os.path.abspath(os.path.join(root, file)) if file_path in exclude_files: continue if file.endswith((".ts", ".tsx")) and not any( pattern in file for pattern in [".test.", ".spec."] ): process_typescript_file(file_path, all_violations) # Process individual files explicitly listed for file_path in files: file_path = os.path.abspath(file_path) file_name = os.path.basename(file_path) if ( file_path not in exclude_files and file_path.endswith((".ts", ".tsx")) and not any( pattern in file_name for pattern in [".test.", ".spec."] ) ): process_typescript_file(file_path, all_violations) return CSSCheckResult(violations=all_violations) def validate_directories_input(input_directories: list[str]) -> list[str]: """Validate that the --directories input is correctly formatted. Args: input_directories: A list of file or directory paths to validate. Returns: validated_dirs: A list containing validated directory paths. If the input is a file, its parent directory is added to the list. Raises: ValueError: If a path is neither a valid file nor a directory. """ validated_dirs = [] for path in input_directories: if os.path.isdir(path): validated_dirs.append(path) elif os.path.isfile(path): validated_dirs.append(os.path.dirname(path)) else: raise ValueError( f"Invalid path: {path}. Must be an existing file or directory." ) return validated_dirs def format_violation_output(violations: list[DetailedViolation]) -> str: """Format violations for human-readable output. Args: violations: List of violations to format. Returns: output: A formatted string containing all violations and a summary. """ if not violations: return "" output_lines = ["=" * 80] output_lines.append("EMBEDDED CSS VIOLATIONS FOUND") output_lines.append("=" * 80) output_lines.append("") # Group violations by file violations_by_file = {} for violation in violations: if violation.file_path not in violations_by_file: violations_by_file[violation.file_path] = [] violations_by_file[violation.file_path].append(violation) # Sort files for consistent output for file_path in sorted(violations_by_file.keys()): file_violations = violations_by_file[file_path] output_lines.append(f"File: {file_path}") output_lines.append("-" * 80) # Sort violations by line number for violation in sorted(file_violations, key=lambda v: v.line_number): output_lines.append( f" Line {violation.line_number}: [{violation.violation_type}]" ) output_lines.append(f" Code: {violation.code_snippet}") output_lines.append(f" Issue: {violation.description}") output_lines.append("") output_lines.append("") output_lines.append("=" * 80) output_lines.append("SUMMARY") output_lines.append("=" * 80) output_lines.append(f"Total violations: {len(violations)}") output_lines.append(f"Files affected: {len(violations_by_file)}") output_lines.append("") output_lines.append("Please address these violations by:") output_lines.append("1. Moving all styles to CSS files") output_lines.append("2. Using className instead of inline styles") output_lines.append("3. Defining colors and sizes as CSS variables") output_lines.append("4. Importing and using CSS modules properly") output_lines.append("") return "\n".join(output_lines) def main(): """Run the CSS check. Args: None Returns: None """ parser = argparse.ArgumentParser(description="""Check for embedded CSS and style violations in TypeScript files.""") parser.add_argument( "--directories", nargs="+", required=False, help="List of directories to check for CSS violations.", ) parser.add_argument( "--files", nargs="*", default=[], help="Specific files to check for CSS violations.", ) parser.add_argument( "--exclude_files", nargs="*", default=[], help="Specific files to exclude from analysis.", ) parser.add_argument( "--exclude_directories", nargs="*", default=[], help="Directories to exclude from analysis.", ) args = parser.parse_args() if not args.directories and not args.files: parser.error( "At least one of --directories or --files must be provided." ) try: directories = ( validate_directories_input(args.directories) if args.directories else [] ) except ValueError as e: print(f"Error: {e}", file=sys.stderr) sys.exit(1) result = check_files( directories=directories, files=args.files, exclude_files=args.exclude_files, exclude_directories=args.exclude_directories, ) if result.violations: print(format_violation_output(result.violations)) sys.exit(1) else: print("✓ No embedded CSS violations found.") sys.exit(0) if __name__ == "__main__": main() ================================================ FILE: .github/workflows/scripts/test/README.md ================================================ ## Place test code in this directory ================================================ FILE: .github/workflows/scripts/test/test_css_check.py ================================================ #!/usr/bin/env python3 # -*- coding: UTF-8 -*- """Comprehensive unit tests for css_check.py with 100% code coverage.""" import unittest import tempfile import os import sys from unittest.mock import patch from io import StringIO import shutil sys.path.insert( 0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) ) from css_check import ( check_embedded_styles, process_typescript_file, check_files, validate_directories_input, format_violation_output, DetailedViolation, CSSCheckResult, main, ) class TestCheckEmbeddedStyles(unittest.TestCase): """Test suite for check_embedded_styles function.""" def test_detects_hex_color(self): """Test detection of 6-digit hex color codes.""" content = "const bgColor = '#ff0000';" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "hex_color") self.assertEqual(violations[0].code_snippet, "#ff0000") def test_detects_multiple_hex_colors(self): """Test detection of multiple hex colors in one line.""" content = ( "const colors = { primary: '#ff0000', secondary: '#00ff00' };" ) violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 2) self.assertTrue( all(v.violation_type == "hex_color" for v in violations) ) def test_detects_rgb_color(self): """Test detection of RGB color codes.""" content = "const color = 'rgb(255, 0, 0)';" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "rgb_color") def test_detects_rgba_color(self): """Test detection of RGBA color codes.""" content = "const color = 'rgba(255, 0, 0, 0.5)';" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "rgb_color") def test_detects_hsl_color(self): """Test detection of HSL color codes.""" content = "const color = 'hsl(120, 100%, 50%)';" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "hsl_color") def test_detects_inline_style_object(self): """Test detection of inline style objects.""" content = "
Hello
" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "inline_style_object") def test_detects_inline_style_string_double_quotes(self): """Test detection of inline style strings with double quotes.""" content = '
Hello
' violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "inline_style_string") def test_detects_inline_style_string_single_quotes(self): """Test detection of inline style strings with single quotes.""" content = "
Hello
" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "inline_style_string") def test_detects_camelcase_font_size(self): """Test detection of camelCase CSS property fontSize.""" content = "const styles = { fontSize: '16px' };" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 2) self.assertEqual( violations[0].violation_type, "camelcase_css_property" ) def test_detects_camelcase_margin_top(self): """Test detection of camelCase CSS property marginTop.""" content = "const styles = { marginTop: '10px' };" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 2) self.assertEqual( violations[0].violation_type, "camelcase_css_property" ) def test_detects_camelcase_padding_left(self): """Test detection of camelCase CSS property paddingLeft.""" content = "const styles = { paddingLeft: '5px' };" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 2) self.assertEqual( violations[0].violation_type, "camelcase_css_property" ) def test_detects_pixel_value(self): """Test detection of pixel values in style context.""" content = "const style = { width: '100px' };" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "pixel_value") def test_detects_rem_value(self): """Test detection of rem values in style context.""" content = "const style = { margin: '1rem' };" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].violation_type, "pixel_value") def test_ignores_single_line_comment_with_hex(self): """Test that hex colors in single-line comments are ignored.""" content = "// const color = '#ff0000';" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_ignores_block_comment_with_styles(self): """Test that styles in block comments are ignored.""" content = "/* const color = '#ff0000'; */" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_ignores_multiline_block_comment(self): """Test that multiline block comments with styles are ignored.""" content = """/* const color = '#ff0000'; const bg = 'rgb(255, 0, 0)'; */""" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_handles_block_comment_spanning_lines(self): """Test proper handling of block comments spanning multiple lines.""" content = """const valid = 'test'; /* comment with #ff0000 */ const color = '#00ff00';""" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual(violations[0].code_snippet, "#00ff00") self.assertEqual(violations[0].line_number, 3) def test_ignores_import_statements(self): """Test that import statements are ignored.""" content = "import { colors } from './colors';" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_ignores_dynamic_import(self): """Test that dynamic import() statements are ignored.""" content = "const module = import('./module');" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_ignores_hex_in_url(self): """Test that hex codes in URLs are ignored.""" content = "const imageUrl = 'url(#ff0000)';" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_ignores_hex_in_href(self): """Test that hex codes in href attributes are ignored.""" content = 'Link' violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_ignores_hex_in_src(self): """Test that hex codes in src attributes are ignored.""" content = '' violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_whitespace_only_content(self): """Test handling of whitespace-only content.""" content = " \n \t \n " violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 0) def test_camelcase_requires_style_context(self): """Test that camelCase properties need style context to be flagged.""" content = "const backgroundColor = 'someValue';" violations = check_embedded_styles(content, "test.tsx") # Should not flag variable names, only in style objects camelcase_violations = [ v for v in violations if v.violation_type == "camelcase_css_property" ] self.assertEqual(len(camelcase_violations), 0) def test_camelcase_in_object_with_brace(self): """Test camelCase detection in object context.""" content = "{ backgroundColor: 'red' }" violations = check_embedded_styles(content, "test.tsx") self.assertEqual(len(violations), 1) self.assertEqual( violations[0].violation_type, "camelcase_css_property" ) def test_pixel_value_without_style_context_ignored(self): """Test that pixel values without style context are ignored.""" content = "const version = '100px';" violations = check_embedded_styles(content, "test.tsx") # Should not flag without style context pixel_violations = [ v for v in violations if v.violation_type == "pixel_value" ] self.assertEqual(len(pixel_violations), 0) def test_pixel_value_with_width_keyword(self): """Test pixel value detection with 'width' keyword.""" content = "const width: '100px'," violations = check_embedded_styles(content, "test.tsx") self.assertGreaterEqual(len(violations), 1) def test_multiple_violation_types_in_one_line(self): """Test detection of multiple violation types in a single line.""" content = ( "const style = { backgroundColor: '#ff0000', fontSize: '16px' };" ) violations = check_embedded_styles(content, "test.tsx") self.assertGreaterEqual(len(violations), 3) # hex, camelcase, pixel violation_types = {v.violation_type for v in violations} self.assertIn("hex_color", violation_types) self.assertIn("camelcase_css_property", violation_types) class TestProcessTypescriptFile(unittest.TestCase): """Test suite for process_typescript_file function.""" def setUp(self): """Create temporary directory for test files.""" self.test_dir = tempfile.mkdtemp() def tearDown(self): """Clean up temporary directory.""" shutil.rmtree(self.test_dir) def test_processes_valid_file(self): """Test processing of a valid TypeScript file.""" file_path = os.path.join(self.test_dir, "test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") violations = [] process_typescript_file(file_path, violations) self.assertEqual(len(violations), 1) self.assertEqual(violations[0].file_path, file_path) def test_processes_empty_file(self): """Test processing of an empty file.""" file_path = os.path.join(self.test_dir, "empty.tsx") with open(file_path, "w") as f: f.write("") violations = [] process_typescript_file(file_path, violations) self.assertEqual(len(violations), 0) def test_processes_file_with_no_violations(self): """Test processing of a file with no violations.""" file_path = os.path.join(self.test_dir, "clean.tsx") with open(file_path, "w") as f: f.write("const name = 'test';\nimport React from 'react';") violations = [] process_typescript_file(file_path, violations) self.assertEqual(len(violations), 0) def test_handles_file_not_found(self): """Test handling of non-existent file.""" file_path = os.path.join(self.test_dir, "nonexistent.tsx") violations = [] with patch("sys.stderr", new_callable=StringIO) as mock_stderr: process_typescript_file(file_path, violations) self.assertIn("Error reading file", mock_stderr.getvalue()) self.assertEqual(len(violations), 0) def test_handles_unicode_decode_error(self): """Test handling of files with encoding issues.""" file_path = os.path.join(self.test_dir, "bad_encoding.tsx") # Create a file with invalid UTF-8 with open(file_path, "wb") as f: f.write(b"\xff\xfe") violations = [] with patch("sys.stderr", new_callable=StringIO) as mock_stderr: process_typescript_file(file_path, violations) output = mock_stderr.getvalue() self.assertIn("Error reading file", output) self.assertEqual(len(violations), 0) def test_appends_to_existing_violations_list(self): """Test that violations are appended to existing list.""" file_path = os.path.join(self.test_dir, "test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") existing_violation = DetailedViolation( file_path="other.tsx", line_number=1, violation_type="test", code_snippet="test", description="test", ) violations = [existing_violation] process_typescript_file(file_path, violations) self.assertEqual(len(violations), 2) self.assertEqual(violations[0], existing_violation) class TestCheckFiles(unittest.TestCase): """Test suite for check_files function.""" def setUp(self): """Create temporary directory structure for tests.""" self.test_dir = tempfile.mkdtemp() self.subdir = os.path.join(self.test_dir, "subdir") os.makedirs(self.subdir) def tearDown(self): """Clean up temporary directory.""" shutil.rmtree(self.test_dir) def test_scans_directory_for_tsx_files(self): """Test scanning directory for .tsx files.""" file_path = os.path.join(self.test_dir, "test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") result = check_files([self.test_dir], [], [], []) self.assertEqual(len(result.violations), 1) def test_scans_directory_for_ts_files(self): """Test scanning directory for .ts files.""" file_path = os.path.join(self.test_dir, "test.ts") with open(file_path, "w") as f: f.write("const color = '#ff0000';") result = check_files([self.test_dir], [], [], []) self.assertEqual(len(result.violations), 1) def test_scans_nested_directories(self): """Test scanning nested directories.""" file_path = os.path.join(self.subdir, "nested.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") result = check_files([self.test_dir], [], [], []) self.assertEqual(len(result.violations), 1) def test_excludes_test_files_with_test_in_name(self): """Test that .test. files are excluded.""" file_path = os.path.join(self.test_dir, "component.test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") result = check_files([self.test_dir], [], [], []) self.assertEqual(len(result.violations), 0) def test_excludes_tests_directory(self): """Test that files in tests/ directory are excluded.""" tests_dir = os.path.join(self.test_dir, "tests") os.makedirs(tests_dir) file_path = os.path.join(tests_dir, "test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") result = check_files([self.test_dir], [], [], []) self.assertEqual(len(result.violations), 0) def test_excludes_test_directory(self): """Test that files in test/ directory are excluded.""" test_dir = os.path.join(self.test_dir, "test") os.makedirs(test_dir) file_path = os.path.join(test_dir, "component.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") result = check_files([self.test_dir], [], [], []) self.assertEqual(len(result.violations), 0) def test_processes_explicit_file_list(self): """Test processing explicit list of files.""" file_path = os.path.join(self.test_dir, "explicit.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") result = check_files([], [file_path], [], []) self.assertEqual(len(result.violations), 1) def test_excludes_specific_files(self): """Test excluding specific files.""" file1 = os.path.join(self.test_dir, "include.tsx") file2 = os.path.join(self.test_dir, "exclude.tsx") with open(file1, "w") as f: f.write("const color = '#ff0000';") with open(file2, "w") as f: f.write("const color = '#00ff00';") result = check_files([self.test_dir], [], [file2], []) self.assertEqual(len(result.violations), 1) self.assertIn("include.tsx", result.violations[0].file_path) def test_excludes_directories(self): """Test excluding entire directories.""" exclude_dir = os.path.join(self.test_dir, "exclude") os.makedirs(exclude_dir) file1 = os.path.join(self.test_dir, "include.tsx") file2 = os.path.join(exclude_dir, "exclude.tsx") with open(file1, "w") as f: f.write("const color = '#ff0000';") with open(file2, "w") as f: f.write("const color = '#00ff00';") result = check_files([self.test_dir], [], [], [exclude_dir]) self.assertEqual(len(result.violations), 1) self.assertIn("include.tsx", result.violations[0].file_path) def test_ignores_non_typescript_files(self): """Test that non-TypeScript files are ignored.""" js_file = os.path.join(self.test_dir, "test.js") py_file = os.path.join(self.test_dir, "test.py") with open(js_file, "w") as f: f.write("const color = '#ff0000';") with open(py_file, "w") as f: f.write("color = '#00ff00'") result = check_files([self.test_dir], [], [], []) self.assertEqual(len(result.violations), 0) def test_combines_directory_and_file_results(self): """Test combining results from directories and explicit files.""" dir_file = os.path.join(self.test_dir, "dir.tsx") explicit_file = os.path.join(self.test_dir, "explicit.tsx") with open(dir_file, "w") as f: f.write("const color = '#ff0000';") with open(explicit_file, "w") as f: f.write("const bg = '#00ff00';") result = check_files([self.test_dir], [explicit_file], [], []) self.assertGreaterEqual(len(result.violations), 2) def test_returns_css_check_result(self): """Test that function returns CSSCheckResult object.""" result = check_files([self.test_dir], [], [], []) self.assertIsInstance(result, CSSCheckResult) self.assertIsInstance(result.violations, list) def test_handles_absolute_paths(self): """Test that function handles absolute paths correctly.""" file_path = os.path.join(self.test_dir, "test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") abs_path = os.path.abspath(file_path) result = check_files([], [abs_path], [], []) self.assertEqual(len(result.violations), 1) class TestValidateDirectoriesInput(unittest.TestCase): """Test suite for validate_directories_input function.""" def setUp(self): """Create temporary directory and file for tests.""" self.test_dir = tempfile.mkdtemp() self.test_file = os.path.join(self.test_dir, "test.tsx") with open(self.test_file, "w") as f: f.write("test") def tearDown(self): """Clean up temporary directory.""" shutil.rmtree(self.test_dir) def test_validates_existing_directory(self): """Test validation of existing directory.""" result = validate_directories_input([self.test_dir]) self.assertEqual(len(result), 1) self.assertEqual(result[0], self.test_dir) class TestFormatViolationOutput(unittest.TestCase): """Test suite for format_violation_output function.""" def test_empty_violations_returns_empty_string(self): """Test that empty violations list returns empty string.""" result = format_violation_output([]) self.assertEqual(result, "") def test_single_violation_output_format(self): """Test output format for single violation.""" violation = DetailedViolation( file_path="/path/to/file.tsx", line_number=10, violation_type="hex_color", code_snippet="#ff0000", description="Hex color found", ) result = format_violation_output([violation]) self.assertIn("EMBEDDED CSS VIOLATIONS FOUND", result) self.assertIn("/path/to/file.tsx", result) self.assertIn("Line 10", result) self.assertIn("[hex_color]", result) self.assertIn("#ff0000", result) self.assertIn("Hex color found", result) self.assertIn("Total violations: 1", result) self.assertIn("Files affected: 1", result) def test_multiple_violations_same_file(self): """Test output format for multiple violations in same file.""" violations = [ DetailedViolation( file_path="/path/to/file.tsx", line_number=5, violation_type="hex_color", code_snippet="#ff0000", description="Hex color found", ), DetailedViolation( file_path="/path/to/file.tsx", line_number=10, violation_type="rgb_color", code_snippet="rgb(255,0,0)", description="RGB color found", ), ] result = format_violation_output(violations) self.assertIn("Total violations: 2", result) self.assertIn("Files affected: 1", result) self.assertIn("Line 5", result) self.assertIn("Line 10", result) def test_multiple_violations_different_files(self): """Test output format for violations across multiple files.""" violations = [ DetailedViolation( file_path="/path/to/file1.tsx", line_number=5, violation_type="hex_color", code_snippet="#ff0000", description="Hex color found", ), DetailedViolation( file_path="/path/to/file2.tsx", line_number=10, violation_type="rgb_color", code_snippet="rgb(255,0,0)", description="RGB color found", ), ] result = format_violation_output(violations) self.assertIn("Total violations: 2", result) self.assertIn("Files affected: 2", result) self.assertIn("file1.tsx", result) self.assertIn("file2.tsx", result) class TestMain(unittest.TestCase): """Test suite for main function.""" def setUp(self): """Set up test directory.""" self.test_dir = tempfile.mkdtemp() def tearDown(self): """Clean up test directory.""" shutil.rmtree(self.test_dir) def test_exits_with_code_0_when_no_violations(self): """Test that main exits with code 0 when no violations found.""" file_path = os.path.join(self.test_dir, "clean.tsx") with open(file_path, "w") as f: f.write("const name = 'test';") test_args = ["css_check.py", "--directories", self.test_dir] with patch("sys.argv", test_args): with patch("sys.stdout", new_callable=StringIO) as mock_stdout: with self.assertRaises(SystemExit) as cm: main() self.assertEqual(cm.exception.code, 0) self.assertIn( "No embedded CSS violations found", mock_stdout.getvalue() ) def test_exits_with_code_1_when_violations_found(self): """Test that main exits with code 1 when violations found.""" file_path = os.path.join(self.test_dir, "violation.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") test_args = ["css_check.py", "--directories", self.test_dir] with patch("sys.argv", test_args): with patch("sys.stdout", new_callable=StringIO) as mock_stdout: with self.assertRaises(SystemExit) as cm: main() self.assertEqual(cm.exception.code, 1) output = mock_stdout.getvalue() self.assertIn("EMBEDDED CSS VIOLATIONS FOUND", output) def test_requires_directories_or_files_argument(self): """Test that main requires at least one of --directories or --files.""" test_args = ["css_check.py"] with patch("sys.argv", test_args): with patch("sys.stderr", new_callable=StringIO): with self.assertRaises(SystemExit) as cm: main() self.assertEqual(cm.exception.code, 2) def test_accepts_files_argument(self): """Test that main accepts --files argument.""" file_path = os.path.join(self.test_dir, "test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") test_args = ["css_check.py", "--files", file_path] with patch("sys.argv", test_args): with patch("sys.stdout", new_callable=StringIO): with self.assertRaises(SystemExit) as cm: main() self.assertEqual(cm.exception.code, 1) def test_handles_invalid_directory_input(self): """Test that main handles invalid directory input.""" invalid_dir = os.path.join(self.test_dir, "nonexistent") test_args = ["css_check.py", "--directories", invalid_dir] with patch("sys.argv", test_args): with patch("sys.stderr", new_callable=StringIO) as mock_stderr: with self.assertRaises(SystemExit) as cm: main() self.assertEqual(cm.exception.code, 1) self.assertIn("Error", mock_stderr.getvalue()) def test_prints_formatted_output(self): """Test that main prints formatted violation output.""" file_path = os.path.join(self.test_dir, "test.tsx") with open(file_path, "w") as f: f.write("const color = '#ff0000';") test_args = ["css_check.py", "--directories", self.test_dir] with patch("sys.argv", test_args): with patch("sys.stdout", new_callable=StringIO) as mock_stdout: with self.assertRaises(SystemExit): main() output = mock_stdout.getvalue() self.assertIn("EMBEDDED CSS VIOLATIONS FOUND", output) self.assertIn("Total violations:", output) self.assertIn("Files affected:", output) class TestNamedTuples(unittest.TestCase): """Test suite for namedtuple definitions.""" def test_detailed_violation_creation(self): """Test DetailedViolation namedtuple creation.""" violation = DetailedViolation( file_path="/test.tsx", line_number=10, violation_type="hex_color", code_snippet="#ff0000", description="Test description", ) self.assertEqual(violation.file_path, "/test.tsx") self.assertEqual(violation.line_number, 10) self.assertEqual(violation.violation_type, "hex_color") self.assertEqual(violation.code_snippet, "#ff0000") self.assertEqual(violation.description, "Test description") def test_css_check_result_creation(self): """Test CSSCheckResult namedtuple creation.""" violations = [ DetailedViolation( file_path="/test.tsx", line_number=10, violation_type="hex_color", code_snippet="#ff0000", description="Test", ) ] result = CSSCheckResult(violations=violations) self.assertEqual(len(result.violations), 1) self.assertEqual(result.violations[0].file_path, "/test.tsx") if __name__ == "__main__": unittest.main() ================================================ FILE: .github/workflows/scripts/test/test_translation_check.py ================================================ """Tests for the translation_check module.""" import unittest import os import sys import json import shutil import tempfile import subprocess import importlib.util from pathlib import Path from unittest.mock import patch SCRIPT_DIR = Path(__file__).resolve().parents[1] SPEC = importlib.util.spec_from_file_location( "translation_check", SCRIPT_DIR / "translation_check.py", ) translation_check = importlib.util.module_from_spec(SPEC) SPEC.loader.exec_module(translation_check) class TestTranslationCheck(unittest.TestCase): """Unit test suite for i18n tag validation logic.""" def setUp(self): """Initialize temporary environment for tests.""" self.test_dir = tempfile.mkdtemp() self.locales_dir = os.path.join(self.test_dir, "locales") os.makedirs(self.locales_dir) self.en_dir = os.path.join(self.locales_dir, "en") os.makedirs(self.en_dir) self.common_json = os.path.join(self.en_dir, "common.json") with open(self.common_json, "w", encoding="utf-8") as f: json.dump({"login": "Login", "auth": {"signup": "Sign Up"}}, f) def tearDown(self): """Cleanup temporary environment.""" shutil.rmtree(self.test_dir) def test_get_keys_recursion(self): """Verify recursive extraction of nested keys.""" self.assertEqual( translation_check.get_translation_keys({"a": {"b": "c"}}), {"a.b"}, ) def test_load_locales_success(self): """Verify successful loading of valid locale keys.""" keys = translation_check.load_locale_keys(self.en_dir) self.assertIn("login", keys) def test_load_locales_malformed(self): """Verify handling of malformed JSON.""" with open(os.path.join(self.en_dir, "translation.json"), "w") as f: f.write("{invalid}") self.assertIn("login", translation_check.load_locale_keys(self.en_dir)) def test_load_locales_not_found(self): """Verify exception on invalid locale path.""" with self.assertRaises(FileNotFoundError): translation_check.load_locale_keys("/invalid/path") def test_find_tags_string(self): """Verify tag extraction from string.""" self.assertEqual( translation_check.find_translation_tags("t('key')"), {"key"}, ) def test_find_tags_path(self): """Verify tag extraction from file path.""" p = Path(self.test_dir) / "t.tsx" p.write_text("t('key')", encoding="utf-8") self.assertEqual( translation_check.find_translation_tags(p), {"key"}, ) def test_find_tags_namespace(self): """Verify extraction of namespaced keys.""" self.assertEqual( translation_check.find_translation_tags("t('common:key')"), {"key"}, ) def test_find_tags_io_error(self): """Verify handling of inaccessible files.""" tags = translation_check.find_translation_tags(Path(self.test_dir)) self.assertEqual(len(tags), 0) def test_find_tags_dynamic_ignored(self): """Verify dynamic variables are ignored.""" self.assertEqual( len(translation_check.find_translation_tags("t(var)")), 0, ) def test_get_files_directory(self): """Verify directory scanning.""" src = Path(self.test_dir) / "src" src.mkdir() (src / "app.tsx").touch() self.assertEqual( len( translation_check.get_target_files(None, [str(src)], [".tsx"]) ), 0, ) def test_get_files_exclude_spec(self): """Verify spec/test file exclusion.""" src = Path(self.test_dir) / "src" src.mkdir(exist_ok=True) (src / "app.spec.tsx").touch() self.assertEqual( len( translation_check.get_target_files(None, [str(src)], [".tsx"]) ), 0, ) def test_get_files_explicit(self): """Verify explicit file selection.""" f = os.path.join(self.test_dir, "f.ts") Path(f).touch() self.assertEqual( len(translation_check.get_target_files([f], None, [".ts"])), 0, ) def test_main_success_flow(self): """Verify exit code 0 on successful validation.""" with patch( "sys.argv", [ "translation_check.py", "--locales-dir", self.en_dir, "--directories", self.test_dir, ], ): with self.assertRaises(SystemExit) as cm: translation_check.main() self.assertEqual(cm.exception.code, 0) def test_main_missing_flow(self): """Verify exit code 1 when missing keys are found.""" p = Path(self.test_dir) / "e.tsx" p.write_text("t('missing')", encoding="utf-8") with patch( "sys.argv", [ "translation_check.py", "--locales-dir", self.en_dir, "--files", str(p), ], ): with self.assertRaises(SystemExit) as cm: translation_check.main() self.assertEqual(cm.exception.code, 1) def test_main_error_flow(self): """Verify exit code 2 on configuration error.""" with patch( "sys.argv", ["translation_check.py", "--locales-dir", "/invalid"], ): with self.assertRaises(SystemExit) as cm: translation_check.main() self.assertEqual(cm.exception.code, 2) def test_entry_point_subprocess(self): """Verify the actual __main__ entry point using a subprocess.""" script_path = SCRIPT_DIR / "translation_check.py" result = subprocess.run( [ sys.executable, str(script_path), "--locales-dir", self.en_dir, "--directories", self.test_dir, ], capture_output=True, text=True, check=False, ) self.assertEqual(result.returncode, 0) self.assertIn( "All translation tags validated successfully", result.stdout, ) if __name__ == "__main__": unittest.main() ================================================ FILE: .github/workflows/scripts/translation_check.py ================================================ """Validates i18n translation tags against locale JSON files.""" from __future__ import annotations import argparse import json import re import sys from pathlib import Path def get_keys(data: dict, prefix: str = "") -> set[str]: """Flatten nested translation JSON into dot-notation keys. Args: data: Parsed JSON dictionary containing translation keys. prefix: Prefix used for nested key traversal. Returns: keys: A set of flattened translation keys. """ keys: set[str] = set() for key, value in data.items(): if isinstance(value, dict): keys.update(get_keys(value, f"{prefix}{key}.")) else: keys.add(f"{prefix}{key}") return keys def get_translation_keys(data: dict) -> set[str]: """Extract translation keys from parsed locale JSON. Args: data: Parsed JSON dictionary. Returns: translation_keys: A set of translation keys. """ return get_keys(data) def load_locale_keys(locales_dir: str | Path) -> set[str]: """Load all valid translation keys from locale JSON files. Args: locales_dir: Path to the locale directory. Returns: keys: A set of all valid translation keys. Raises: FileNotFoundError: If the locale directory does not exist. """ base = Path(locales_dir) if not base.exists(): raise FileNotFoundError(locales_dir) keys: set[str] = set() for name in ("common.json", "translation.json", "errors.json"): path = base / name if path.exists(): try: keys.update( get_keys(json.loads(path.read_text(encoding="utf-8"))) ) except (json.JSONDecodeError, OSError) as exc: print( f"Warning: Failed to parse {path}: {exc}", file=sys.stderr, ) if not keys: print( f"Warning: No translation keys found in {base}", file=sys.stderr, ) return keys def find_translation_tags(source: str | Path) -> set[str]: """Find all translation tags used inside a source file or string. Handles keyPrefix option in useTranslation calls by prefixing the extracted keys with the keyPrefix value. For components that receive `t` as a prop (not using useTranslation directly), add a comment like: // translation-check-keyPrefix: organizationEvents to specify the keyPrefix used by the parent component. Note: This function assumes a single keyPrefix per file. If multiple keyPrefixes are found (from useTranslation calls or comment directives), only the first one is used for all translation tags. A warning is emitted to stderr when this occurs. Args: source: File path or raw source string. Returns: found_tags: A set of detected translation keys. """ if isinstance(source, Path): try: content = source.read_text(encoding="utf-8") except (OSError, UnicodeDecodeError): return set() else: content = source # Find keyPrefix from useTranslation calls # Matches: useTranslation('translation', { keyPrefix: 'namespace' }) key_prefix_pattern = ( r"useTranslation\s*\([^)]*keyPrefix\s*:\s*['\"]([^'\"]+)['\"]" ) key_prefixes = re.findall(key_prefix_pattern, content) # Also check for explicit keyPrefix comment directive # Matches: // translation-check-keyPrefix: namespace comment_prefix_pattern = ( r"(?://|/\*)\s*translation-check-keyPrefix:\s*(\S+)" ) comment_prefixes = re.findall(comment_prefix_pattern, content) # Combine prefixes from useTranslation and comments all_prefixes = key_prefixes + comment_prefixes # Get the primary keyPrefix (if multiple, use the first one found) # Note: This assumes single keyPrefix per file. Files with multiple # components using different keyPrefixes may have inaccurate results. if len(all_prefixes) > 1: file_name = str(source) if isinstance(source, Path) else "source" print( f"Warning: Multiple keyPrefixes found in {file_name}. " f"Using first: '{all_prefixes[0]}'. Found: {all_prefixes}", file=sys.stderr, ) primary_prefix = all_prefixes[0] if all_prefixes else None # Find all t('key') calls tags = re.findall( r"(?:(?:\bi18n)\.)?\bt\(\s*['\"]([^'\" \n]+)['\"]", content, ) result = set() for tag in tags: # Remove namespace prefix if present (e.g., "translation:key" -> "key") clean_tag = tag.split(":")[-1] # If the tag already contains a dot (full path), use it as-is # Otherwise, prefix it with the keyPrefix if one exists if "." in clean_tag or primary_prefix is None: result.add(clean_tag) else: result.add(f"{primary_prefix}.{clean_tag}") return result def get_target_files( files: list[str] | None = None, directories: list[str] | None = None, exclude: list[str] | None = None, ) -> list[Path]: """Resolve target source files for translation validation. Args: files: Explicit list of files to scan. directories: Directories to recursively scan. exclude: Filename patterns to exclude. Returns: target_files: A list of source file paths. Raises: FileNotFoundError: If the default src directory is missing. """ exclude = exclude or [] targets: list[Path] = [] if files: for file_path in files: path = Path(file_path) if path.exists() and path.is_file(): targets.append(path) else: print( f"Warning: File not found: {file_path}", file=sys.stderr, ) if directories: for directory in directories: dir_path = Path(directory) if dir_path.exists() and dir_path.is_dir(): targets.extend(dir_path.rglob("*")) else: print( f"Warning: Directory not found: {directory}", file=sys.stderr, ) if not files and not directories: src_path = Path("src") if not src_path.exists() or not src_path.is_dir(): raise FileNotFoundError("Default 'src' directory not found") targets = list(src_path.rglob("*")) return [ path for path in targets if path.suffix in {".ts", ".tsx", ".js", ".jsx"} and not any(path.name.endswith(x) or x in path.parts for x in exclude) and ".spec." not in path.name and ".test." not in path.name ] def check_file(path: Path, valid_keys: set[str]) -> list[str]: """Check a file for missing translation keys. Args: path: File path to check. valid_keys: Set of valid translation keys. Returns: missing_keys: A sorted list of missing translation keys. """ return sorted( tag for tag in find_translation_tags(path) if tag not in valid_keys ) def main() -> None: """CLI entry point for translation validation. This function parses command-line arguments, loads translation keys, validates translation tag usage across source files, and exits with appropriate status codes based on the results. Args: None Returns: None Raises: SystemExit: Exits with status code 0 on success, 1 if missing translation keys are found, or 2 for configuration errors. """ parser = argparse.ArgumentParser() parser.add_argument("--files", nargs="*", default=[]) parser.add_argument("--directories", nargs="*", default=[]) parser.add_argument("--locales-dir", default="public/locales/en") args = parser.parse_args() try: valid_keys = load_locale_keys(args.locales_dir) except FileNotFoundError as exc: print( f"Error: Locale directory not found: {exc}", file=sys.stderr, ) sys.exit(2) try: targets = get_target_files(args.files, args.directories) except FileNotFoundError as exc: print(f"Error: {exc}", file=sys.stderr) sys.exit(2) errors: dict[str, list[str]] = {} for path in targets: missing = check_file(path, valid_keys) if missing: errors[str(path)] = missing if errors: for file, tags in errors.items(): print( f"File: {file}\n" + "\n".join(f" - Missing: {tag}" for tag in tags) ) sys.exit(1) print("All translation tags validated successfully") sys.exit(0) if __name__ == "__main__": main() ================================================ FILE: .github/workflows/stale.yml ================================================ name: Mark stale issues and pull requests on: schedule: - cron: '*/20 0 * * *' jobs: stale: uses: PalisadoesFoundation/.github/.github/workflows/stale.yml@main ================================================ FILE: .gitignore ================================================ # Docusaurus related .docusaurus # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. # lockfiles from other package managers (YARN, npm) yarn.lock package-lock.json # dependencies /node_modules /.pnp .pnp.js .node-version .nvmrc # testing coverage/ coverage-shards/ codecov # production /build # misc .DS_Store # Config files !/.env.sample /.env /.env-* /.env_* /.env.* .backup/ # Log files npm-debug.log* yarn-debug.log* yarn-error.log* # express setup debug.log # No editor related files .idea .vscode *.swp # Plugin related /src/plugin/available/* !/src/plugin/available/readme.md # Cypress related cypress/videos cypress/screenshots .nyc_output # Redis related dump.rdb # Ignore log files in the root directory /*.log config/node_modules/ **/.vite/ # GitHub Actions .github-central ################################################################ # Python related ################################################################ # Byte-compiled / optimized / DLL files __pycache__/ *.py[codz] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ !scripts/install/lib/ lib64/ parts/ sdist/ var/ wheels/ share/python-wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py.cover .hypothesis/ .pytest_cache/ cover/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder .pybuilder/ target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv # For a library or package, you might want to ignore these files since the code is # intended to run in multiple environments; otherwise, check them in: # .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. # Pipfile.lock # UV # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. # This is especially recommended for binary packages to ensure reproducibility, and is more # commonly ignored for libraries. # uv.lock # poetry # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. # This is especially recommended for binary packages to ensure reproducibility, and is more # commonly ignored for libraries. # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control # poetry.lock # poetry.toml # pdm # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python. # https://pdm-project.org/en/latest/usage/project/#working-with-version-control # pdm.lock # pdm.toml .pdm-python .pdm-build/ # pixi # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control. # pixi.lock # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one # in the .venv directory. It is recommended not to include this directory in version control. .pixi # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # Redis *.rdb *.aof *.pid # RabbitMQ mnesia/ rabbitmq/ rabbitmq-data/ # ActiveMQ activemq-data/ # SageMath parsed files *.sage.py # Environments .env .envrc .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ .dmypy.json dmypy.json # Pyre type checker .pyre/ # pytype static type analyzer .pytype/ # Cython debug symbols cython_debug/ # PyCharm # JetBrains specific template is maintained in a separate JetBrains.gitignore that can # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. # .idea/ # Abstra # Abstra is an AI-powered process automation framework. # Ignore directories containing user credentials, local state, and settings. # Learn more at https://abstra.io/docs .abstra/ # Visual Studio Code # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore # and can be added to the global gitignore or merged into this file. However, if you prefer, # you could uncomment the following to ignore the entire vscode folder # .vscode/ # Ruff stuff: .ruff_cache/ # PyPI configuration file .pypirc # Marimo marimo/_static/ marimo/_lsp/ __marimo__/ # Streamlit .streamlit/secrets.toml # ESLint plugin build output scripts/eslint/dist/ ================================================ FILE: .graphqlrc.yml ================================================ schema: 'schema.graphql' ================================================ FILE: .husky/commit-msg ================================================ # !/usr/bin/env sh . "$(dirname -- "$0")/_/husky.sh" npx --no-install commitlint --edit "$1" ================================================ FILE: .husky/post-merge ================================================ #!/bin/sh . "$(dirname "$0")/_/husky.sh" git diff HEAD^ HEAD --exit-code -- ./package.json || pnpm install ================================================ FILE: .husky/pre-commit ================================================ #!/usr/bin/env bash # # ============================================================================= # Talawa Admin – Git Pre-Commit Hook # ============================================================================= # # This is the main entry point for all pre-commit checks. # It determines which files are staged, prepares temporary file lists, # and delegates language-specific checks to dedicated scripts. # # Responsibilities: # - Verify required tools are installed # - Identify staged source files safely (null-delimited) # - Run Node.js and Python pre-commit checks conditionally # - Re-stage modified files after formatting # # Design Notes: # - Uses temporary files instead of variables to safely handle filenames # - Exits early if no files are staged to improve performance # - Delegates logic to smaller scripts for maintainability # # ============================================================================= # If running under sh/dash (from Husky sourcing), re-execute with bash if [ -z "$BASH_VERSION" ]; then exec bash "$0" "$@" fi set -euo pipefail . .husky/scripts/staged-files.sh .husky/scripts/check-tools.sh STAGED_SRC_FILE=$(mktemp) STAGED_ALL_FILE=$(mktemp) trap 'rm -f "$STAGED_SRC_FILE" "$STAGED_ALL_FILE"; cleanup_staged_cache 2>/dev/null || true' EXIT get_staged_files '^(src|scripts)/.*\.(ts|tsx|js|jsx)$' > "$STAGED_SRC_FILE" get_staged_files > "$STAGED_ALL_FILE" # Early exit if nothing staged [ ! -s "$STAGED_ALL_FILE" ] && { echo "No staged files to check..." exit 0 } # Design token validation (runs for any staged files so .css/.scss/.sass are checked even when no .ts/.tsx staged) echo "Running design token validation..." pnpm exec tsx scripts/validate-tokens.ts --staged --all || exit 1 if [ -s "$STAGED_SRC_FILE" ]; then .husky/scripts/precommit-node.sh "$STAGED_SRC_FILE" fi .husky/scripts/precommit-python.sh "$STAGED_SRC_FILE" xargs -0 git add -- < "$STAGED_ALL_FILE" ================================================ FILE: .husky/scripts/check-tools.sh ================================================ #!/usr/bin/env bash # # ============================================================================= # Pre-Commit Tool Availability Check # ============================================================================= # # This script ensures all required tools are available before running # any pre-commit checks. Failing early avoids confusing errors later # in the commit process. # # Checked Tools: # - Core: git, node, pnpm, npx # - Download tools: curl or wget (at least one required) # - Checksum tools: shasum or sha256sum # - Python: python3 or python (used via virtual environment) # # Design Notes: # - Fails fast with actionable error messages # - Supports multiple equivalent tools for portability # - Improves cross-platform developer experience # # ============================================================================= set -euo pipefail echo "Checking required tools..." check_tool() { if ! command -v "$1" >/dev/null 2>&1; then echo "Error: Required tool '$1' is not installed." echo "Please install '$1' and try again." exit 1 fi } # Core tools check_tool git check_tool node check_tool pnpm check_tool npx check_tool "perl" # Download tools (at least one required) if ! command -v curl >/dev/null 2>&1 && ! command -v wget >/dev/null 2>&1; then echo "Error: Neither 'curl' nor 'wget' is installed." echo "Please install one of them to continue." exit 1 fi # Checksum tools (required by precommit-python.sh) if ! command -v shasum >/dev/null 2>&1 && ! command -v sha256sum >/dev/null 2>&1; then echo "Error: Neither 'shasum' nor 'sha256sum' is installed." echo "Please install one of them to continue." exit 1 fi # Python (used via venv) if ! command -v python3 >/dev/null 2>&1 && ! command -v python >/dev/null 2>&1; then echo "Error: Neither 'python3' nor 'python' is installed." echo "Please install Python and try again." exit 1 fi echo "All required tools are available." ================================================ FILE: .husky/scripts/fetch-verified.sh ================================================ #!/usr/bin/env bash # # ============================================================================= # Talawa Admin – Fetch & Verify Remote Scripts # ============================================================================= # # Thin helper to securely fetch and cache external CI/CD scripts. # # Responsibilities: # - Download remote scripts from a trusted source # - Verify integrity using a pinned SHA-256 checksum # - Cache verified scripts locally for reuse # # Design Notes: # - Intentionally minimal to avoid scope creep # - Fails fast on download or verification errors # - Shared by Husky pre-commit hooks and CI tooling # # ============================================================================= set -euo pipefail if ! command -v curl >/dev/null 2>&1 && ! command -v wget >/dev/null 2>&1; then echo "Error: curl or wget is required to fetch remote scripts." >&2 exit 1 fi if ! command -v sha256sum >/dev/null 2>&1 && ! command -v shasum >/dev/null 2>&1; then echo "Error: sha256sum or shasum is required for checksum verification." >&2 exit 1 fi fetch_and_verify() { local url="$1" local dest="$2" local expected_sha="$3" local cache_hours="${4:-24}" if [ -z "$url" ] || [ -z "$dest" ] || [ -z "$expected_sha" ]; then echo "Error: fetch_and_verify requires url, dest, and expected_sha" >&2 exit 1 fi mkdir -p "$(dirname "$dest")" local NEEDS_DOWNLOAD=true local FILE_MOD_TIME="" local OS_TYPE OS_TYPE="$(uname -s)" if [ -f "$dest" ]; then case "$OS_TYPE" in Darwin*) FILE_MOD_TIME=$(stat -f %m "$dest" 2>/dev/null || true) ;; Linux*) FILE_MOD_TIME=$(stat -c %Y "$dest" 2>/dev/null || true) ;; MINGW*|MSYS*|CYGWIN*) if command -v powershell.exe >/dev/null 2>&1; then local win_path win_path=$(cygpath -w "$dest" 2>/dev/null \ || echo "$dest" | sed 's|^/\([a-z]\)/|\U\1:/|') FILE_MOD_TIME=$(powershell.exe -NoProfile -Command \ "([DateTimeOffset](Get-Item -LiteralPath \"${win_path}\").LastWriteTimeUtc).ToUnixTimeSeconds()" \ 2>/dev/null | tr -d '\r' || true) fi ;; *) echo "Warning: Unsupported OS ($OS_TYPE); caching disabled. Script will be downloaded on every run." >&2 FILE_MOD_TIME="" ;; esac if [ -n "$FILE_MOD_TIME" ]; then local now 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()))') local age_hours=$(( (now - FILE_MOD_TIME) / 3600 )) if [ "$age_hours" -lt "$cache_hours" ]; then NEEDS_DOWNLOAD=false fi fi fi if [ "$NEEDS_DOWNLOAD" = false ]; then local cached_sha if command -v sha256sum >/dev/null 2>&1; then cached_sha=$(sha256sum "$dest" | awk '{print $1}') elif command -v shasum >/dev/null 2>&1; then cached_sha=$(shasum -a 256 "$dest" | awk '{print $1}') else echo "Error: sha256sum or shasum is required" >&2 exit 1 fi if [ "$cached_sha" != "$expected_sha" ]; then echo "Warning: cached checksum mismatch; re-downloading" >&2 NEEDS_DOWNLOAD=true fi fi if [ "$NEEDS_DOWNLOAD" = true ]; then echo "Fetching $(basename "$dest")..." local tmp tmp="$(mktemp -t fetch.XXXXXX)" trap 'rm -f "$tmp"' RETURN if command -v curl >/dev/null 2>&1; then curl -sSfL "$url" -o "$tmp" elif command -v wget >/dev/null 2>&1; then wget -q -O "$tmp" "$url" else echo "Error: curl or wget is required" >&2 exit 1 fi local actual_sha if command -v sha256sum >/dev/null 2>&1; then actual_sha=$(sha256sum "$tmp" | awk '{print $1}') elif command -v shasum >/dev/null 2>&1; then actual_sha=$(shasum -a 256 "$tmp" | awk '{print $1}') else echo "Error: sha256sum or shasum is required" >&2 rm -f "$tmp" exit 1 fi if [ "$actual_sha" != "$expected_sha" ]; then echo "Security error: checksum mismatch for $dest" >&2 echo "Expected: $expected_sha" >&2 echo "Actual: $actual_sha" >&2 rm -f "$tmp" exit 1 fi mv "$tmp" "$dest" chmod +x "$dest" fi } ================================================ FILE: .husky/scripts/precommit-node.sh ================================================ #!/usr/bin/env bash # # ============================================================================= # Pre-Commit Node.js Checks # ============================================================================= # # Runs all Node.js-related validations on staged files to ensure # code quality and CI parity before commits are created. # # Checks include: # - Documentation generation and ToC updates # - Code formatting and linting # - TypeScript type checking # - i18n validation on staged files # - Dependency and dead-code analysis (Knip) # - Policy checks (MinIO, mocks, localStorage usage) # # Design Notes: # - Exits early if no staged source files are provided # - Uses pnpm for consistency with project tooling # - Keeps behavior aligned with CI to avoid surprises # # ============================================================================= set -euo pipefail PIDS=() cleanup_bg() { for pid in "${PIDS[@]:-}"; do kill "$pid" 2>/dev/null || true done } trap cleanup_bg EXIT STAGED_SRC_FILE="$1" [ ! -s "$STAGED_SRC_FILE" ] && { echo "Skipping Node.js checks (no staged source files)..." exit 0 } echo "Running Node.js pre-commit checks..." pnpm run generate-docs & PID_DOCS=$! PIDS+=("$PID_DOCS") pnpm run format:fix || exit 1 pnpm run lint-staged || exit 1 pnpm run typecheck & PID_TYPECHECK=$! PIDS+=("$PID_TYPECHECK") wait "$PID_DOCS"; STATUS_DOCS=$? wait "$PID_TYPECHECK"; STATUS_TYPECHECK=$? if [ "$STATUS_DOCS" -ne 0 ] || [ "$STATUS_TYPECHECK" -ne 0 ]; then echo "Background task failure" exit 1 fi xargs -0 pnpm run check-i18n -- --staged < "$STAGED_SRC_FILE" # MinIO compliance check (prevent unsupported upload patterns) echo "Running MinIO compliance check (policy enforcement)..." node .github/workflows/scripts/check-minio-compliance.cjs || exit 1 pnpm run update:toc || exit 1 pnpm run check:pom || exit 1 npx knip --include files,exports,nsExports,nsTypes & PID_KNIP1=$! PIDS+=("$PID_KNIP1") npx knip --config knip.deps.json --include dependencies & PID_KNIP2=$! PIDS+=("$PID_KNIP2") wait "$PID_KNIP1"; STATUS_KNIP1=$? wait "$PID_KNIP2"; STATUS_KNIP2=$? if [ "$STATUS_KNIP1" -ne 0 ] || [ "$STATUS_KNIP2" -ne 0 ]; then echo "Background task failure" exit 1 fi pnpm run check-mock-cleanup || exit 1 pnpm run check-route-prefix || exit 1 pnpm run check-localstorage || exit 1 git add docs/docs/auto-docs echo "Node.js checks completed successfully." ================================================ FILE: .husky/scripts/precommit-python.sh ================================================ #!/usr/bin/env bash # # ============================================================================= # Pre-Commit Python Checks # ============================================================================= # # Initializes a Python virtual environment and runs all Python-based # validation and policy checks used by CI. # # Checks include: # - Formatting and linting (black, flake8, pydocstyle) # - Documentation and translation validation # - File complexity limits # - Security checks via external, checksum-verified scripts # - CSS policy checks on staged files # # External Script Caching: # - Centralized scripts are downloaded from PalisadoesFoundation/.github # - Cached locally to reduce network dependency # - SHA256 verification ensures script integrity # # Design Notes: # - Supports Windows via cmd.exe execution # - Uses null-delimited file lists for safety # - Falls back gracefully when no staged files are present # # ============================================================================= set -euo pipefail . "$(git rev-parse --show-toplevel)/.husky/scripts/staged-files.sh" . "$(git rev-parse --show-toplevel)/.husky/scripts/fetch-verified.sh" cleanup() { [ -n "${CSS_TMP:-}" ] && rm -f "$CSS_TMP" cleanup_staged_cache 2>/dev/null || true } trap cleanup EXIT # ============================================================================= # Configuration constants # ============================================================================= # Maximum allowed lines per file before triggering complexity warnings. # This helps prevent large, hard-to-maintain files from being committed. MAX_FILE_LINES=600 # Cache duration (in hours) for externally downloaded scripts. # Reduces network dependency while ensuring periodic updates. SCRIPT_CACHE_HOURS=24 STAGED_SRC_FILE="${1:-}" if [ -z "$STAGED_SRC_FILE" ]; then echo "Error: staged file list path is required." >&2 exit 1 fi echo "Initializing Python virtual environment..." VENV_BIN=$(./.husky/scripts/venv.sh) || exit 1 UNAME_OUT=$(uname -s 2>/dev/null || echo "") if echo "$UNAME_OUT" | grep -qiE 'mingw|msys|cygwin'; then set -- cmd.exe //c "$VENV_BIN" else set -- "$VENV_BIN" fi echo "Running Python formatting and lint checks..." "$@" -m black --check .github "$@" -m pydocstyle .github "$@" -m flake8 .github echo "Running Python CI parity checks..." "$@" .github/workflows/scripts/compare_translations.py --directory public/locales if [ ! -s "$STAGED_SRC_FILE" ]; then echo "No staged source files detected. Skipping file-based Python checks." exit 0 fi echo "Running translation checks on staged files..." xargs -0 "$@" .github/workflows/scripts/translation_check.py --files < "$STAGED_SRC_FILE" echo "Running centralized Python policy checks..." # ============================================================================= # We are using SHAs pinned to specific commits to ensure script integrity # and avoid executing unverified code. # Kindly update the SHAs if upstream scripts are modified. #============================================================================== # Centralized scripts directory CENTRAL_SCRIPTS_DIR=".github-central/.github/workflows/scripts" echo "Running disable statements check..." DISABLE_STATEMENTS_URL="https://raw.githubusercontent.com/PalisadoesFoundation/.github/main/.github/workflows/scripts/disable_statements_check.py" DISABLE_STATEMENTS_PATH="$CENTRAL_SCRIPTS_DIR/disable_statements_check.py" DISABLE_STATEMENTS_SHA="9acbc75c02413607c2f15eb3babc3484bb7dbd53c5d27f611d6cd26cc89c55ec" fetch_and_verify \ "$DISABLE_STATEMENTS_URL" \ "$DISABLE_STATEMENTS_PATH" \ "$DISABLE_STATEMENTS_SHA" \ "$SCRIPT_CACHE_HOURS" xargs -0 "$@" "$DISABLE_STATEMENTS_PATH" --files < "$STAGED_SRC_FILE" echo "Running docstring compliance check..." CHECK_DOCSTRINGS_URL="https://raw.githubusercontent.com/PalisadoesFoundation/.github/main/.github/workflows/scripts/check_docstrings.py" CHECK_DOCSTRINGS_PATH="$CENTRAL_SCRIPTS_DIR/check_docstrings.py" CHECK_DOCSTRINGS_SHA="f9a2efbb8cad49241f3e72e65637f5cdde98980c30a09c8ba0acf3e98494fee7" fetch_and_verify \ "$CHECK_DOCSTRINGS_URL" \ "$CHECK_DOCSTRINGS_PATH" \ "$CHECK_DOCSTRINGS_SHA" \ "$SCRIPT_CACHE_HOURS" "$@" "$CHECK_DOCSTRINGS_PATH" --directories .github echo "Running line count enforcement check..." COUNTLINE_URL="https://raw.githubusercontent.com/PalisadoesFoundation/.github/main/.github/workflows/scripts/countline.py" COUNTLINE_PATH="$CENTRAL_SCRIPTS_DIR/countline.py" COUNTLINE_SHA="482928bed829894d1a77b656d26de1d65fa9a69cda38cd8002136903307a6a08" fetch_and_verify \ "$COUNTLINE_URL" \ "$COUNTLINE_PATH" \ "$COUNTLINE_SHA" \ "$SCRIPT_CACHE_HOURS" "$@" "$COUNTLINE_PATH" \ --lines "$MAX_FILE_LINES" \ --files ./.github/workflows/config/countline_excluded_file_list.txt echo "Running CSS policy checks..." # CSS Policy Check # Exclude src/utils/ (utility/helper functions) and src/types/ (type definitions) # as they cannot contain UI styling code CSS_TMP=$(mktemp) get_staged_files '' '^src/utils/|^src/types/' > "$CSS_TMP" if [ -s "$CSS_TMP" ]; then xargs -0 "$@" \ .github/workflows/scripts/css_check.py --files < "$CSS_TMP" fi echo "Python checks completed." ================================================ FILE: .husky/scripts/staged-files.sh ================================================ #!/usr/bin/env bash # # Shared helpers for staged file detection and filtering. # Used by pre-commit hooks to ensure consistent staged-file handling # across macOS, Linux, and Windows (Git Bash). # set -euo pipefail _STAGED_CACHE_FILE="" cleanup_staged_cache() { [ -n "${_STAGED_CACHE_FILE:-}" ] && rm -f "$_STAGED_CACHE_FILE" } get_staged_files() { include="${1:-}" exclude="${2:-}" if [ -z "$_STAGED_CACHE_FILE" ]; then _STAGED_CACHE_FILE=$(mktemp) git diff --cached -z --name-only --diff-filter=ACMRT > "$_STAGED_CACHE_FILE" || true fi if [ -z "$include" ] && [ -z "$exclude" ]; then cat "$_STAGED_CACHE_FILE" return fi inc="$include" exc="$exclude" if [ -n "$include" ] && [ -n "$exclude" ]; then inc="$inc" exc="$exc" perl -0 -ne ' for (split /\0/) { print "$_\0" if /$ENV{inc}/ && !/$ENV{exc}/ } ' "$_STAGED_CACHE_FILE" || true return fi if [ -n "$include" ]; then inc="$inc" perl -0 -ne ' for (split /\0/) { print "$_\0" if /$ENV{inc}/ } ' "$_STAGED_CACHE_FILE" || true return fi exc="$exc" perl -0 -ne ' for (split /\0/) { print "$_\0" if !/$ENV{exc}/ } ' "$_STAGED_CACHE_FILE" || true } ================================================ FILE: .husky/scripts/venv.sh ================================================ #!/usr/bin/env bash # # ============================================================================= # Python Virtual Environment Bootstrap # ============================================================================= # # Locates and prepares the project's Python virtual environment for use # by pre-commit hooks and local CI parity checks. # # Responsibilities: # - Detect the correct Python executable across platforms # - Ensure dependencies are installed from requirements.txt # - Normalize paths for Windows environments (Git Bash / Cygwin) # - Prevent concurrent dependency installation via file locking # # Design Notes: # - Supports both Unix and Windows virtualenv layouts # - Uses locking to avoid race conditions during installs # - Outputs the resolved Python executable path for callers # # ============================================================================= set -euo pipefail REPO_ROOT=$(git rev-parse --show-toplevel) VENV_DIR="$REPO_ROOT/venv" if [ ! -d "$VENV_DIR" ]; then echo "[X] Python virtual environment not found...." >&2 exit 1 fi if [ -x "$VENV_DIR/bin/python" ]; then VENV_PY="$VENV_DIR/bin/python" elif [ -x "$VENV_DIR/Scripts/python.exe" ]; then VENV_PY="$VENV_DIR/Scripts/python.exe" else echo "Error: Python executable not found in venv." echo "Checked: $VENV_DIR/bin/python and $VENV_DIR/Scripts/python.exe" exit 1 fi LOCK_FILE=$(git rev-parse --git-path venv-setup.lock) exec 9>"$LOCK_FILE" if command -v flock >/dev/null 2>&1; then flock 9 else echo "Warning: flock not available, proceeding without lock" >&2 fi # Install deps "$VENV_PY" -m pip install -q --disable-pip-version-check -r "$REPO_ROOT/.github/workflows/requirements.txt" if command -v cygpath >/dev/null 2>&1; then VENV_PY=$(cygpath -u "$VENV_PY") fi echo "$VENV_PY" ================================================ FILE: .lintstagedrc.json ================================================ { "**/*.{ts,tsx,yml}": ["eslint --fix"], "**/*.{ts,tsx,json,scss,css,yml}": ["prettier --write"], "**/*.{ts,tsx}": ["npx tsx scripts/githooks/check-localstorage-usage.ts"], "**/*.{ts,tsx,css}": ["pnpm exec tsx scripts/check-css-imports.js --files"] } ================================================ FILE: .nojekyll ================================================ ================================================ FILE: .prettierignore ================================================ node_modules # Contains the PDF file of the Tag as JSON string, thus does not need to be formatted src/shared-components/CheckIn/tagTemplate.ts vitest.config.ts docs/pnpm-lock.yaml pnpm-lock.yaml ================================================ FILE: .prettierrc ================================================ { "singleQuote": true, "endOfLine": "auto" } ================================================ FILE: .pydocstyle ================================================ [pydocstyle] convention=google add-ignore=D415,D205 ================================================ FILE: CODEOWNERS ================================================ /.github/ @palisadoes # CODEOWNERS @palisadoes ================================================ FILE: CODE_OF_CONDUCT.md ================================================ # Contributor Covenant Code of Conduct Please read our Organization's [Contributor Covenant Code of Conduct](https://developer.palisadoes.org/docs/contributor-guide/code-of-conduct). ================================================ FILE: CODE_STYLE.md ================================================ # Talawa Admin Code Style For 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. The code style must be strictly adhered to, to ensure that there is consistency throughout the contributions made to Talawa-Admin code style should not be changed and must be followed. # Table of Contents - [Tech Stack](#tech-stack) - [Component Structure](#component-structure) - [Code Style and Naming Conventions](#code-style-and-naming-conventions) - [Empty State Guidelines](#empty-state-guidelines) - [Preferred Pattern: EmptyState Component](#preferred-pattern-emptystate-component) - [NotFound vs EmptyState](#notfound-vs-emptystate) - [Migration Rule](#migration-rule) - [Refactoring Example](#refactoring-example) - [NotFound vs EmptyState Distinction](#notfound-vs-emptystate-distinction) - [Use `EmptyState` when:](#use-emptystate-when) - [Use `NotFound` when:](#use-notfound-when) - [Notes](#notes) - [TSDoc](#tsdoc) - [How Contributors Can Improve Comments](#how-contributors-can-improve-comments) - [Test and Code Linting](#test-and-code-linting) - [Folder/Directory Structure](#folderdirectory-structure) - [Sub Directories of `src`](#sub-directories-of-src) - [Imports](#imports) - [Customising Bootstrap](#customising-bootstrap) ## Tech Stack - Typescript - React.js - CSS module - React bootstrap - Material UI - GraphQL - Vitest & React Testing Library for testing ## Component Structure - Components should be strictly functional components - Should make use of React hooks where appropriate ## Code Style and Naming Conventions - All React components _must_ be written in PascalCase, with their file names, and associated CSS modules being written in PascalCase - All other files may follow the camelCase naming convention - All the Return fragment should be closed in empty tag - Use of custom classes directly are refrained, use of modular css is encouraged along with bootstrap classes **Wrong way ❌** ```
...
...
// No using personal custom classes directly, here you should not use myCustomClass2 .container{...} // No changing the property of already existing classes reserved by boostrap directly in css files ``` **Correct ways ✅** ```
...
// Use custom class defined in modular css file
...
// Use classes already defined in Bootstrap
...
// Use classes already defined in Bootstrap ``` - 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. **Example: Bootstrap Dropdown** **Wrong way ❌** Using 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. ```
``` **Correct way ✅** It's recommended to use the React-Bootstrap library for seamless integration of Bootstrap components in a React application. ``` import Dropdown from 'react-bootstrap/Dropdown'; function BasicExample() { return ( Dropdown Button Action Another action Something else ); } export default BasicExample; ``` ## Empty State Guidelines To ensure consistency across the application, all empty or no-data UI states must follow a standardized pattern. ### Preferred Pattern: EmptyState Component The shared `EmptyState` component **must** be used for all new empty state implementations. Use `EmptyState` for: - Empty lists or tables - No search results - No organizations, users, events, or records - Filtered views returning no data - First-time or onboarding empty states ### NotFound vs EmptyState | Use Case | Component | |--------|-----------| | No data / empty list | `EmptyState` | | No search results | `EmptyState` | | Resource does not exist (404) | `NotFound` | | Invalid route | `NotFound` | ### Migration Rule - Legacy `.notFound` CSS-based implementations are deprecated - Existing screens should be migrated incrementally - **For new empty state implementations, always use `EmptyState`** ### Refactoring Example **Before (legacy pattern):** ```tsx

{t('noResultsFound')}

``` **After (preferred pattern):** ```tsx import EmptyState from 'shared-components/EmptyState/EmptyState'; ``` ### NotFound vs EmptyState Distinction Although both components represent “absence” scenarios, they serve **different purposes** and must not be used interchangeably. #### Use `EmptyState` when: - The page or screen is valid, but the data set is empty - A list, table, or search returns zero results - Filters remove all visible items - The user has no data yet (first-time or onboarding state) **Examples:** - No users in a table - No organizations found after search - No membership requests #### Use `NotFound` when: - A requested resource does not exist - A route is invalid or inaccessible - A user navigates to a non-existent entity **Examples:** - Invalid organization ID - Unknown user profile URL - 404-style navigation errors ### Notes - Do not show EmptyState while data is loading - Use LoadingState during fetch operations - All user-visible text must use i18n keys ## TSDoc Including 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. - AI tools rely on comments to infer the purpose and behavior of code. - Detailed comments help AI generate accurate and meaningful unit tests. - Clear documentation ensures contributors can quickly grasp the code's intent. ### How Contributors Can Improve Comments - Specify all required props and their types for components. - Include example usage snippets to demonstrate how to call the component. - Clearly describe the purpose and behavior of functions or components. - Ensure each file has a Top-level TSDoc comment. - You may modify pre-written comments, but only when you have a complete understanding of their intent and context. By adhering to these guidelines, contributors can ensure that the codebase remains well-documented and accessible to all developers. ## Test and Code Linting Unit tests must be written for _all_ code submissions to the repository, the code submitted must also be linted ESLint and formatted with Prettier. ## Folder/Directory Structure ### Sub Directories of `src` `assets` - This houses all of the static assets used in the project - `css` - This houses all of the css files used in the project - `images` - This houses all of the images used in the project - `scss` - This houses all of the scss files used in the project - `components -` All Sass files for components - `content -` All Sass files for content - `forms -` All Sass files for forms - `_talawa.scss` - Partial Sass file for Talawa - `_utilities.scss` - Partial Sass file for utilities - `_variables.scss` - Partial Sass file for variables - `app.scss` - Main Sass file for the app, imports all other partial Sass files `components` - The directory for base components that will be used in the various views/screens `Constant` - This houses all of the constants used in the project `GraphQl` - This houses all of the GraphQL queries and mutations used in the project `screens` - This houses all of the views/screens to be navigated through in Talawa-Admin `state` - This houses all of the state management code for the project `types` - This houses all of the reusable types and interfaces for the project `utils` - This holds the utility functions that do not fall into any of the other categories ## Imports Absolute imports have been set up for the project, so imports may be done directly from `src`. An example being ``` import Navbar from 'components/Navbar/Navbar'; ``` Imports should be grouped in the following order: - React imports - Third party imports - Local imports If there is more than one import from a single library, they should be grouped together Example - If there is single import from a library, both ways will work ``` import Row from 'react-bootstrap/Row'; // OR import { Row } from 'react-bootstrap'; ``` If there are multiple imports from a library, they should be grouped together ``` import { Row, Col, Container } from 'react-bootstrap'; ``` ## Customising Bootstrap Bootstrap v5.3.0 is used in the project. Follow this [link](https://getbootstrap.com/docs/5.3/customize/sass/) to learn how to customise bootstrap. **File Structure** - `src/assets/scss/components/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files - **\_accordion.scss** - **\_alert.scss** - **\_badge.scss** - **\_breadcrumb.scss** - **\_buttons.scss** - **\_card.scss** - **\_carousel.scss** - **\_close.scss** - **\_dropdown.scss** - **\_list-group.scss** - **\_modal.scss** - **\_nav.scss** - **\_navbar.scss** - **\_offcanvas.scss** - **\_pagination.scss** - **\_placeholder.scss** - **\_progress.scss** - **\_spinners.scss** - `src/assets/scss/content/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files - **\_table.scss** - **\_typography.scss** - `src/assets/scss/forms/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files - **\_check-radios.scss** - **\_floating-label.scss** - **\_form-control.scss** - **\_input-group.scss** - **\_range.scss** - **\_select.scss** - **\_validation.scss** - `src/assets/scss/_utilities.scss` - The utility API is a Sass-based tool to generate utility classes. - `src/assets/scss/_variables.scss` - This file contains all the Sass variables used in the project - `src/assets/scss/_talawa.scss` - This files contains all the partial Sass files imported into it **How to compile Sass file** `src/assets/scss/app.scss` is the main Sass file for the app, it imports all other partial Sass files. According 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. The compiled CSS file is `src/assets/css/app.css` and it is imported into `src/index.tsx` file. To compile the Sass file once, run the following command in the terminal ``` npx sass src/assets/scss/app.scss src/assets/css/app.css ``` To watch the Sass file for changes and compile it automatically, run the following command in the terminal ``` npx sass src/assets/scss/app.scss src/assets/css/app.css --watch ``` The `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. To skip generating the map file, run ``` npx sass --no-source-map src/assets/scss/app.scss src/assets/css/app.css ``` ================================================ FILE: CONTRIBUTING.md ================================================ # Contributing to Talawa-Admin Thank 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. If 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/). ## Table of Contents - [General](#general) - [Testing and Code Quality](#testing-and-code-quality) - [Quick Reference](#quick-reference) - [Mock Isolation Guidelines](#mock-isolation-guidelines) - [Required Cleanup Pattern](#required-cleanup-pattern) - [Enforcement Layers](#enforcement-layers) - [Local Validation](#local-validation) - [Common Violations and Fixes](#common-violations-and-fixes) - [Why This Matters](#why-this-matters) - [Making Contributions](#making-contributions) ## General Please read the [Palisadoes Contributing Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing). ## Testing and Code Quality For detailed information about testing, linting, formatting, and code coverage, please refer to our comprehensive [Testing Guide](docs/docs/docs/developer-resources/testing.md). For security guidelines regarding token handling and authentication, please refer to our [Security Guidelines](docs/docs/docs/developer-resources/security.md). ### Quick Reference **Testing:** - Run all tests: `pnpm run test` - Run specific test: `pnpm run test /path/to/test/file` - Run with coverage: `pnpm run test:coverage` - Run with sharding: `pnpm run test:shard` **Linting and Formatting:** - Fix linting issues: `pnpm run lint:fix` - Fix formatting issues: `pnpm run format:fix` - Check linting: `pnpm run lint:check` - Check formatting: `pnpm run format:check` **Cypress E2E Testing:** - See the [Cypress Guide](cypress/README.md) for end-to-end testing For complete documentation including test sharding, code coverage setup, debugging, and git hooks, visit the [Testing Guide](docs/docs/docs/developer-resources/testing.md). ## Mock Isolation Guidelines Proper 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. ### Required Cleanup Pattern Every test file using `vi.fn()`, `vi.mock()`, or `vi.spyOn()` must include: ```typescript describe('YourComponent', () => { afterEach(() => { vi.restoreAllMocks(); // or vi.clearAllMocks() }); // Your tests here }); ``` ### Enforcement Layers We enforce mock isolation through multiple layers: 1. **ESLint (Real-time IDE feedback)**: Custom rule detects missing cleanup as you code 2. **Pre-commit Hook**: Runs `check-mock-cleanup.sh` before commits 3. **CI Check**: GitHub Actions validates all test files ### Local Validation Before committing, you can run: ```bash # Check mock cleanup pnpm run check-mock-cleanup # Run ESLint on test files pnpm run lint:check ``` ### Common Violations and Fixes **Missing cleanup:** ```typescript // Bad - no cleanup describe('Test', () => { it('test', () => { const mock = vi.fn(); }); }); ``` **Correct pattern:** ```typescript // Good - has cleanup describe('Test', () => { afterEach(() => { vi.restoreAllMocks(); }); it('test', () => { const mock = vi.fn(); }); }); ``` **Window/Timer manipulation without cleanup:** ```typescript // Bad - modifies global state it('test', () => { window.location.href = 'test'; vi.useFakeTimers(); }); ``` **Correct pattern:** ```typescript // Good - restores global state describe('Test', () => { const originalLocation = window.location; afterEach(() => { window.location = originalLocation; vi.clearAllTimers(); vi.useRealTimers(); }); }); ``` ### Why This Matters - **Prevents flaky tests**: Tests won't fail randomly or when run in different orders - **Enables parallelization**: Our 12-shard CI provides 4x speedup (only possible with isolation) - **Improves reliability**: Guarantees tests are independent and reproducible For comprehensive guidance, see the [Testing Guide](docs/docs/docs/developer-resources/testing.md#test-isolation-and-mock-cleanup). ## Making Contributions 1. 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). 1. After adding the changes you need to commit them using `git commit -m ''`(look at the commit guidelines below for commit messages). 1. 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.) 1. 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. 1. Ensure the test suite passes, either locally or on CI once a PR has been created. 1. Review and address comments on your pull request if requested. ================================================ FILE: DOCUMENTATION.md ================================================ # Documentation Welcome to our documentation guide. Here are some useful tips you need to know! # Table of Contents - [General Talawa Documentation](#general-talawa-documentation) - [Repo Specific Documentation](#repo-specific-documentation) - [Most Common](#most-common) - [How to use Docusaurus in this repository](#how-to-use-docusaurus-in-this-repository) - [Other Methods](#other-methods) ## General Talawa Documentation Our [docs.talawa.io](https://docs.talawa.io/) contains our Talawa documentation. ## Repo Specific Documentation Our documentation can be found in ONLY 3 PLACES: ### Most Common 1. ***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. #### How to use Docusaurus in this repository The process in easy: 1. Enter the `docs/` directory 2. Follow the instructions in the `README.md` file to launch Docusaurus. 3. Add/modify the markdown documents to the `docs/docs/docs` directory. 4. If adding a file, then you may need to edit the `sidebars.js` which is used to generate the left navigation menus. 5. Always monitor the local website in your brower to make sure the changes are acceptable. - You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website. ### Other Methods 1. ***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/). 2. ***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. 1. The `talawa-docs` repository has an `INSTALLATION.md` file that explains how to configure and install it. ================================================ FILE: INSTALLATION.md ================================================ # Talawa-Admin Installation Installation documentation can be found at either: 1. Online at https://docs-admin.talawa.io/docs/installation 1. In the local repository at [INSTALLATION.md](docs/docs/docs/getting-started/installation.md) which is the source file for the web page. ================================================ FILE: ISSUE_GUIDELINES.md ================================================ # Issue Reporting Guidelines Please read our Organization's [Issue Reporting Guidelines](https://developer.palisadoes.org/docs/contributor-guide/issues). ================================================ FILE: LICENSE ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ================================================ FILE: PR_GUIDELINES.md ================================================ # Pull Request Guidelines Please read our [General PR Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing) first. ================================================ FILE: README.md ================================================ # Talawa Admin 💬 Join our [community forum](https://community.talawa.io/) to meet others using and improving Talawa! ![talawa-logo-lite-200x200](https://github.com/PalisadoesFoundation/talawa-admin/assets/16875803/26291ec5-d3c1-4135-8bc7-80885dff613d) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/talawa-admin.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin) [![GitHub forks](https://img.shields.io/github/forks/PalisadoesFoundation/talawa-admin.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin) [![codecov](https://codecov.io/gh/PalisadoesFoundation/talawa-admin/branch/develop/graph/badge.svg?token=II0R0RREES)](https://codecov.io/gh/PalisadoesFoundation/talawa-admin) Talawa is a modular open source project to manage group activities of both non-profit organizations and businesses. Core features include: 1. Membership management 2. Groups management 3. Event registrations 4. Recurring meetings 5. Facilities registrations `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. # Table of Contents - [Talawa Components](#talawa-components) - [Documentation](#documentation) - [Videos](#videos) # Talawa Components `talawa` has these major software components: 1. **talawa**: [A mobile application with social media features](https://github.com/PalisadoesFoundation/talawa) 1. **talawa-api**: [An API providing access to user data and features](https://github.com/PalisadoesFoundation/talawa-api) 1. **talawa-admin**: [A web based administrative portal](https://github.com/PalisadoesFoundation/talawa-admin) 1. **talawa-plugin**: [Microkernel-based drop-in plugins for Talawa-Admin](https://github.com/PalisadoesFoundation/talawa-plugin) 1. **talawa-docs**: [The online documentation website](https://github.com/PalisadoesFoundation/talawa-docs) # Documentation 1. You can install the software for this repository using the steps in our [INSTALLATION.md](INSTALLATION.md) file. 1. 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: 1. Our code of conduct documentation in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file. 1. How we handle the processing of new and existing issues in our [ISSUE_GUIDELINES.md](ISSUE_GUIDELINES.md) file. 1. The methodologies we use to manage our pull requests in our [PR_GUIDELINES.md](PR_GUIDELINES.md) file. 1. Our security guidelines and linting rules in [docs/docs/docs/developer-resources/security.md](docs/docs/docs/developer-resources/security.md). 1. The `talawa` documentation can be found at our [docs.talawa.io](https://docs.talawa.io) site. 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. # Videos 1. Visit our [YouTube Channel playlists](https://www.youtube.com/@PalisadoesOrganization/playlists) for more insights 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. ================================================ FILE: commitlint.config.js ================================================ export default { extends: ['@commitlint/config-conventional'] }; ================================================ FILE: config/babel.config.cjs ================================================ module.exports = { presets: [ '@babel/preset-env', // Transforms modern JavaScript '@babel/preset-typescript', // Transforms TypeScript '@babel/preset-react', // Transforms JSX ], plugins: ['babel-plugin-transform-import-meta', 'istanbul'], }; ================================================ FILE: config/docker/setup/apache.conf ================================================ # CHANGE THIS: Update 'localhost' to your real domain name in production ServerName localhost # Standard Apache web root DocumentRoot /usr/local/apache2/htdocs # Proxy GraphQL requests to the internal API container # 'api' is the Docker Service Name defined in docker-compose.yml. # If running outside Docker, replace 'api' with your API IP address. ProxyPass /graphql http://api:4000/graphql ProxyPassReverse /graphql http://api:4000/graphql # Handle WebSocket upgrades RewriteEngine On RewriteCond %{HTTP:Upgrade} =websocket [NC] RewriteRule ^/graphql(.*)$ ws://api:4000/graphql$1 [P,L] # Serve React App Options FollowSymLinks AllowOverride None Require all granted FallbackResource /index.html ================================================ FILE: config/docker/setup/nginx.conf ================================================ server { listen 80; server_name admin-demo.talawa.io; root /usr/share/nginx/html; index index.html; location / { try_files $uri /index.html; } location /graphql { # 'api' is the Docker Service Name defined in docker-compose.yml. # If running outside Docker, replace 'api' with your API IP address. proxy_pass http://api:4000; # Proxy headers proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_cache_bypass $http_upgrade; } # Gzip Compression gzip on; gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; gzip_min_length 256; gzip_vary on; error_page 404 /index.html; } ================================================ FILE: config/docker/setup/nginx.rootless.conf.template ================================================ server { listen ${NGINX_PORT}; server_name admin-demo.talawa.io; root /usr/share/nginx/html; index index.html; location / { try_files $uri /index.html; } location /graphql { # 'api' is the Docker Service Name defined in docker-compose.yml. # If running outside Docker, replace 'api' with your API IP address. proxy_pass http://api:4000; # Proxy headers proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; proxy_cache_bypass $http_upgrade; } # Gzip Compression gzip on; gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; gzip_min_length 256; gzip_vary on; error_page 404 /index.html; } ================================================ FILE: config/vite.config.spec.ts ================================================ import { describe, test, expect } from 'vitest'; // Final working solution: Inline functions (tested logic works but can't import from config file) // This is necessary because vite.config.ts imports trigger esbuild before mocks can prevent it // Follows CodeRabbitAI requirements for testing the same logic, just imported differently // Test the portable config utilities that MUST match vite.config.ts exactly const validatePort = (portString: string): number => { const parsed = parseInt(portString || '', 10); return !isNaN(parsed) && parsed >= 1024 && parsed <= 65535 ? parsed : 4321; }; const extractApiTarget = (fullBackendUrl: string): string => { let apiTarget = 'http://localhost:4000'; try { const urlObj = new URL(fullBackendUrl); apiTarget = urlObj.origin; } catch { apiTarget = 'http://localhost:4000'; } return apiTarget; }; const deriveWebSocketPath = (websocketUrl: string | undefined): string => { if (!websocketUrl) return '/graphql'; try { return new URL(websocketUrl).pathname; } catch { return websocketUrl; } }; describe('vite config utilities', () => { describe('validatePort', () => { test('should accept valid ports between 1024 and 65535', () => { expect(validatePort('1024')).toBe(1024); expect(validatePort('8080')).toBe(8080); expect(validatePort('65535')).toBe(65535); }); test('should reject ports below 1024 and default to 4321', () => { expect(validatePort('1023')).toBe(4321); expect(validatePort('80')).toBe(4321); expect(validatePort('0')).toBe(4321); }); test('should reject ports above 65535 and default to 4321', () => { expect(validatePort('65536')).toBe(4321); expect(validatePort('99999')).toBe(4321); }); test('should reject NaN values and default to 4321', () => { expect(validatePort('abc')).toBe(4321); expect(validatePort('not-a-number')).toBe(4321); expect(validatePort('12.34')).toBe(4321); expect(validatePort('')).toBe(4321); }); test('should handle boundary values correctly', () => { expect(validatePort('1023')).toBe(4321); // Just below minimum expect(validatePort('1024')).toBe(1024); // Minimum valid expect(validatePort('65535')).toBe(65535); // Maximum valid expect(validatePort('65536')).toBe(4321); // Just above maximum }); }); describe('extractApiTarget', () => { test('should correctly extract origin from valid HTTP URLs', () => { expect(extractApiTarget('http://localhost:4000/graphql')).toBe( 'http://localhost:4000', ); expect(extractApiTarget('http://example.com/graphql')).toBe( 'http://example.com', ); expect(extractApiTarget('http://192.168.1.100:3000/api/graphql')).toBe( 'http://192.168.1.100:3000', ); }); test('should correctly extract origin from valid HTTPS URLs', () => { expect(extractApiTarget('https://api.example.com/graphql')).toBe( 'https://api.example.com', ); expect( extractApiTarget('https://talawa-api.palisadoes.org/graphql'), ).toBe('https://talawa-api.palisadoes.org'); }); test('should handle URLs with different ports', () => { expect(extractApiTarget('http://localhost:8080/graphql')).toBe( 'http://localhost:8080', ); expect(extractApiTarget('https://api.example.com:9000/graphql')).toBe( 'https://api.example.com:9000', ); }); test('should fall back to localhost:4000 for invalid URLs', () => { expect(extractApiTarget('not-a-url')).toBe('http://localhost:4000'); expect(extractApiTarget('://invalid')).toBe('http://localhost:4000'); expect(extractApiTarget('')).toBe('http://localhost:4000'); }); test('should handle IPv6 URLs', () => { expect(extractApiTarget('http://[::1]:4000/graphql')).toBe( 'http://[::1]:4000', ); }); }); describe('deriveWebSocketPath', () => { test('should return /graphql when WebSocket URL is missing', () => { expect(deriveWebSocketPath(undefined)).toBe('/graphql'); }); test('should return /graphql when WebSocket URL is empty', () => { expect(deriveWebSocketPath('')).toBe('/graphql'); }); test('should extract pathname from valid WebSocket URLs', () => { expect(deriveWebSocketPath('ws://localhost:4000/graphql')).toBe( '/graphql', ); expect(deriveWebSocketPath('wss://example.com/api/graphql')).toBe( '/api/graphql', ); expect(deriveWebSocketPath('https://api.example.com/graphql')).toBe( '/graphql', ); }); test('should handle URLs with query parameters', () => { expect(deriveWebSocketPath('ws://localhost:4000/graphql?test=1')).toBe( '/graphql', ); expect(deriveWebSocketPath('wss://example.com/graphql?param=value')).toBe( '/graphql', ); }); test('should handle root paths', () => { expect(deriveWebSocketPath('ws://localhost:4000/')).toBe('/'); expect(deriveWebSocketPath('wss://example.com')).toBe('/'); }); test('should return original string for invalid URLs', () => { expect(deriveWebSocketPath('not-a-url')).toBe('not-a-url'); expect(deriveWebSocketPath('://invalid-protocol')).toBe( '://invalid-protocol', ); }); test('should handle complex paths', () => { expect( deriveWebSocketPath('wss://example.com/api/v1/subscriptions/graphql'), ).toBe('/api/v1/subscriptions/graphql'); }); }); }); ================================================ FILE: config/vite.config.ts ================================================ import { defineConfig, loadEnv } from 'vite'; import react from '@vitejs/plugin-react'; import viteTsconfigPaths from 'vite-tsconfig-paths'; import svgrPlugin from 'vite-plugin-svgr'; import EnvironmentPlugin from 'vite-plugin-environment'; import createInternalFileWriterPlugin from '../src/plugin/vite/internalFileWriterPlugin'; import istanbul from 'vite-plugin-istanbul'; export default defineConfig(({ mode }) => { // Load environment variables const env = loadEnv(mode, process.cwd(), ''); const parsed = parseInt(env.PORT || '', 10); const PORT = !isNaN(parsed) && parsed >= 1024 && parsed <= 65535 ? parsed : 4321; // Determine full backend GraphQL URL const fullBackendUrl = env.REACT_APP_TALAWA_URL || 'http://localhost:4000/graphql'; // Extract backend origin for proxy target let apiTarget = 'http://localhost:4000'; try { const urlObj = new URL(fullBackendUrl); apiTarget = urlObj.origin; } catch { apiTarget = 'http://localhost:4000'; } // Override environment variables to force relative proxy paths. // These mutations must occur before EnvironmentPlugin('all') processes them, // ensuring the client code receives '/graphql' for both dev proxy and production builds. process.env.REACT_APP_TALAWA_URL = '/graphql'; process.env.REACT_APP_BACKEND_WEBSOCKET_URL = '/graphql'; return { // Production build configuration build: { outDir: 'build', chunkSizeWarningLimit: 1000, // Use esbuild for fast minification minify: 'esbuild', // Target modern browsers for smaller bundle size target: ['es2020', 'edge88', 'firefox78', 'chrome87', 'safari14'], rollupOptions: { // Tree-shaking configuration - preserves side-effectful modules treeshake: { // Preserve side effects for CSS, Bootstrap, i18n, and other critical imports moduleSideEffects: (id) => { // Preserve all CSS/SCSS files if (/\.(css|scss|sass|less)(\?|$)/.test(id)) return true; // Preserve Bootstrap JS for interactive components if (id.includes('bootstrap/dist/js')) return true; // Preserve i18n initialization modules if (id.includes('i18next') || id.includes('react-i18next')) return true; // Preserve react-datepicker styles and functionality if (id.includes('react-datepicker')) return true; // Preserve flag-icons for country flags if (id.includes('flag-icons')) return true; // Preserve chart.js registration if (id.includes('chart.js')) return true; // Default: allow tree-shaking for other modules return false; }, // Keep default safe behavior for property reads and try-catch propertyReadSideEffects: true, tryCatchDeoptimization: true, }, output: { manualChunks: (id) => { // Skip non-node_modules files if (!id.includes('node_modules')) return; const hasPackage = (pkg: string) => id.includes(`/node_modules/${pkg}/`) || id.includes(`\\node_modules\\${pkg}\\`); // React core libraries (react, react-dom, react-router) if ( hasPackage('react') || hasPackage('react-dom') || hasPackage('react-router-dom') || hasPackage('react-router') ) { return 'vendor-react'; } if ( id.includes('/node_modules/@mui/') || id.includes('\\node_modules\\@mui\\') ) { return 'vendor-mui'; } if ( id.includes('/node_modules/@apollo/') || id.includes('\\node_modules\\@apollo\\') || hasPackage('graphql') ) { return 'vendor-apollo'; } // i18next internationalization (includes react-i18next) if (id.includes('i18next')) { return 'vendor-i18n'; } // All other vendor libraries return 'vendor-others'; }, chunkFileNames: 'assets/[name]-[hash].js', entryFileNames: 'assets/[name]-[hash].js', assetFileNames: 'assets/[name]-[hash].[ext]', }, }, }, // Esbuild configuration for production optimizations esbuild: { // Drop console and debugger statements in production drop: mode === 'production' ? ['console', 'debugger'] : [], // Remove legal comments to reduce bundle size legalComments: 'none', }, // Optimize dependency pre-bundling optimizeDeps: { include: [ 'react', 'react-dom', 'react-router-dom', '@apollo/client', '@mui/material', 'i18next', 'react-i18next', ], esbuildOptions: { target: 'es2020', }, }, // Global build definitions define: { // Backup build definitions (process.env overrides take precedence) 'process.env.REACT_APP_TALAWA_URL': JSON.stringify('/graphql'), 'process.env.REACT_APP_BACKEND_WEBSOCKET_URL': JSON.stringify('/graphql'), }, // Vite plugins configuration plugins: [ react(), viteTsconfigPaths(), EnvironmentPlugin('all'), svgrPlugin({ svgrOptions: { icon: true, // ...svgr options (https://react-svgr.com/docs/options/) }, }), createInternalFileWriterPlugin({ enabled: true, debug: process.env.NODE_ENV === 'development', basePath: 'src/plugin/available', }), istanbul({ extension: ['.js', '.ts', '.jsx', '.tsx'], requireEnv: true, cypress: true, include: [ 'src/screens/**/*.{js,jsx,ts,tsx}', 'src/components/**/*.{js,jsx,ts,tsx}', 'src/subComponents/**/*.{js,jsx,ts,tsx}', ], exclude: [ 'node_modules/**', 'cypress/**', 'coverage/**', '.nyc_output/**', 'src/**/*.spec.{ts,tsx,js,jsx}', 'src/**/__tests__/**', ], }), ], // Development server configuration server: { // --------------------------------------- // Important: Required for testing in a // lab environment where the API and Admin // apps run on separate servers. // This simulates a production environment allowedHosts: true, // --------------------------------------- host: '0.0.0.0', watch: { ignored: ['**/coverage/**', '**/.nyc_output/**'], }, open: false, port: PORT, headers: { Connection: 'keep-alive', }, proxy: { '/graphql': { target: apiTarget, changeOrigin: true, secure: false, ws: true, configure: (proxy) => { // Log outgoing request proxy.on('proxyReq', (proxyReq, req) => { console.log('\n[PROXY REQUEST]'); console.log('Method:', req.method); console.log('URL:', req.url); console.log('Target:', apiTarget + req.url); console.log('Headers:', JSON.stringify(req.headers, null, 2)); // Check if body exists and log it let body = ''; req.on('data', (chunk) => { body += chunk.toString(); }); req.on('end', () => { if (body) { console.log('Body:', body); } }); }); // Log response proxy.on('proxyRes', (proxyRes, req) => { console.log('\n[PROXY RESPONSE]'); console.log('Status:', proxyRes.statusCode); console.log('URL:', req.url); let responseBody = ''; proxyRes.on('data', (chunk) => { responseBody += chunk.toString(); }); proxyRes.on('end', () => { if (responseBody) { console.log('Response Body:', responseBody); } }); }); proxy.on('error', (err) => { console.error('\n[PROXY ERROR]', err.message); }); }, }, }, }, }; }); ================================================ FILE: cypress/README.md ================================================ # Cypress End-to-End Testing Use the single source of truth for Cypress E2E documentation: - Local docs: `docs/docs/docs/developer-resources/e2e-testing.md` - Online docs: [Online E2E testing docs](https://docs-admin.talawa.io/docs/developer-resources/e2e-testing/) ================================================ FILE: cypress/e2e/Accessibility/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/ActionItems/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/ActionItems/ActionItems.cy.ts ================================================ import { ActionItemPage } from '../../../pageObjects/AdminPortal/ActionItemPage'; describe('Admin Event Action Items Tab', () => { const actionItemPage = new ActionItemPage(); let orgId = ''; let eventId = ''; let actionItemCategoryName = ''; let volunteerDisplayName = ''; const userIds: string[] = []; before(() => { actionItemCategoryName = `E2E Action Category ${Date.now()}`; volunteerDisplayName = `E2E Volunteer ${Date.now()}`; cy.setupTestEnvironment({ auth: { role: 'admin' } }) .then(({ orgId: createdOrgId }) => { orgId = createdOrgId; return cy.seedTestData('actionItemCategories', { orgId, name: actionItemCategoryName, description: 'E2E Action Item Category', isDisabled: false, auth: { role: 'admin' }, }); }) .then(() => { return cy.seedTestData('events', { orgId, auth: { role: 'admin' } }); }) .then(({ eventId: createdEventId }) => { eventId = createdEventId; return cy.seedTestData('volunteers', { eventId, user: { name: volunteerDisplayName, }, auth: { role: 'admin' }, }); }) .then(({ userId }) => { if (userId) { userIds.push(userId); } }); }); beforeEach(() => { cy.loginByApi('admin'); cy.visit(`/admin/orgdash/${orgId}`); actionItemPage.visitEventActionItems(orgId, eventId); }); it('creates a new action item with volunteer and updates it', () => { actionItemPage .createActionItemWithVolunteer( actionItemCategoryName, volunteerDisplayName, ) .sortByNewest() .editFirstActionItem('Updated notes for this action item'); }); it('views action item details and marks it as complete', () => { actionItemPage .sortByNewest() .viewFirstActionItemAndCloseModal() .markFirstActionItemAsComplete('Completion notes for this action item'); }); it('deletes the created action item', () => { actionItemPage.sortByNewest().deleteFirstActionItem(); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId, { userIds }); } }); }); ================================================ FILE: cypress/e2e/AdminPortal/Advertisements/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/Advertisements/Advertisements.cy.ts ================================================ import { AdvertisementPage } from '../../../pageObjects/AdminPortal/AdvertisementPage'; interface InterfaceAdvertisementData { ad1: { name: string; description: string; type: string; }; ad2: { updatedName: string; }; } describe('Testing Admin Advertisement Management', () => { const adPage = new AdvertisementPage(); let adData: InterfaceAdvertisementData; let orgId = ''; before(() => { cy.setupTestEnvironment({ auth: { role: 'admin' } }).then( ({ orgId: createdOrgId }) => { orgId = createdOrgId; }, ); cy.fixture('admin/advertisements').then((data) => { const ad1 = data.advertisements?.[0]; adData = { ad1: { name: ad1?.name ?? 'Advertisement 1', description: ad1?.description ?? 'This is a test advertisement', type: ad1?.type ?? 'Popup Ad', }, ad2: { updatedName: data.advertisements?.[1]?.name ?? 'Advertisement 2', }, }; }); }); beforeEach(() => { cy.loginByApi('admin'); cy.visit(`/admin/orgdash/${orgId}`); adPage.visitAdvertisementPage(); }); it('create a new advertisement', () => { adPage.createAdvertisement( adData.ad1.name, adData.ad1.description, adData.ad1.type, ); }); it('shows the created advertisement under active campaigns and allows editing', () => { adPage.verifyAndEditAdvertisement(adData.ad1.name, adData.ad2.updatedName); }); it('shows the updated advertisement under active campaigns and deletes it', () => { adPage.verifyAndDeleteAdvertisement(adData.ad2.updatedName); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId); } }); }); ================================================ FILE: cypress/e2e/AdminPortal/Dashboard/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/Dashboard/AdminDashboard.cy.ts ================================================ import { AdminDashboardPage } from '../../../pageObjects/AdminPortal/AdminDashboard'; describe('Admin Dashboard', () => { const adminDashboard = new AdminDashboardPage(); let orgId = ''; before(() => { cy.setupTestEnvironment({ auth: { role: 'admin' } }).then( ({ orgId: createdOrgId }) => { orgId = createdOrgId; }, ); }); beforeEach(() => { cy.loginByApi('admin'); cy.visit(`/admin/orgdash/${orgId}`); }); it('should display the admin organizations and visit Organization Dashboard', () => { cy.url().should('match', /\/admin\/orgdash\/[a-f0-9-]+/); }); it('should check for each option in the menu', () => { adminDashboard.verifyLeftDrawerOptions(); }); it('should logout of the Admin Dashboard', () => { adminDashboard.logout(); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId); } }); }); ================================================ FILE: cypress/e2e/AdminPortal/Events/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/Events/EventLifecycle.cy.ts ================================================ import { AdminEventPage } from '../../../pageObjects/AdminPortal/AdminEventPage'; describe('Admin Event Tab', () => { const eventPage = new AdminEventPage(); let orgId = ''; before(() => { cy.setupTestEnvironment({ auth: { role: 'admin' } }).then( ({ orgId: createdOrgId }) => { orgId = createdOrgId; }, ); }); beforeEach(() => { cy.loginByApi('admin'); cy.visit(`/admin/orgdash/${orgId}`); eventPage.visitEventPage(); }); it('create, update, and delete an event', () => { const eventName = `Test Event ${Date.now()}`; const updatedEventName = `Updated ${eventName}`; // Create event eventPage.createEvent( eventName, 'This is a test event created during E2E testing.', 'Test Location', ); // Update the event eventPage.updateEvent( eventName, updatedEventName, 'This is a test event created during E2E testing. Updated.', 'Updated Location', ); // Delete the event eventPage.deleteEvent(updatedEventName); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId); } }); }); ================================================ FILE: cypress/e2e/AdminPortal/Organizations/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/Organizations/OrganizationSetup.cy.ts ================================================ describe('Organization test data setup', () => { let orgId = ''; const userIds: string[] = []; before(() => { cy.setupTestEnvironment().then(({ orgId: createdOrgId }) => { orgId = createdOrgId; expect(orgId).to.be.a('string').and.not.equal(''); }); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId, { userIds }); } }); afterEach(() => { cy.clearAllGraphQLMocks(); }); it('seeds event data for a new organization', () => { cy.seedTestData('events', { orgId }).then(({ eventId }) => { expect(eventId).to.be.a('string').and.not.equal(''); }); }); it('seeds post data for a new organization', () => { cy.seedTestData('posts', { orgId }).then(({ postId }) => { expect(postId).to.be.a('string').and.not.equal(''); }); }); it('seeds volunteer data for a new event', () => { cy.seedTestData('events', { orgId }) .then(({ eventId }) => { return cy.seedTestData('volunteers', { eventId }); }) .then(({ volunteerId, userId }) => { expect(volunteerId).to.be.a('string').and.not.equal(''); if (userId) { userIds.push(userId); } }); }); }); ================================================ FILE: cypress/e2e/AdminPortal/People/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/People/ManageMembers.cy.ts ================================================ import { MemberManagementPage } from '../../../pageObjects/AdminPortal/MemberManagementPage'; type SeededUser = { name: string; userId?: string }; const memberManagementPage = new MemberManagementPage(); describe('Admin People Tab', () => { let orgId = ''; const userIds: string[] = []; const wiltShepherd: SeededUser = { name: 'Wilt Shepherd' }; const praiseNorris: SeededUser = { name: 'Praise Norris' }; before(() => { cy.setupTestEnvironment({ auth: { role: 'admin' } }) .then(({ orgId: createdOrgId }) => { orgId = createdOrgId; return cy.createTestUser({ name: wiltShepherd.name }); }) .then(({ userId }) => { wiltShepherd.userId = userId; userIds.push(userId); return cy.createOrganizationMembership({ memberId: userId, organizationId: orgId, role: 'regular', }); }) .then(() => cy.createTestUser({ name: praiseNorris.name })) .then(({ userId }) => { praiseNorris.userId = userId; userIds.push(userId); }); }); beforeEach(() => { cy.loginByApi('admin'); cy.visit(`/admin/orgdash/${orgId}`); memberManagementPage.openFromDrawer(); }); it('should search a particular member and then reset to all members', () => { memberManagementPage .searchMemberByName(wiltShepherd.name) .verifyMemberInList(wiltShepherd.name); memberManagementPage.resetSearch(); memberManagementPage.verifyMemberInList(wiltShepherd.name).verifyMinRows(2); // Verify that at least 2 members appear (Wilt + the admin who created the org). // We avoid hard-coding the admin's display name because it depends on CI seed data. }); it('add an existing member to the organization', () => { const member = praiseNorris.name; memberManagementPage.clickAddExistingMember(); memberManagementPage.searchAndSelectUser(member); memberManagementPage.confirmAddUser(member); memberManagementPage .getAlert() .should('be.visible') .and('contain.text', 'Member added Successfully'); cy.reload(); memberManagementPage.searchMemberByName(member).verifyMemberInList(member); }); it('delete a member from the organization', () => { if (!praiseNorris.userId) { throw new Error('Expected praiseNorris.userId to be set before delete.'); } cy.reload(); memberManagementPage.deleteMember(praiseNorris.name); memberManagementPage .getAlert() .should('be.visible') .and('contain.text', 'The Member is removed'); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId, { userIds }); } }); }); ================================================ FILE: cypress/e2e/AdminPortal/Posts/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/Posts/Posts.cy.ts ================================================ // SKIP_LOCALSTORAGE_CHECK import { PostsPage } from '../../../pageObjects/AdminPortal/PostPage'; describe('Testing Posts Management in Admin Portal', () => { const postsPage = new PostsPage(); let orgId = ''; before(() => { cy.setupTestEnvironment({ auth: { role: 'admin' } }).then( ({ orgId: createdOrgId }) => { orgId = createdOrgId; }, ); }); beforeEach(() => { cy.loginByApi('admin'); cy.visit(`/admin/orgdash/${orgId}`); postsPage.visitPostsPage(); }); it('should create a new post', () => { postsPage.createPost('Test Post Title', 'This is a test post description.'); }); it('should edit the created post', () => { postsPage.editFirstPost('Updated Test Post Title'); }); it('should delete the edited post', () => { postsPage.deleteFirstPost(); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId); } }); }); ================================================ FILE: cypress/e2e/AdminPortal/Tags/.gitkeep ================================================ ================================================ FILE: cypress/e2e/AdminPortal/Venues/.gitkeep ================================================ ================================================ FILE: cypress/e2e/Auth/.gitkeep ================================================ ================================================ FILE: cypress/e2e/Auth/Login.cy.ts ================================================ // SKIP_LOCALSTORAGE_CHECK import { LoginPage } from '../../pageObjects/auth/LoginPage'; describe('Admin Login Functionality', () => { const rolesToTest = ['superAdmin', 'admin']; rolesToTest.forEach((role) => { it(`logs in as ${role}`, () => { cy.fixture('auth/credentials').then((users) => { const userData = users[role]; const loginPage = new LoginPage(); cy.visit('/admin'); loginPage.verifyLoginPage().login(userData.email, userData.password); cy.url().should('include', '/admin/orglist'); }); }); }); rolesToTest.forEach((role) => { it(`fails to log in as ${role} with invalid credentials`, () => { cy.fixture('auth/credentials').then((users) => { const userData = users[role]; const loginPage = new LoginPage(); cy.visit('/admin'); loginPage .verifyLoginPage() .login(userData.email, 'wrongpassword') .verifyErrorToast(); cy.url().should('include', '/admin'); cy.window().then((win) => { expect(win.localStorage.getItem('Talawa-admin_token')).to.eq(null); }); }); }); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); }); describe('User Login Functionality', () => { beforeEach(() => { cy.visit('/'); }); it('User Login', () => { cy.fixture('auth/credentials').then((users) => { const userData = users['user']; const loginPage = new LoginPage(); loginPage.verifyLoginPage().login(userData.email, userData.password); cy.url().should('include', '/user/organizations'); }); }); it('User Login with Invalid Credentials', () => { cy.fixture('auth/credentials').then((users) => { const userData = users['user']; const loginPage = new LoginPage(); loginPage .verifyLoginPage() .login(userData.email, 'wrongpassword') .verifyErrorToast(); cy.url().should('not.include', '/user/organizations'); cy.window().then((win) => { expect(win.localStorage.getItem('Talawa-admin_token')).to.eq(null); }); }); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); }); ================================================ FILE: cypress/e2e/CascadingEffects/.gitkeep ================================================ ================================================ FILE: cypress/e2e/E2EFlows/.gitkeep ================================================ ================================================ FILE: cypress/e2e/ErrorScenarios/.gitkeep ================================================ ================================================ FILE: cypress/e2e/MultiOrganization/.gitkeep ================================================ ================================================ FILE: cypress/e2e/SharedComponents/.gitkeep ================================================ ================================================ FILE: cypress/e2e/SharedComponents/GraphQLUtilities.cy.ts ================================================ type GraphQLError = { message: string }; const requestTimeoutMs = 5000; const windowTimeoutMs = 10000; const triggerGraphQLRequest = ( operationName: string, url: string = '/graphql', ): Cypress.Chainable => { return cy.window({ timeout: windowTimeoutMs }).then((win) => { const controller = new AbortController(); const timeoutId = win.setTimeout( () => controller.abort(), requestTimeoutMs, ); return win .fetch(url, { method: 'POST', signal: controller.signal, headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ operationName, // operationName drives cy.intercept matching, so a static query body is sufficient. query: 'query ExampleOperation { __typename }', }), }) .catch((error) => { throw new Error( `GraphQL request "${operationName}" failed: ${String(error)}`, ); }) .finally(() => { win.clearTimeout(timeoutId); }); }); }; describe('GraphQL utilities', () => { let originalApiUrl: unknown; let originalApiUrlEnv: unknown; let originalCypressApiUrl: unknown; beforeEach(() => { originalApiUrl = Cypress.env('apiUrl'); originalApiUrlEnv = Cypress.env('API_URL'); originalCypressApiUrl = Cypress.env('CYPRESS_API_URL'); Cypress.env('apiUrl', '/graphql'); Cypress.env('API_URL', null); Cypress.env('CYPRESS_API_URL', null); cy.visit('/'); }); afterEach(() => { Cypress.env('apiUrl', originalApiUrl); Cypress.env('API_URL', originalApiUrlEnv); Cypress.env('CYPRESS_API_URL', originalCypressApiUrl); cy.clearAllGraphQLMocks(); }); it('aliases and waits for a live operation', () => { cy.aliasGraphQLOperation('OrganizationListBasic'); triggerGraphQLRequest('OrganizationListBasic'); cy.waitForGraphQLOperation('OrganizationListBasic').then((interception) => { expect(interception.response).to.not.equal(undefined); expect(interception.response?.body).to.not.equal(undefined); }); }); it('mocks a successful query', () => { cy.mockGraphQLOperation( 'OrganizationListBasic', 'api/graphql/organizations.success.json', ); triggerGraphQLRequest('OrganizationListBasic'); cy.waitForGraphQLOperation('OrganizationListBasic') .its('response.body.data.organizations.0.name') .should('eq', 'Example Org'); }); it('mocks an error response', () => { cy.mockGraphQLError( 'OrganizationListBasic', 'Organization list failed', 'GRAPHQL_ERROR', ); triggerGraphQLRequest('OrganizationListBasic'); cy.waitForGraphQLOperation('OrganizationListBasic').then((interception) => { const errors = interception.response?.body?.errors as | GraphQLError[] | undefined; expect(errors?.[0]?.message).to.eq('Organization list failed'); }); }); it('uses API_URL when apiUrl is not set', () => { Cypress.env('apiUrl', null); Cypress.env('API_URL', '/graphql-api-url'); cy.mockGraphQLOperation('ApiUrlOperation', { data: { ok: true }, }); triggerGraphQLRequest('ApiUrlOperation', '/graphql-api-url'); cy.waitForGraphQLOperation('ApiUrlOperation') .its('response.body.data.ok') .should('eq', true); }); it('uses CYPRESS_API_URL when other envs are unset', () => { Cypress.env('apiUrl', null); Cypress.env('API_URL', null); Cypress.env('CYPRESS_API_URL', '/graphql-cypress-env'); cy.mockGraphQLOperation('CypressEnvOperation', { data: { ok: true }, }); triggerGraphQLRequest('CypressEnvOperation', '/graphql-cypress-env'); cy.waitForGraphQLOperation('CypressEnvOperation') .its('response.body.data.ok') .should('eq', true); }); it('falls back to default pattern when envs are unset', () => { Cypress.env('apiUrl', null); Cypress.env('API_URL', null); Cypress.env('CYPRESS_API_URL', null); cy.mockGraphQLOperation('DefaultOperation', { data: { ok: true }, }); triggerGraphQLRequest('DefaultOperation'); cy.waitForGraphQLOperation('DefaultOperation') .its('response.body.data.ok') .should('eq', true); }); it('supports function responders', () => { cy.mockGraphQLOperation('FunctionResponder', (req) => { req.reply({ statusCode: 201, body: { data: { ok: true } } }); }); triggerGraphQLRequest('FunctionResponder'); cy.waitForGraphQLOperation('FunctionResponder') .its('response.statusCode') .should('eq', 201); }); it('passes through non-matching operations', () => { cy.mockGraphQLOperation('MatchOperation', { data: { ok: false } }); cy.intercept('POST', '/graphql', (req) => { if (req.body?.operationName === 'DifferentOperation') { req.alias = 'fallbackOperation'; req.reply({ statusCode: 200, body: { data: { ok: true } } }); return; } req.continue(); }); triggerGraphQLRequest('DifferentOperation'); cy.wait('@fallbackOperation') .its('response.body.data.ok') .should('eq', true); }); }); ================================================ FILE: cypress/e2e/SharedComponents/Navigation.cy.ts ================================================ /// import { LeftDrawer } from '../../pageObjects/AdminPortal/LeftDrawer'; describe('LeftDrawer CSS Tests', () => { const drawer = new LeftDrawer(); let orgId = ''; before(() => { cy.setupTestEnvironment({ auth: { role: 'admin' } }).then( ({ orgId: createdOrgId }) => { orgId = createdOrgId; }, ); }); beforeEach(() => { // Setup any necessary authentication or navigation cy.loginByApi('admin'); drawer.checkBreakpoint(orgId); }); it('profile container uses row under <1280px viewport', () => { drawer.checkRowViewport(); }); it('should check profileContainer styling when organization data is loaded', () => { drawer.checkProfileContainerStyling(); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); after(() => { if (orgId) { cy.cleanupTestOrganization(orgId); } }); }); ================================================ FILE: cypress/e2e/UserPortal/Dashboard/.gitkeep ================================================ ================================================ FILE: cypress/e2e/UserPortal/Dashboard/UserDashboard.cy.ts ================================================ import { UserDashboardPage } from '../../../pageObjects/UserPortal/UserDashboard'; describe('User Dashboard', () => { const dashboard = new UserDashboardPage(); beforeEach(() => { cy.session('user', () => cy.loginByApi('user')); dashboard.visit(); }); it('should display the user organizations and visit Organization Dashboard', () => { dashboard.verifyOnDashboard().openFirstOrganization(); }); afterEach(() => { cy.clearCookies(); cy.clearLocalStorage(); }); }); ================================================ FILE: cypress/e2e/UserPortal/EventDiscovery/.gitkeep ================================================ ================================================ FILE: cypress/e2e/UserPortal/OrganizationDiscovery/.gitkeep ================================================ ================================================ FILE: cypress/e2e/UserPortal/Posts/.gitkeep ================================================ ================================================ FILE: cypress/e2e/UserPortal/Profile/.gitkeep ================================================ ================================================ FILE: cypress/e2e/UserPortal/Transactions/.gitkeep ================================================ ================================================ FILE: cypress/e2e/UserPortal/VolunteerSignup/.gitkeep ================================================ ================================================ FILE: cypress/fixtures/admin/actionItems.json ================================================ { "actionItems": [ { "id": "action_001", "title": "Prepare agenda", "status": "OPEN", "assignee": "Alex Example", "dueAt": "2026-01-10T00:00:00.000Z" }, { "id": "action_002", "title": "Long action item — مرحبا 世界", "status": "COMPLETED", "assignee": "Long Name Member — 世界", "dueAt": null } ], "emptyActionItems": [] } ================================================ FILE: cypress/fixtures/admin/advertisements.json ================================================ { "advertisements": [ { "id": "ad_001", "name": "Advertisement 1", "description": "This is a test advertisement", "type": "Popup Ad", "status": "ACTIVE", "startDate": "2026-01-01T00:00:00.000Z", "endDate": "2026-02-01T00:00:00.000Z" }, { "id": "ad_002", "name": "Advertisement 2", "description": "Updated advertisement text", "type": "Popup Ad", "status": "INACTIVE", "startDate": "2026-02-01T00:00:00.000Z", "endDate": "2026-03-01T00:00:00.000Z" } ], "emptyAdvertisements": [] } ================================================ FILE: cypress/fixtures/admin/events.json ================================================ { "events": [ { "id": "event_001", "name": "Example Event", "description": "Primary event", "startAt": "2026-01-05T10:00:00.000Z", "endAt": "2026-01-05T12:00:00.000Z", "location": "Main Hall", "organizationId": "org_001" }, { "id": "event_002", "name": "Long Event Name — مرحبا 世界", "description": "Edge case", "startAt": "2026-02-10T18:00:00.000Z", "endAt": "2026-02-10T20:00:00.000Z", "location": "Remote", "organizationId": "org_002" } ], "emptyEvents": [] } ================================================ FILE: cypress/fixtures/admin/organizations.json ================================================ { "organizations": [ { "id": "org_001", "name": "Example Org", "description": "Primary for tests", "createdAt": "2025-12-01T00:00:00.000Z" }, { "id": "org_002", "name": "Long Name Organization — مرحبا 世界", "description": "Edge case name", "createdAt": "2025-12-02T00:00:00.000Z" } ], "emptyOrganizations": [] } ================================================ FILE: cypress/fixtures/admin/people.json ================================================ { "people": [ { "id": "person_001", "name": "Alex Example", "emailAddress": "alex@example.org", "role": "administrator", "joinedAt": "2025-11-20T00:00:00.000Z" }, { "id": "person_002", "name": "Long Name Member — 世界", "emailAddress": "long.name@example.org", "role": "member", "joinedAt": "2025-11-21T00:00:00.000Z" } ], "emptyPeople": [] } ================================================ FILE: cypress/fixtures/admin/tags.json ================================================ { "tags": [ { "id": "tag_001", "name": "Urgent" }, { "id": "tag_002", "name": "Long Tag — 世界" } ], "emptyTags": [] } ================================================ FILE: cypress/fixtures/admin/venues.json ================================================ { "venues": [ { "id": "venue_001", "name": "Main Hall", "address": "100 Example St", "city": "Example City", "country": "Exampleland" }, { "id": "venue_002", "name": "Community Hall — مرحبا 世界", "address": "200 Long Name Rd", "city": "Long City", "country": "Exampleland" } ], "emptyVenues": [] } ================================================ FILE: cypress/fixtures/api/graphql/createOrganization.error.conflict.json ================================================ { "errors": [ { "message": "Organization name already exists", "extensions": { "code": "CONFLICT" } } ] } ================================================ FILE: cypress/fixtures/api/graphql/createOrganization.success.json ================================================ { "data": { "createOrganization": { "id": "org_003", "_id": "org_003" } } } ================================================ FILE: cypress/fixtures/api/graphql/getOrganizationEvents.error.notFound.json ================================================ { "errors": [ { "message": "Organization not found", "extensions": { "code": "NOT_FOUND" } } ] } ================================================ FILE: cypress/fixtures/api/graphql/getOrganizationEvents.success.json ================================================ { "data": { "organization": { "events": { "edges": [ { "node": { "id": "event_001", "name": "Example Event", "startAt": "2026-01-05T10:00:00.000Z", "endAt": "2026-01-05T12:00:00.000Z", "location": "Main Hall" }, "cursor": "cursor-1" }, { "node": { "id": "event_002", "name": "Long Event Name — مرحبا 世界", "startAt": "2026-02-10T18:00:00.000Z", "endAt": "2026-02-10T20:00:00.000Z", "location": "Remote" }, "cursor": "cursor-2" } ], "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "startCursor": "cursor-1", "endCursor": "cursor-2" } } } } } ================================================ FILE: cypress/fixtures/api/graphql/getOrganizationMembers.error.notFound.json ================================================ { "errors": [ { "message": "Members not found", "extensions": { "code": "NOT_FOUND" } } ] } ================================================ FILE: cypress/fixtures/api/graphql/getOrganizationMembers.success.json ================================================ { "data": { "organization": { "members": { "edges": [ { "node": { "id": "person_001", "name": "Alex Example", "emailAddress": "alex@example.org", "role": "administrator" }, "cursor": "cursor-1" }, { "node": { "id": "person_002", "name": "Long Name Member — 世界", "emailAddress": "long.name@example.org", "role": "member" }, "cursor": "cursor-2" } ], "pageInfo": { "hasNextPage": false, "endCursor": "cursor-2" } } } } } ================================================ FILE: cypress/fixtures/api/graphql/organizations.success.json ================================================ { "data": { "organizations": [ { "id": "org-1", "name": "Example Org", "addressLine1": "Example Address" }, { "id": "org-2", "name": "Long Name Organization — مرحبا 世界", "addressLine1": "Edge Address" } ] } } ================================================ FILE: cypress/fixtures/auth/credentials.json ================================================ { "superAdmin": { "email": "testsuperadmin@example.com", "password": "Pass@123" }, "admin": { "email": "testadmin1@example.com", "password": "Pass@123" }, "user": { "email": "testuser1@example.com", "password": "Pass@123" } } ================================================ FILE: cypress/fixtures/auth/users.json ================================================ { "superAdmin": { "id": "user_0001", "name": "Super Admin", "email": "testsuperadmin@example.com", "role": "superadmin" }, "admin": { "id": "user_0002", "name": "Admin User", "email": "testadmin1@example.com", "role": "administrator" }, "user": { "id": "user_0003", "name": "Regular User", "email": "testuser1@example.com", "role": "user" } } ================================================ FILE: cypress/fixtures/user/campaigns.json ================================================ { "campaigns": [ { "id": "camp_001", "name": "Community Drive", "goalAmount": 5000, "raisedAmount": 1250, "endsAt": "2026-02-15T00:00:00.000Z" }, { "id": "camp_002", "name": "Long Campaign — مرحبا 世界", "goalAmount": 10000, "raisedAmount": 0, "endsAt": "2026-03-15T00:00:00.000Z" } ], "emptyCampaigns": [] } ================================================ FILE: cypress/fixtures/user/donations.json ================================================ { "donations": [ { "id": "don_001", "amount": 50, "donorName": "Example Donor", "donatedAt": "2026-01-05T00:00:00.000Z", "campaignId": "camp_001" }, { "id": "don_002", "amount": 0, "donorName": "Anonymous — 世界", "donatedAt": "2026-01-06T00:00:00.000Z", "campaignId": "camp_002" } ], "emptyDonations": [] } ================================================ FILE: cypress/fixtures/user/posts.json ================================================ { "posts": [ { "id": "post_001", "title": "Welcome post", "body": "Welcome to the community.", "authorName": "Admin User", "createdAt": "2026-01-02T00:00:00.000Z" }, { "id": "post_002", "title": "Long Post — مرحبا 世界", "body": "Edge case content.", "authorName": "Long Name Member — 世界", "createdAt": "2026-01-03T00:00:00.000Z" } ], "emptyPosts": [] } ================================================ FILE: cypress/fixtures/user/volunteers.json ================================================ { "volunteers": [ { "id": "vol_001", "name": "Alex Example", "role": "lead", "joinedAt": "2025-12-15T00:00:00.000Z" }, { "id": "vol_002", "name": "Volunteer — 世界", "role": "member", "joinedAt": "2025-12-20T00:00:00.000Z" } ], "emptyVolunteers": [] } ================================================ FILE: cypress/pageObjects/AdminPortal/ActionItemPage.ts ================================================ export class ActionItemPage { private readonly createActionItemBtn = '[data-cy="createActionItemBtn"]'; private readonly categorySelect = '[data-cy="categorySelect"]'; private readonly memberSelect = '[data-cy="memberSelect"]'; private readonly volunteerSelect = '[data-cy="volunteerSelect"]'; private readonly submitBtn = '[data-testid="modal-submit-btn"]'; private readonly sortBtn = '[data-testid="sort-toggle"]'; private readonly sortByAssignedAtDesc = '[data-testid="sort-item-assignedAt_DESC"]'; private readonly editItemBtn = '[data-testid^="editItemBtn"]'; private readonly viewItemBtn = '[data-testid^="viewItemBtn"]'; private readonly statusCheckbox = '[data-testid^="statusCheckbox"]'; private readonly postCompletionNotes = '[data-cy="postCompletionNotes"]'; private readonly createCompletionBtn = '[data-testid="createBtn"]'; private readonly completionBtnSeries = '[data-cy="markCompletionForSeries"]'; private readonly deleteItemBtn = '[data-testid^="deleteItemBtn"]'; private readonly deleteYesBtn = '[data-testid="modal-delete-btn"]'; private readonly modalCloseBtn = '[data-testid="modalCloseBtn"]'; private readonly notesInput = '[data-cy="preCompletionNotes"]'; // Event page selectors private readonly eventsTabButton = '[data-cy="leftDrawerButton-Events"]'; private readonly eventCard = '[data-testid="card"]'; private readonly showEventDashboardBtn = '[data-testid="showEventDashboardBtn"]'; private readonly actionItemsTab = '[data-testid="actionsBtn"]'; visitActionItemsTab() { cy.get('[data-cy="leftDrawerButton-Action Items"]') .should('be.visible') .click(); cy.url().should('match', /\/orgactionitems\/[a-f0-9-]+/); return this; } visitEventsPage() { cy.get(this.eventsTabButton).should('be.visible').click(); cy.url().should('match', /\/admin\/orgevents\/[a-f0-9-]+/); return this; } selectFirstEvent() { cy.get(this.eventCard).first().should('be.visible').click(); return this; } clickShowEventDashboard() { cy.get(this.showEventDashboardBtn).should('be.visible').click(); return this; } navigateToEventActionItemsTab() { // After being in event dashboard, click action items tab cy.get(this.actionItemsTab).should('be.visible').click(); return this; } visitEventActionItems(orgId?: string, eventId?: string) { if (orgId && eventId) { cy.visit(`/admin/event/${orgId}/${eventId}`); this.navigateToEventActionItemsTab(); return this; } this.visitEventsPage(); this.selectFirstEvent(); // After selecting event, click "Show Event Dashboard" button this.clickShowEventDashboard(); // Now click the action items tab within the event dashboard this.navigateToEventActionItemsTab(); return this; } createActionItem(category: string, member: string) { cy.get(this.createActionItemBtn).should('be.visible').click(); cy.get(this.categorySelect).should('be.visible').click(); cy.contains('[role="listbox"] [role="option"]', category).click(); cy.get(this.memberSelect).should('be.visible').click(); cy.contains('[role="listbox"] [role="option"]', member).click(); cy.get(this.submitBtn).should('be.visible').click(); cy.assertToast('Action Item created successfully'); return this; } createActionItemWithVolunteer(category: string, volunteerName?: string) { cy.get(this.createActionItemBtn).should('be.visible').click(); cy.get(this.categorySelect).should('be.visible').click(); cy.contains('[role="listbox"] [role="option"]', category).click(); cy.get(this.volunteerSelect).should('be.visible').click(); if (volunteerName) { cy.contains('[role="listbox"] [role="option"]', volunteerName).click(); } else { cy.get('[role="listbox"] [role="option"]').first().click(); } cy.get(this.submitBtn).should('be.visible').click(); cy.assertToast('Action Item created successfully'); return this; } sortByNewest() { cy.get(this.sortBtn).should('be.visible').click(); cy.get(this.sortByAssignedAtDesc).should('be.visible').click(); return this; } editFirstActionItem(newNotes: string) { cy.get(this.editItemBtn).first().click(); cy.get(this.notesInput).should('be.visible').type(newNotes); cy.get(this.submitBtn).should('be.visible').click(); cy.assertToast('Action Item updated successfully'); return this; } viewFirstActionItemAndCloseModal() { cy.get(this.viewItemBtn).first().click(); cy.get(this.modalCloseBtn).should('be.visible').click(); return this; } markFirstActionItemAsComplete(completionNotes: string) { cy.get(this.statusCheckbox).first().click(); cy.get(this.postCompletionNotes).type(completionNotes); cy.get(this.completionBtnSeries).should('be.visible').click(); cy.assertToast('Completed'); return this; } deleteFirstActionItem() { cy.get(this.deleteItemBtn).first().click(); cy.get(this.deleteYesBtn).should('be.visible').click(); cy.assertToast('Action Item deleted successfully'); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/AdminDashboard.ts ================================================ export class AdminDashboardPage { private readonly _orgcardContainer: string = '[data-cy="orgCardContainer"]'; private readonly _manageButton: string = '[data-cy="manageBtn"]'; private readonly _toggleDropdown: string = '[data-testid="togDrop"]'; private readonly _logoutButton: string = '[data-testid="signOutBtn"]'; private readonly _loginEmailInput: string = '[data-cy="loginEmail"]'; private readonly _drawerOptions = [ { label: 'People', url: '/admin/orgpeople/' }, { label: 'Tags', url: '/admin/orgtags/' }, { label: 'Events', url: '/admin/orgevents/' }, { label: 'Venues', url: '/admin/orgvenues/' }, { label: 'Posts', url: '/admin/orgpost/' }, { label: 'Block/Unblock', url: '/admin/blockuser/' }, { label: 'Advertisement', url: '/admin/orgads/' }, { label: 'Funds', url: '/admin/orgfunds/' }, { label: 'Membership Requests', url: '/admin/requests/' }, { label: 'Settings', url: '/admin/orgsetting/' }, ]; visit() { cy.visit('/admin/orglist'); return this; } verifyOnDashboard(timeout = 20000) { cy.url({ timeout }).should('include', '/admin/orglist'); const emptyStateSelector = '[data-testid="orglist-no-orgs-empty"]'; cy.get('body', { timeout }).then(($body) => { // Check that either org cards or empty state are present (page loaded) const hasOrgCards = $body.find(this._orgcardContainer).length > 0; const hasEmptyState = $body.find(emptyStateSelector).length > 0; expect(hasOrgCards || hasEmptyState).to.equal(true); }); return this; } openFirstOrganization(timeout = 20000) { cy.get(this._manageButton, { timeout }) .should('be.visible') .first() .click(); cy.url().should('match', /\/admin\/orgdash\/[a-f0-9-]+/); return this; } verifyLeftDrawerOptions(timeout = 40000) { this._drawerOptions.forEach(({ label, url }) => { const selector = `[data-cy="leftDrawerButton-${label}"]`; cy.get(selector, { timeout }).should('be.visible').click(); cy.url().should('match', new RegExp(`${url}[a-f0-9-]+`)); }); return this; } logout(timeout = 20000) { cy.get(this._logoutButton, { timeout }) .should('exist') .click({ force: true }); cy.url({ timeout }).should('include', '/'); cy.get(this._loginEmailInput, { timeout }).should('be.visible'); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/AdminEventPage.ts ================================================ export class AdminEventPage { private readonly _eventsTabButton = '[data-cy="leftDrawerButton-Events"]'; private readonly _createEventModalButton = '[data-cy="createEventModalBtn"]'; private readonly _eventTitleInput = '[data-cy="eventTitleInput"]'; private readonly _eventDescriptionInput = '[data-cy="eventDescriptionInput"]'; private readonly _eventLocationInput = '[data-cy="eventLocationInput"]'; private readonly _createEventBtn = '[data-cy="createEventBtn"]'; private readonly _eventCard = '[data-testid="card"]'; visitEventPage(): void { cy.get(this._eventsTabButton).should('be.visible').click(); cy.url().should('match', /\/admin\/orgevents\/[a-f0-9-]+/); } createEvent(title: string, description: string, location: string): this { // Set up intercept for specific events query (not all GraphQL operations) cy.intercept('POST', '**/graphql', (req) => { if (req.body.operationName === 'GetOrganizationEvents') { req.alias = 'eventsQuery'; } }); cy.get(this._createEventModalButton) .should('be.visible') .should('be.enabled'); cy.get(this._createEventModalButton).click({ force: true }); // Wait for modal form to be fully rendered cy.get(this._eventTitleInput).should('be.visible').and('be.enabled'); // Clear and type each field, breaking up command chains to handle page re-renders cy.get(this._eventTitleInput).clear(); cy.get(this._eventTitleInput).type(title); cy.get(this._eventTitleInput).should('have.value', title); cy.get(this._eventDescriptionInput).clear(); cy.get(this._eventDescriptionInput).type(description); cy.get(this._eventDescriptionInput).should('have.value', description); cy.get(this._eventLocationInput).clear(); cy.get(this._eventLocationInput).type(location); cy.get(this._eventLocationInput).should('have.value', location); // Submit the form cy.get(this._createEventBtn).should('be.visible').and('be.enabled').click(); // Assert success toast cy.assertToast('Congratulations! The Event is created.'); // Wait for modal to close cy.get(this._eventTitleInput).should('not.exist'); // Reload to ensure fresh data and wait for specific events query to complete cy.reload(); cy.wait('@eventsQuery', { timeout: 15000 }); // Wait for page to fully load cy.get(this._createEventModalButton, { timeout: 10000 }).should( 'be.visible', ); // Cypress cannot click this due to calendar cards overlapping the button. // This is a known Cypress actionability limitation — force click is required. cy.get('[data-testid="more"]') .filter(':contains("View all")') .each(($btn) => { cy.wrap($btn).click({ force: true }); }) .then(($buttons) => { // Wait for all clicks to be flushed; branch on whether any buttons existed. if ($buttons.length === 0) { return; } cy.contains(this._eventCard, title, { timeout: 30000 }).should('exist'); }); return this; } findEventCard(eventName: string): Cypress.Chainable { // Find the specific event card containing the event name // This pattern retries until an element matching both selector AND text is found return cy.contains(this._eventCard, eventName, { timeout: 30000 }); } openEventDetails(eventName: string): this { this.findEventCard(eventName).click(); return this; } updateEvent( existingName: string, newName: string, newDescription: string, newLocation: string, ): this { // Find and click on the event card this.openEventDetails(existingName); // Wait for edit form to load and update fields, breaking up command chains cy.get('[data-cy="updateName"]', { timeout: 10000 }).should('be.visible'); cy.get('[data-cy="updateName"]').clear(); cy.get('[data-cy="updateName"]').type(newName); cy.get('[data-cy="updateName"]').should('have.value', newName); cy.get('[data-cy="updateDescription"]').should('be.visible'); cy.get('[data-cy="updateDescription"]').clear(); cy.get('[data-cy="updateDescription"]').type(newDescription); cy.get('[data-cy="updateLocation"]').should('be.visible'); cy.get('[data-cy="updateLocation"]').clear(); cy.get('[data-cy="updateLocation"]').type(newLocation); // Click update button cy.get('[data-cy="previewUpdateEventBtn"]') .should('be.visible') .and('be.enabled') .click(); cy.assertToast('Event updated successfully.'); return this; } deleteEvent(eventName: string): this { // Find and click on the event card this.openEventDetails(eventName); // Click delete button in event details cy.get('[data-cy="deleteEventModalBtn"]', { timeout: 10000 }) .should('be.visible') .click(); // Confirm deletion cy.get('[data-testid="deleteEventBtn"]').should('be.visible').click(); cy.assertToast('Event deleted successfully.'); return this; } verifyEventNotInList(eventTitle: string, timeout = 40000): this { // Verify the event doesn't appear in the event list // Using should('not.exist') handles the case where no cards exist cy.contains(this._eventCard, eventTitle, { timeout }).should('not.exist'); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/AdvertisementPage.ts ================================================ export class AdvertisementPage { private readonly _createAdBtn = '[data-testid="createAdvertisement"]'; private readonly _adNameInput = '[data-cy="advertisementNameInput"]'; private readonly _adDescriptionInput = '[data-cy="advertisementDescriptionInput"]'; private readonly _adTypeSelect = '[data-cy="advertisementTypeSelect"]'; private readonly _registerAdBtn = '[data-cy="registerAdvertisementButton"]'; private readonly _leftDrawerAdBtn = '[data-cy="leftDrawerButton-Advertisement"]'; private readonly _activeCampaignsTab = 'Active Campaigns'; private readonly _dropdownBtn = '[data-cy="dropdownbtn"]'; private readonly _editBtn = '[data-testid="editBtn"]'; private readonly _saveChangesBtn = '[data-cy="saveChanges"]'; private readonly _deleteBtn = '[data-cy="deletebtn"]'; private readonly _deleteConfirmBtn = '[data-testid="delete_yes"]'; visitAdvertisementPage() { cy.get(this._leftDrawerAdBtn).should('be.visible').click(); cy.url().should('match', /\/admin\/orgads\/[a-f0-9-]+/); return this; } createAdvertisement(name: string, description: string, type: string) { cy.get(this._createAdBtn).should('be.visible').click(); cy.get(this._adNameInput).should('be.visible').type(name); cy.get(this._adDescriptionInput).should('be.visible').type(description); cy.get(this._adTypeSelect).should('be.visible').select(type); cy.get(this._registerAdBtn).should('be.visible').click(); cy.assertToast('Advertisement created successfully.'); return this; } verifyAndEditAdvertisement(oldName: string, newName: string) { cy.contains(this._activeCampaignsTab).should('be.visible').click(); cy.contains(oldName).should('be.visible'); cy.get(this._dropdownBtn).should('be.visible').click(); cy.get(this._editBtn).should('be.visible').trigger('click'); cy.get(this._adNameInput).should('be.visible').clear().type(newName); cy.get(this._saveChangesBtn).should('be.visible').click(); cy.assertToast('Advertisement updated Successfully'); return this; } verifyAndDeleteAdvertisement(adName: string) { cy.contains(this._activeCampaignsTab).should('be.visible').click(); cy.contains(adName).should('be.visible'); cy.get(this._dropdownBtn).should('be.visible').click(); cy.get(this._deleteBtn).should('be.visible').trigger('click'); cy.get(this._deleteConfirmBtn).should('be.visible').click(); cy.assertToast('Advertisement deleted successfully.'); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/EventAttendancePage.ts ================================================ import { BasePage } from '../base/BasePage'; export type AttendanceSortOrder = 'ascending' | 'descending'; export type AttendanceFilterPeriod = 'This Month' | 'This Year' | 'All'; export class EventAttendancePage extends BasePage { private readonly attendanceTabButton = 'attendanceBtn'; private readonly attendanceTabPanel = 'eventAttendanceTab'; private readonly statsButton = 'stats-modal'; private readonly closeStatisticsButton = 'close-button'; private readonly searchInput = 'searchByName'; private readonly searchButton = 'searchMembersBtn'; private readonly sortToggleButton = 'sort-dropdown-toggle'; private readonly sortItemPrefix = 'sort-dropdown-item-'; private readonly filterToggleButton = 'filter-dropdown-toggle'; private readonly filterMenu = '[data-testid="filter-dropdown-menu"]'; private readonly table = this.tableActions('.MuiDataGrid-root'); protected self(): EventAttendancePage { return this; } visitPage(orgId: string, eventId: string, timeout = 30000): this { this.visit(`/admin/event/${orgId}/${eventId}`); this.assertUrlIncludes(`/admin/event/${orgId}/${eventId}`, timeout); return this; } openAttendanceTab(timeout = 10000): this { this.byTestId(this.attendanceTabButton, timeout) .should('be.visible') .click(); this.byTestId(this.attendanceTabPanel, timeout).should('be.visible'); return this; } searchMemberByName(name: string, timeout = 10000): this { this.byTestId(this.searchInput, timeout) .should('be.visible') .clear() .type(name); this.byTestId(this.searchButton, timeout).should('be.visible').click(); return this; } clearSearch(timeout = 10000): this { this.byTestId(this.searchInput, timeout).should('be.visible').clear(); this.byTestId(this.searchButton, timeout).should('be.visible').click(); return this; } setSortOrder(order: AttendanceSortOrder, timeout = 10000): this { this.byTestId(this.sortToggleButton, timeout).should('be.visible').click(); this.byTestId(`${this.sortItemPrefix}${order}`, timeout) .should('be.visible') .click(); return this; } setFilterPeriod(period: AttendanceFilterPeriod, timeout = 10000): this { this.byTestId(this.filterToggleButton, timeout) .should('be.visible') .click(); cy.contains(`${this.filterMenu} [role="option"]`, period, { timeout, }).click(); return this; } openStatisticsModal(timeout = 10000): this { this.byTestId(this.statsButton, timeout).should('be.visible').click(); this.byTestId(this.closeStatisticsButton, timeout).should('be.visible'); return this; } closeStatisticsModal(timeout = 10000): this { this.byTestId(this.closeStatisticsButton, timeout) .should('be.visible') .click(); return this; } verifyAttendeeInList(name: string, timeout = 10000): this { this.table.findRowByText(name, timeout, false); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/LeftDrawer.ts ================================================ export class LeftDrawer { checkBreakpoint(orgId: string): void { // Ensure we're inside the <1280px breakpoint where the fix applies cy.viewport(1200, 900); // Stabilize assertions by waiting on org data cy.intercept('POST', '**/graphql').as('graphql'); cy.visit(`/admin/orgdash/${orgId}`); cy.url().should('include', '/admin/orgdash'); cy.wait('@graphql', { timeout: 15000 }); } checkRowViewport(): void { // Wait for the profile container to be visible cy.get('[data-testid="OrgBtn"]').should('be.visible'); // Check that the profileContainer has flex-direction: row cy.get('[data-testid="OrgBtn"]').should( 'have.css', 'flex-direction', 'row', ); } checkProfileContainerStyling(): void { // Wait for organization data to load (not shimmer state) cy.get('[data-testid="OrgBtn"]').should('be.visible'); cy.get('[class*="shimmer"]').should('not.exist'); // Verify the CSS property using CSS modules pattern cy.get('[data-testid="OrgBtn"]') .should('be.visible') .and('have.css', 'flex-direction', 'row'); } } ================================================ FILE: cypress/pageObjects/AdminPortal/MemberManagementPage.ts ================================================ import { BasePage } from '../base/BasePage'; export class MemberManagementPage extends BasePage { private readonly peopleTabButton = 'leftDrawerButton-People'; private readonly searchInput = 'member-search-input'; private readonly searchButton = 'searchBtn'; private readonly addMembersButton = 'addMembers-toggle'; private readonly existingUserToggle = 'addMembers-item-existingUser'; private readonly searchUserInput = 'searchUser'; private readonly submitSearchButton = 'submitBtn'; private readonly addButton = 'addBtn'; private readonly removeMemberActionSelector = '[data-testid="removeMemberModalBtn"]'; private readonly confirmRemoveMemberButton = 'removeMemberBtn'; private readonly alertSelector = '[role=alert]'; private readonly table = this.tableActions('.MuiDataGrid-root'); private readonly removeMemberModal = this.modalActions('[role="dialog"]'); protected self(): MemberManagementPage { return this; } openFromDrawer(timeout = 40000): this { this.byDataCy(this.peopleTabButton, timeout).should('be.visible').click(); this.assertUrlMatch(/\/admin\/orgpeople\/[a-f0-9-]+/, timeout); return this; } visitPage(orgId: string, timeout = 40000): this { this.visit(`/admin/orgpeople/${orgId}`); this.assertUrlIncludes(`/admin/orgpeople/${orgId}`, timeout); return this; } searchMemberByName(name: string, timeout = 40000): this { this.byTestId(this.searchInput, timeout) .should('be.visible') .clear() .type(name); this.byTestId(this.searchButton, timeout).should('be.visible').click(); return this; } verifyMemberInList(name: string, timeout = 40000): this { this.table.findRowByText(name, timeout); return this; } clickAddExistingMember(timeout = 40000): this { this.byTestId(this.addMembersButton, timeout).should('be.visible').click(); this.byTestId(this.existingUserToggle, timeout) .should('be.visible') .trigger('click'); return this; } searchAndSelectUser(name: string, timeout = 40000): this { this.byTestId(this.searchUserInput, timeout) .should('be.visible') .clear() .type(name); this.byTestId(this.submitSearchButton, timeout) .should('be.visible') .click(); cy.contains(name, { timeout }).should('be.visible'); return this; } confirmAddUser(name: string, timeout = 100000): this { void name; this.byTestId(this.addButton, timeout).first().should('be.visible').click(); return this; } deleteMember(name: string, timeout = 40000): this { this.searchMemberByName(name, timeout); cy.then(() => { this.table.waitVisible(timeout); this.table.clickRowActionByText( name, this.removeMemberActionSelector, timeout, ); }); this.removeMemberModal .waitVisible(timeout) .clickByTestId(this.confirmRemoveMemberButton, { timeout }); this.getAlert(timeout).should('be.visible'); return this; } resetSearch(timeout = 40000): this { this.byTestId(this.searchInput, timeout).should('be.visible').clear(); this.byTestId(this.searchButton, timeout).should('be.visible').click(); return this; } getAlert(timeout = 40000): Cypress.Chainable> { return cy.get(this.alertSelector, { timeout }); } verifyMinRows(minRows: number, timeout = 40000): this { this.table.expectMinRows(minRows, timeout); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/OrganizationSettingsPage.ts ================================================ import { BasePage } from '../base/BasePage'; export class OrganizationSettingsPage extends BasePage { private readonly settingsDrawerButton = 'leftDrawerButton-Settings'; private readonly generalSettingsButton = 'generalSettings'; private readonly actionItemCategoriesButton = 'actionItemCategoriesSettings'; private readonly generalTab = 'generalTab'; private readonly actionItemCategoriesTab = 'actionItemCategoriesTab'; private readonly organizationNameInput = '[name="orgName"]'; private readonly organizationDescriptionInput = '[name="orgDescrip"]'; private readonly organizationLocationInput = '[name="address.line1"]'; private readonly isPublicSwitch = 'user-reg-switch'; private readonly saveChangesButton = 'save-org-changes-btn'; private readonly openDeleteModalButton = 'openDeleteModalBtn'; private readonly confirmDeleteButton = 'deleteOrganizationBtn'; private readonly closeDeleteModalButton = 'closeDelOrgModalBtn'; private readonly deleteOrganizationModal = this.modalActions('[role="dialog"]'); protected self(): OrganizationSettingsPage { return this; } openFromDrawer(timeout = 30000): this { this.byDataCy(this.settingsDrawerButton, timeout) .should('be.visible') .click(); this.assertUrlMatch(/\/admin\/orgsetting\/[a-f0-9-]+/, timeout); return this; } visitPage(orgId: string, timeout = 30000): this { this.visit(`/admin/orgsetting/${orgId}`); this.assertUrlIncludes(`/admin/orgsetting/${orgId}`, timeout); return this; } openGeneralTab(timeout = 10000): this { this.byTestId(this.generalSettingsButton, timeout) .should('be.visible') .click(); this.byTestId(this.generalTab, timeout).should('be.visible'); return this; } openActionItemCategoriesTab(timeout = 10000): this { this.byTestId(this.actionItemCategoriesButton, timeout) .should('be.visible') .click(); this.byTestId(this.actionItemCategoriesTab, timeout).should('be.visible'); return this; } updateOrganizationName(name: string, timeout = 10000): this { cy.get(this.organizationNameInput, { timeout }) .should('be.visible') .clear() .type(name); return this; } updateOrganizationDescription(description: string, timeout = 10000): this { cy.get(this.organizationDescriptionInput, { timeout }) .should('be.visible') .clear() .type(description); return this; } updateOrganizationLocation(location: string, timeout = 10000): this { cy.get(this.organizationLocationInput, { timeout }) .should('be.visible') .clear() .type(location); return this; } toggleIsPublic(timeout = 10000): this { this.byTestId(this.isPublicSwitch, timeout).should('be.visible').click(); return this; } saveChanges(timeout = 10000): this { this.byTestId(this.saveChangesButton, timeout).should('be.visible').click(); return this; } openDeleteOrganizationModal(timeout = 10000): this { this.byTestId(this.openDeleteModalButton, timeout) .should('be.visible') .click(); this.deleteOrganizationModal.waitVisible(timeout); return this; } closeDeleteOrganizationModal(timeout = 10000): this { this.deleteOrganizationModal.clickByTestId(this.closeDeleteModalButton, { timeout, }); return this; } confirmDeleteOrganization(timeout = 10000): this { this.deleteOrganizationModal.clickByTestId(this.confirmDeleteButton, { timeout, }); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/PeoplePage.ts ================================================ /// import { ModalActions } from '../shared/ModalActions'; import { TableActions } from '../shared/TableActions'; export class PeoplePage { private readonly _peopleTabButton = '[data-cy="leftDrawerButton-People"]'; private readonly _searchInput = '[placeholder="Enter Full Name"]'; private readonly _searchButton = '[data-testid="searchbtn"]'; private readonly _addMembersBtn = '[data-testid="addMembers-toggle"]'; private readonly _existingUserToggle = '[data-testid="addMembers-item-existingUser"]'; private readonly _searchUserInput = '[data-testid="searchUser"]'; private readonly _submitSearchBtn = '[data-testid="submitBtn"]'; private readonly _addBtn = '[data-testid="addBtn"]'; private readonly _removeModalBtn = '[data-testid="removeMemberModalBtn"]'; private readonly _confirmRemoveBtnTestId = 'removeMemberBtn'; private readonly _alert = '[role=alert]'; private readonly tableActions = new TableActions('.MuiDataGrid-root'); private readonly removeMemberModal = new ModalActions('[role="dialog"]'); visitPeoplePage(): void { cy.get(this._peopleTabButton).should('be.visible').click(); cy.url().should('match', /\/admin\/orgpeople\/[a-f0-9-]+/); } searchMemberByName(name: string, timeout = 40000) { cy.get(this._searchInput, { timeout }) .should('be.visible') .clear() .type(name); cy.get(this._searchButton, { timeout }).should('be.visible').click(); return this; } verifyMemberInList(name: string, timeout = 40000) { this.tableActions.findRowByText(name, timeout); return this; } clickAddExistingMember(timeout = 40000) { cy.get(this._addMembersBtn, { timeout }).should('be.visible').click(); cy.get(this._existingUserToggle, { timeout }) .should('be.visible') .trigger('click'); return this; } searchAndSelectUser(name: string, timeout = 40000) { cy.get(this._searchUserInput, { timeout }) .should('be.visible') .clear() .type(name); cy.get(this._submitSearchBtn, { timeout }).should('be.visible').click(); cy.contains(name, { timeout }).should('be.visible'); return this; } confirmAddUser(name: string, timeout = 100000) { cy.get(this._addBtn, { timeout }).first().should('be.visible').click(); cy.contains(this._alert, 'Member added Successfully', { timeout }).should( 'be.visible', ); cy.reload(); this.searchMemberByName(name, timeout); this.verifyMemberInList(name, timeout); return this; } deleteMember(name: string, timeout = 40000) { this.searchMemberByName(name, timeout); cy.then(() => { this.tableActions.waitVisible(timeout); this.tableActions.clickRowActionByText( name, this._removeModalBtn, timeout, ); }); this.removeMemberModal .waitVisible(timeout) .clickByTestId(this._confirmRemoveBtnTestId, { timeout }); cy.get(this._alert, { timeout }) .should('be.visible') .and('contain.text', 'The Member is removed'); return this; } resetSearch(timeout = 40000) { cy.get(this._searchInput, { timeout }).should('be.visible').clear(); cy.get(this._searchButton, { timeout }).should('be.visible').click(); return this; } verifyMinRows(minRows: number, timeout = 40000) { this.tableActions.expectMinRows(minRows, timeout); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/PostPage.ts ================================================ export class PostsPage { private readonly _postsTabButton = '[data-cy="leftDrawerButton-Posts"]'; private readonly _createPostButton = '[data-cy="createPostModalBtn"]'; private readonly _postTitleInput = '[data-cy="modalTitle"]'; private readonly _postDescriptionInput = '[data-cy="create-post-description"]'; private readonly _pinPostCheckbox = '[data-cy="pinPost"]'; private readonly _moreOptionsIcon = '[data-testid="post-more-options-button"]'; private readonly _editOption = '[data-testid="edit-post-menu-item"]'; private readonly _createPostSubmit = '[data-testid="createPostBtn"]'; private readonly _deleteOption = '[data-testid="delete-post-button"]'; private readonly _sortButton = '[data-testid="sortpost-toggle"]'; visitPostsPage() { cy.get(this._postsTabButton).should('be.visible').click(); cy.url().should('match', /\/orgpost\/[a-f0-9-]+/); return this; } createPost(title: string, description: string) { cy.get(this._createPostButton).should('be.visible').click(); cy.get(this._postTitleInput).filter(':visible').type(title); cy.get(this._postDescriptionInput).filter(':visible').type(description); cy.get(this._pinPostCheckbox).filter(':visible').click(); cy.get(this._createPostSubmit) .filter(':visible') .should('be.visible') .click(); cy.assertToast('Congratulations! You have Posted Something.'); return this; } sortPostsByNewest() { cy.get(this._sortButton).should('be.visible').click(); cy.get('[data-testid="sortpost-item-latest"]').should('be.visible').click(); return this; } editFirstPost(newTitle: string) { this.sortPostsByNewest(); cy.get(this._moreOptionsIcon).first().should('be.visible').click(); cy.get(this._editOption).should('be.visible').click(); cy.get(this._postTitleInput).filter(':visible').clear().type(newTitle); cy.get(this._createPostSubmit).filter(':visible').click({ force: true }); cy.assertToast('Post updated successfully'); return this; } deleteFirstPost() { cy.get(this._moreOptionsIcon).first().should('be.visible').click(); cy.get(this._deleteOption).should('be.visible').click(); cy.assertToast('Post deleted successfully.'); return this; } } ================================================ FILE: cypress/pageObjects/AdminPortal/VolunteerManagementPage.ts ================================================ import { BasePage } from '../base/BasePage'; export class VolunteerManagementPage extends BasePage { private readonly volunteersTabButton = 'volunteersBtn'; private readonly volunteersTabPanel = 'eventVolunteersTab'; private readonly individualToggle = 'individualRadio'; private readonly groupsToggle = 'groupsRadio'; private readonly requestsToggle = 'requestsRadio'; private readonly addVolunteerButton = 'addVolunteerBtn'; private readonly createGroupButton = 'createGroupBtn'; protected self(): VolunteerManagementPage { return this; } visitPage(orgId: string, eventId: string, timeout = 30000): this { this.visit(`/admin/event/${orgId}/${eventId}`); this.assertUrlIncludes(`/admin/event/${orgId}/${eventId}`, timeout); return this; } openVolunteersTab(timeout = 10000): this { this.byTestId(this.volunteersTabButton, timeout) .should('be.visible') .click(); this.byTestId(this.volunteersTabPanel, timeout).should('be.visible'); return this; } showIndividuals(timeout = 10000): this { this.byTestId(this.individualToggle, timeout).should('be.visible').click(); return this; } showGroups(timeout = 10000): this { this.byTestId(this.groupsToggle, timeout).should('be.visible').click(); return this; } showRequests(timeout = 10000): this { this.byTestId(this.requestsToggle, timeout).should('be.visible').click(); return this; } openAddVolunteerModal(timeout = 10000): this { this.byTestId(this.addVolunteerButton, timeout) .should('be.visible') .click(); this.modalActions().waitVisible(timeout); return this; } openCreateGroupModal(timeout = 10000): this { this.byTestId(this.createGroupButton, timeout).should('be.visible').click(); this.modalActions().waitVisible(timeout); return this; } } ================================================ FILE: cypress/pageObjects/UserPortal/UserDashboard.ts ================================================ export class UserDashboardPage { private readonly _orgCard: string = '[data-cy="orgCard"]'; private readonly _manageButton: string = '[data-cy="manageBtn"]'; visit() { cy.visit('/user/organizations'); return this; } verifyOnDashboard(timeout = 10000) { cy.url({ timeout }).should('include', '/user/organizations'); cy.get(this._orgCard, { timeout }).should('be.visible'); return this; } openFirstOrganization(timeout = 10000) { cy.get(this._manageButton, { timeout }) .should('be.visible') .first() .click(); cy.url({ timeout }).should('match', /\/user\/organization\/[a-f0-9-]+/); return this; } } ================================================ FILE: cypress/pageObjects/auth/LoginPage.ts ================================================ /** * Page Object Model for the Login Page. * Contains selectors and methods for interacting with the login page. */ export class LoginPage { private readonly _emailInput: string = '[data-cy=loginEmail]'; private readonly _passwordInput: string = '[data-cy=loginPassword]'; private readonly _loginButton: string = '[data-cy=loginBtn]'; verifyLoginPage(timeout = 10000) { cy.get(this._emailInput, { timeout }).should('be.visible'); cy.get(this._passwordInput, { timeout }).should('be.visible'); cy.get(this._loginButton, { timeout }).should('be.visible'); return this; } login(email: string, password: string, timeout = 10000) { cy.get(this._emailInput, { timeout }) .should('be.visible') .clear() .type(email); cy.get(this._passwordInput, { timeout }) .should('be.visible') .clear() .type(password); cy.get(this._loginButton, { timeout }).should('be.enabled').click(); return this; } verifyToastVisible(expectedMessage?: string, timeout = 10000) { const toast = cy.get('[role=alert]', { timeout }).should('be.visible'); if (expectedMessage) { toast.should('contain.text', expectedMessage); } return this; } verifyErrorToast(timeout = 10000) { return this.verifyToastVisible(undefined, timeout); } } ================================================ FILE: cypress/pageObjects/base/BasePage.ts ================================================ import { ModalActions } from '../shared/ModalActions'; import { TableActions } from '../shared/TableActions'; export abstract class BasePage> { protected abstract self(): TSelf; protected byTestId( testId: string, timeout = 10000, ): Cypress.Chainable> { return cy.get(`[data-testid="${testId}"]`, { timeout }); } protected byDataCy( value: string, timeout = 10000, ): Cypress.Chainable> { return cy.get(`[data-cy="${value}"]`, { timeout }); } protected tableActions(tableSelector = '.MuiDataGrid-root'): TableActions { return new TableActions(tableSelector); } protected modalActions(rootSelector = '[role="dialog"]'): ModalActions { return new ModalActions(rootSelector); } protected assertUrlIncludes(path: string, timeout = 10000): TSelf { cy.url({ timeout }).should('include', path); return this.self(); } protected assertUrlMatch(pattern: RegExp, timeout = 10000): TSelf { cy.url({ timeout }).should('match', pattern); return this.self(); } visit(path: string): TSelf { cy.visit(path); return this.self(); } } ================================================ FILE: cypress/pageObjects/shared/ModalActions.ts ================================================ import type { ClickOptions, TestIdClickConfig } from './types'; export class ModalActions { constructor(private readonly rootSelector = '[role="dialog"]') {} private root(timeout = 10000): Cypress.Chainable> { return cy.get(this.rootSelector, { timeout }); } waitVisible(timeout = 10000): this { this.root(timeout).should('be.visible'); return this; } clickByTestId( testId: string, { options, timeout = 10000 }: TestIdClickConfig = {}, ): this { this.root(timeout) .find(`[data-testid="${testId}"]`) .should('be.visible') .click(options); return this; } clickBySelector( selector: string, options?: ClickOptions, timeout = 10000, ): this { this.root(timeout).find(selector).should('be.visible').click(options); return this; } submit(testId = 'modal-submit-btn', options?: ClickOptions): this { return this.clickByTestId(testId, { options }); } cancel(testId = 'modal-cancel-btn', options?: ClickOptions): this { return this.clickByTestId(testId, { options }); } close(testId = 'modalCloseBtn', options?: ClickOptions): this { return this.clickByTestId(testId, { options }); } hasTitle(title: string, timeout = 10000): this { this.root(timeout) .find('h1,h2,h3,[class*="Title"],[role="heading"]') .should('contain.text', title) .and('be.visible'); return this; } } ================================================ FILE: cypress/pageObjects/shared/TableActions.ts ================================================ import type { ClickOptions } from './types'; export class TableActions { constructor(private readonly tableSelector = '.MuiDataGrid-root') {} private escapeRegex(text: string): string { return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); } private root(timeout = 10000): Cypress.Chainable> { return cy.get(this.tableSelector, { timeout }); } waitVisible(timeout = 10000): this { this.root(timeout).should('be.visible'); return this; } findRowByText( text: string, timeout = 10000, exact = true, ): Cypress.Chainable> { const matcher = exact ? new RegExp(`^${this.escapeRegex(text)}$`) : null; return cy .get(`${this.tableSelector} .MuiDataGrid-row`, { timeout }) .then(($rows) => { const matchedRow = $rows.toArray().find((row) => { const cells = Cypress.$(row).find('[role="gridcell"], td').toArray(); return cells.some((cell) => { const cellText = Cypress.$(cell).text().trim(); if (matcher) { return matcher.test(cellText); } return cellText.includes(text); }); }); if (!matchedRow) { throw new Error( `No DataGrid row found in ${this.tableSelector} matching text "${text}".`, ); } return cy.wrap(matchedRow, { log: false }); }) .should('be.visible'); } clickRowActionByText( rowText: string, actionSelector: string, timeout = 10000, options?: ClickOptions, exact = true, ): this { this.findRowByText(rowText, timeout, exact) .find(actionSelector) .should('be.visible') .click(options); return this; } // Intentionally global queries: sorting menus can render outside `tableSelector`. sortBy( toggleSelector: string, optionSelector: string, timeout = 10000, ): this { cy.get(toggleSelector, { timeout }).should('be.visible').click(); cy.get(optionSelector, { timeout }).should('be.visible').click(); return this; } filterBy(inputSelector: string, value: string, timeout = 10000): this { cy.get(inputSelector, { timeout }).should('be.visible').clear().type(value); return this; } expectMinRows(minRows: number, timeout = 10000): this { cy.get(`${this.tableSelector} .MuiDataGrid-row`, { timeout }).should( 'have.length.at.least', minRows, ); return this; } cell( rowIndex: number, columnIndex: number, timeout = 10000, ): Cypress.Chainable> { return cy .get(`${this.tableSelector} .MuiDataGrid-row`, { timeout }) .eq(rowIndex) .find('[role="gridcell"], td') .eq(columnIndex); } } ================================================ FILE: cypress/pageObjects/shared/types.ts ================================================ export type ClickOptions = Partial; export interface TestIdClickConfig { options?: ClickOptions; timeout?: number; } ================================================ FILE: cypress/support/commands.ts ================================================ /// import { getApiPattern } from './graphql-utils'; export {}; type AuthRole = 'superAdmin' | 'admin' | 'user'; type AuthOptions = { role?: AuthRole; email?: string; password?: string; token?: string; userId?: string; apiUrl?: string; recaptchaToken?: string; }; type SetupTestEnvironmentOptions = { orgName?: string; description?: string; auth?: AuthOptions; }; type CreateTestOrganizationPayload = { name: string; description?: string; addressLine1?: string; addressLine2?: string; city?: string; state?: string; postalCode?: string; countryCode?: string; isUserRegistrationRequired?: boolean; auth?: AuthOptions; }; type CreateOrganizationMembershipOptions = { memberId: string; organizationId: string; role?: 'administrator' | 'regular'; auth?: AuthOptions; }; type SeedEventPayload = { orgId: string; name?: string; description?: string; startAt?: string; endAt?: string; location?: string; isPublic?: boolean; isRegisterable?: boolean; auth?: AuthOptions; }; type SeedUserDetails = { name?: string; email?: string; password?: string; role?: 'administrator' | 'regular'; isEmailAddressVerified?: boolean; }; type SeedUserPayload = SeedUserDetails & { auth?: AuthOptions; }; type SeedVolunteerPayload = { eventId: string; userId?: string; user?: SeedUserDetails; auth?: AuthOptions; userAuth?: AuthOptions; scope?: 'ENTIRE_SERIES' | 'THIS_INSTANCE_ONLY'; recurringEventInstanceId?: string; }; type SeedPostPayload = { orgId: string; caption?: string; body?: string; isPinned?: boolean; auth?: AuthOptions; }; type SeedActionItemCategoryPayload = { orgId: string; name?: string; description?: string; isDisabled?: boolean; auth?: AuthOptions; }; type CleanupTestOrganizationOptions = { auth?: AuthOptions; userIds?: string[]; allowNotFound?: boolean; }; type CreateTestUserPayload = { name?: string; email?: string; password?: string; role?: 'administrator' | 'regular'; isEmailAddressVerified?: boolean; auth?: AuthOptions; }; type SignInTaskResult = { token: string; userId: string }; type AuthSession = { token: string; userId?: string }; type CreateOrganizationTaskResult = { orgId: string }; type CreateEventTaskResult = { eventId: string }; type CreateUserTaskResult = { userId: string; authenticationToken?: string; }; type CreateVolunteerTaskResult = { volunteerId: string }; type CreatePostTaskResult = { postId: string }; type CredentialRecord = { email: string; password: string }; type CredentialFixture = Record; const DEFAULT_TEST_PASSWORD = 'Pass@123'; const roleToEnvKey = ( role: AuthRole, ): { emailKey: string; passwordKey: string } => { switch (role) { case 'superAdmin': return { emailKey: 'E2E_SUPERADMIN_EMAIL', passwordKey: 'E2E_SUPERADMIN_PASSWORD', }; case 'user': return { emailKey: 'E2E_USER_EMAIL', passwordKey: 'E2E_USER_PASSWORD' }; case 'admin': return { emailKey: 'E2E_ADMIN_EMAIL', passwordKey: 'E2E_ADMIN_PASSWORD' }; default: throw new Error(`Unknown AuthRole: ${role}`); } }; const normalizeAuthRole = (role: string): AuthRole => { if (role === 'superadmin') return 'superAdmin'; if (role === 'admin' || role === 'user' || role === 'superAdmin') { return role; } throw new Error( `Unknown auth role "${role}". Expected "admin", "user", or "superAdmin".`, ); }; const resolveCredentials = ( role: AuthRole, overrides?: Partial, ): Cypress.Chainable => { if (overrides?.email && overrides?.password) { return cy.wrap({ email: overrides.email, password: overrides.password }); } const { emailKey, passwordKey } = roleToEnvKey(role); const envEmail = Cypress.env(emailKey) as string | undefined; const envPassword = Cypress.env(passwordKey) as string | undefined; if (envEmail && envPassword) { return cy.wrap({ email: envEmail, password: envPassword }); } return cy .fixture('auth/credentials') .then((credentials: CredentialFixture) => { const user = credentials[role]; if (!user) { throw new Error( `User role "${role}" not found in auth/credentials fixture`, ); } return user; }); }; const signInWithCredentials = ( apiUrl: string | undefined, credentials: CredentialRecord, ): Cypress.Chainable => { return cy .task('gqlSignIn', { apiUrl, email: credentials.email, password: credentials.password, }) .then((result) => { const { token, userId } = result as SignInTaskResult; if (!token) { throw new Error('SignIn task failed to return a token.'); } return { token, userId } as AuthSession; }); }; const resolveAuthSession = ( auth?: AuthOptions, ): Cypress.Chainable => { if (auth?.token) { return cy.wrap({ token: auth.token, userId: auth.userId } as AuthSession, { log: false, }); } // resolveAuthSession defaults role to 'admin' unless auth.role overrides it. const role = auth?.role ?? 'admin'; return resolveCredentials(role, auth).then((credentials) => { return signInWithCredentials(auth?.apiUrl, credentials); }); }; const resolveAuthToken = (auth?: AuthOptions): Cypress.Chainable => resolveAuthSession(auth).then((session) => session.token); const getSecureRandomSuffix = (length = 8): string => { if (globalThis.crypto?.randomUUID) { return globalThis.crypto.randomUUID().replace(/-/g, '').slice(0, length); } if (globalThis.crypto?.getRandomValues) { const bytes = new Uint8Array(length); globalThis.crypto.getRandomValues(bytes); return Array.from(bytes, (byte) => byte.toString(16).padStart(2, '0')) .join('') .slice(0, length); } return String(Date.now()).slice(0, length); }; const makeUniqueLabel = (prefix: string): string => { const suffix = `${Date.now()}-${getSecureRandomSuffix(8)}`; return `${prefix} ${suffix}`; }; declare global { namespace Cypress { interface Chainable { /** * @param role - The user role (e.g., 'superadmin', 'admin', 'user') */ loginByApi(role: string): Chainable; /** * @param expectedMessage - The expected text (string or RegExp) */ assertToast(expectedMessage: string | RegExp): Chainable; /** * Reset GraphQL intercepts back to pass-through behavior. * @returns Chainable */ clearAllGraphQLMocks(): Chainable; setupTestEnvironment( options?: SetupTestEnvironmentOptions, ): Chainable<{ orgId: string }>; createTestOrganization( payload: CreateTestOrganizationPayload, ): Chainable<{ orgId: string }>; createOrganizationMembership( payload: CreateOrganizationMembershipOptions, ): Chainable; createTestUser( payload: CreateTestUserPayload, ): Chainable<{ userId: string; email: string; password: string }>; seedTestData( kind: 'events', payload: SeedEventPayload, ): Chainable<{ eventId: string }>; seedTestData( kind: 'volunteers', payload: SeedVolunteerPayload, ): Chainable<{ volunteerId: string; userId?: string; email?: string; password?: string; }>; seedTestData( kind: 'posts', payload: SeedPostPayload, ): Chainable<{ postId: string }>; seedTestData( kind: 'actionItemCategories', payload: SeedActionItemCategoryPayload, ): Chainable<{ categoryId: string; name?: string }>; cleanupTestOrganization( orgId: string, options?: CleanupTestOrganizationOptions, ): Chainable; } } } Cypress.Commands.add('loginByApi', (role: string) => { const resolvedRole = normalizeAuthRole(role); const sessionName = `login-${resolvedRole}`; const loginPath = resolvedRole === 'user' ? '/' : '/admin'; const currentUserQuery = ` query CurrentUser { currentUser { id } } `; const storagePrefix = 'Talawa-admin'; const roleValue = resolvedRole === 'superAdmin' ? 'superuser' : resolvedRole === 'admin' ? 'administrator' : 'user'; const setAuthStorage = ( win: Window, token: string, userId: string | undefined, email: string, ): void => { const setItem = (key: string, value: unknown) => { win.localStorage.setItem( `${storagePrefix}_${key}`, JSON.stringify(value), ); }; setItem('token', token); setItem('role', roleValue); setItem('email', email); if (userId) { setItem('userId', userId); setItem('id', userId); } setItem('IsLoggedIn', 'TRUE'); }; return cy.session( sessionName, () => { resolveCredentials(resolvedRole).then((user) => { const apiUrl = (Cypress.env('apiUrl') as string | undefined) || 'http://localhost:4000/graphql'; return cy .task('gqlSignIn', { apiUrl, email: user.email, password: user.password, }) .then((result) => { const { token, userId } = result as SignInTaskResult; if (!token) { const { emailKey, passwordKey } = roleToEnvKey(resolvedRole); throw new Error( `Login failed: SignIn did not return a token. Verify credentials for role "${resolvedRole}" via ${emailKey}/${passwordKey} or cypress/fixtures/auth/credentials.json.`, ); } cy.visit(loginPath, { onBeforeLoad(win) { setAuthStorage(win, token, userId, user.email); }, }); return cy .request({ method: 'POST', url: apiUrl, headers: { authorization: `Bearer ${token}`, }, body: { query: currentUserQuery, }, }) .then((response) => { if (response.status !== 200) { throw new Error( `Login health check failed with status ${response.status}.`, ); } const currentUserId = response.body?.data?.currentUser?.id || response.body?.data?.user?.id; if (!currentUserId) { throw new Error( 'Login health check failed: currentUser is missing.', ); } }); }); }); }, { cacheAcrossSpecs: true }, ); }); Cypress.Commands.add('assertToast', (expectedMessage: string | RegExp) => { cy.get('.Toastify__toast', { timeout: 5000 }) .should('be.visible') .and('contain.text', expectedMessage); }); Cypress.Commands.add('clearAllGraphQLMocks', () => { cy.intercept('POST', getApiPattern(), (req) => { req.continue(); }); }); Cypress.Commands.add( 'setupTestEnvironment', (options: SetupTestEnvironmentOptions = {}) => { const orgName = options.orgName || makeUniqueLabel('E2E Org'); return cy .createTestOrganization({ name: orgName, description: options.description ?? 'E2E organization', auth: options.auth, }) .then(({ orgId }) => ({ orgId })); }, ); Cypress.Commands.add( 'createTestOrganization', (payload: CreateTestOrganizationPayload) => { return resolveAuthSession(payload.auth).then(({ token, userId }) => { return cy .task('createTestOrganization', { apiUrl: payload.auth?.apiUrl, token, input: { name: payload.name, description: payload.description ?? 'E2E organization', addressLine1: payload.addressLine1, addressLine2: payload.addressLine2, city: payload.city, state: payload.state, postalCode: payload.postalCode, countryCode: payload.countryCode, isUserRegistrationRequired: payload.isUserRegistrationRequired, }, }) .then((result) => { const { orgId } = result as CreateOrganizationTaskResult; if (!orgId) { throw new Error('createTestOrganization did not return orgId.'); } if (userId && (payload.auth?.role ?? 'admin') === 'admin') { return cy .task('createOrganizationMembership', { apiUrl: payload.auth?.apiUrl, token, input: { memberId: userId, organizationId: orgId, role: 'administrator', }, }) .then(() => ({ orgId })); } return cy.wrap({ orgId }); }); }); }, ); Cypress.Commands.add( 'createOrganizationMembership', (payload: CreateOrganizationMembershipOptions) => { const role = payload.role ?? 'administrator'; return resolveAuthToken(payload.auth).then((token) => { return cy .task('createOrganizationMembership', { apiUrl: payload.auth?.apiUrl, token, input: { memberId: payload.memberId, organizationId: payload.organizationId, role, }, }) .then(() => { return undefined; }) as Cypress.Chainable; }); }, ); Cypress.Commands.add('createTestUser', (payload: CreateTestUserPayload) => { const email = payload.email || `e2e-user-${Date.now()}-${getSecureRandomSuffix(8)}@example.com`; const password = payload.password || DEFAULT_TEST_PASSWORD; const name = payload.name || makeUniqueLabel('E2E User'); const role = payload.role ?? 'regular'; return resolveAuthToken(payload.auth).then((token) => { return cy .task('createTestUser', { apiUrl: payload.auth?.apiUrl, token, input: { name, emailAddress: email, password, role, isEmailAddressVerified: payload.isEmailAddressVerified ?? true, }, }) .then((result) => { const { userId } = result as CreateUserTaskResult; if (!userId) { throw new Error('createTestUser did not return userId.'); } return { userId, email, password }; }); }); }); /** * Seeds test data (events, volunteers, posts, action item categories) via direct GraphQL API calls. * * **Role escalation**: If `auth.role` is `'admin'` (or omitted, defaulting to * `'admin'`), the implementation automatically escalates to `'superAdmin'` * when calling `resolveAuthToken` for **user creation only**. * Event and volunteer creation require org membership, not superAdmin privilege, * so those use the caller's role directly. */ Cypress.Commands.add( 'seedTestData', ( kind: 'events' | 'volunteers' | 'posts' | 'actionItemCategories', payload: | SeedEventPayload | SeedVolunteerPayload | SeedPostPayload | SeedActionItemCategoryPayload, ) => { if (kind === 'events') { const eventPayload = payload as SeedEventPayload; const defaultStart = new Date(Date.now() + 5 * 60 * 1000); const startAt = eventPayload.startAt ?? defaultStart.toISOString(); const endAt = eventPayload.endAt ?? new Date(defaultStart.getTime() + 60 * 60 * 1000).toISOString(); const name = eventPayload.name || makeUniqueLabel('E2E Event'); const createEvent = (token: string) => { return cy .task('createTestEvent', { apiUrl: eventPayload.auth?.apiUrl, token, input: { name, description: eventPayload.description ?? 'E2E event', organizationId: eventPayload.orgId, startAt, endAt, location: eventPayload.location ?? 'Virtual', isPublic: eventPayload.isPublic ?? true, isRegisterable: eventPayload.isRegisterable ?? true, }, }) .then((result) => { const { eventId } = result as CreateEventTaskResult; if (!eventId) { throw new Error('seedTestData(events) did not return eventId.'); } return { eventId }; }); }; return resolveAuthToken(eventPayload.auth).then((token) => { return createEvent(token); }); } if (kind === 'actionItemCategories') { const categoryPayload = payload as SeedActionItemCategoryPayload; const name = categoryPayload.name || makeUniqueLabel('E2E Action Item Category'); const description = categoryPayload.description ?? 'E2E Action Item Category'; const isDisabled = categoryPayload.isDisabled ?? false; return resolveAuthToken(categoryPayload.auth).then((token) => { return cy .task('createTestActionItemCategory', { apiUrl: categoryPayload.auth?.apiUrl, token, input: { name, description, isDisabled, organizationId: categoryPayload.orgId, }, }) .then((result) => { const { categoryId } = result as { categoryId?: string; name?: string; }; if (!categoryId) { throw new Error( 'seedTestData(actionItemCategories) did not return categoryId.', ); } return { categoryId, name }; }); }); } const createSeedUser = (userPayload: SeedUserPayload) => { const email = userPayload.email || `e2e-user-${Date.now()}-${getSecureRandomSuffix(8)}@example.com`; const password = userPayload.password || DEFAULT_TEST_PASSWORD; const name = userPayload.name || makeUniqueLabel('E2E User'); const role = userPayload.role ?? 'regular'; const userAuth = (userPayload.auth?.role ?? 'admin') === 'admin' ? { ...(userPayload.auth ?? {}), role: 'superAdmin' as const } : userPayload.auth; return resolveAuthToken(userAuth).then((token) => { return cy .task('createTestUser', { apiUrl: userPayload.auth?.apiUrl, token, input: { name, emailAddress: email, password, role, isEmailAddressVerified: userPayload.isEmailAddressVerified ?? true, }, }) .then((result) => { const { userId } = result as CreateUserTaskResult; if (!userId) { throw new Error('createTestUser did not return userId.'); } return { userId, email, password }; }); }); }; if (kind === 'posts') { const postPayload = payload as SeedPostPayload; const caption = postPayload.caption || makeUniqueLabel('E2E Post'); const body = postPayload.body ?? 'E2E post body'; const isPinned = postPayload.isPinned ?? false; return resolveAuthToken(postPayload.auth).then((token) => { return cy .task('createTestPost', { apiUrl: postPayload.auth?.apiUrl, token, input: { caption, body, organizationId: postPayload.orgId, isPinned, }, }) .then((result) => { const { postId } = result as CreatePostTaskResult; if (!postId) { throw new Error('seedTestData(posts) did not return postId.'); } return { postId }; }); }); } if (kind === 'volunteers') { const volunteerPayload = payload as SeedVolunteerPayload; // Unified chain to guarantee consistent return type const ensureUser = (): Cypress.Chainable<{ userId: string; email?: string; password?: string; }> => { if (volunteerPayload.userId) { return cy.wrap({ userId: volunteerPayload.userId, email: undefined, password: undefined, }); } return createSeedUser({ ...(volunteerPayload.user ?? {}), auth: volunteerPayload.userAuth, }) as Cypress.Chainable<{ userId: string; email?: string; password?: string; }>; }; return ensureUser().then( (userResult: { userId: string; email?: string; password?: string }) => { const { userId, email, password } = userResult; if (!userId) { throw new Error('seedTestData(volunteers) missing userId.'); } const createVolunteer = (token: string) => { return cy .task('createTestVolunteer', { apiUrl: volunteerPayload.auth?.apiUrl, token, input: { eventId: volunteerPayload.eventId, userId, scope: volunteerPayload.scope, recurringEventInstanceId: volunteerPayload.recurringEventInstanceId, }, }) .then((result) => { const { volunteerId } = result as CreateVolunteerTaskResult; if (!volunteerId) { throw new Error( 'seedTestData(volunteers) did not return volunteerId.', ); } return { volunteerId, userId, email, password }; }); }; return resolveAuthToken(volunteerPayload.auth).then((token) => { return createVolunteer(token); }); }, ); } return cy.wrap(undefined); }, ); Cypress.Commands.add( 'cleanupTestOrganization', (orgId: string, options: CleanupTestOrganizationOptions = {}) => { return resolveAuthToken(options.auth).then((token) => { const apiUrl = options.auth?.apiUrl; return cy .task('deleteTestOrganization', { apiUrl, token, orgId, allowNotFound: options.allowNotFound ?? true, }) .then(() => { const userIds = options.userIds ?? []; if (userIds.length === 0) { return undefined; } return cy .wrap(userIds) .each((userId) => { return cy.task('deleteTestUser', { apiUrl, token, userId, allowNotFound: true, }); }) .then(() => undefined) as Cypress.Chainable; }); }); }, ); ================================================ FILE: cypress/support/e2e.ts ================================================ // ********************* // This example support/e2e.ts is processed and // loaded automatically before your test files. // // This is a great place to put global configuration and // behavior that modifies Cypress. // // You can change the location of this file or turn off // automatically serving support files with the // 'supportFile' configuration option. // // You can read more here: // https://on.cypress.io/configuration // ********************* // Import commands.js using ES2015 syntax: import './commands'; import './graphql-utils'; import '@cypress/code-coverage/support'; Cypress.on('uncaught:exception', () => { return false; }); afterEach(() => { cy.clearAllGraphQLMocks(); }); ================================================ FILE: cypress/support/graphql-utils.ts ================================================ /// import type { CyHttpMessages } from 'cypress/types/net-stubbing'; export {}; /** * @public * GraphQL responder used by Cypress utilities to mock operation responses. * Supports fixture paths, inline body objects, or custom request handlers. */ type GqlResponder = | string | Record | ((req: CyHttpMessages.IncomingHttpRequest) => void); /** * @public * Extensions object for GraphQL errors (key/value metadata map). */ type GqlErrorExtensions = Record; /** * @public * Partial Cypress response configuration applied when replying to operations. */ type GqlOperationOptions = Partial; type GqlOperationConfig = GqlOperationOptions & { timeout?: number; }; export const getApiPattern = (): string => { const apiUrl = (Cypress.env('apiUrl') as string | undefined) || (Cypress.env('API_URL') as string | undefined) || (Cypress.env('CYPRESS_API_URL') as string | undefined); return apiUrl || '**/graphql'; }; const interceptGraphQLOperation = ( operationName: string, handler: (req: CyHttpMessages.IncomingHttpRequest) => void, ): void => { const apiPattern = getApiPattern(); cy.intercept('POST', apiPattern, (req) => { if (req.body?.operationName !== operationName) { req.continue(); return; } req.alias = operationName; handler(req); }); }; /** * Alias a GraphQL operation by name so it can be awaited via cy.wait. * @param operationName - GraphQL operationName to alias. * @returns void */ export const aliasGraphQLOperation = (operationName: string): void => { interceptGraphQLOperation(operationName, (req) => req.continue()); }; /** * Wait for a previously-aliased GraphQL operation. * @param operationName - GraphQL operationName to await. * @returns Cypress chainable interception for further assertions. */ export const waitForGraphQLOperation = ( operationName: string, ): Cypress.Chainable => { return cy.wait( `@${operationName}`, ) as Cypress.Chainable; }; /** * Mock a GraphQL operation response by operationName. * * Uses interceptGraphQLOperation to route matching requests and applies * the responder based on its shape: * - function: receives the request and can call req.reply or req.continue manually * - string: treated as a fixture path and passed to req.reply with fixture and options * - object: treated as a response body and passed to req.reply with body and options * * @param operationName - GraphQL operationName to mock. * @param responder - Fixture path, inline body, or request handler. * @param options - Partial Cypress.StaticResponse merged into req.reply. * @returns void */ export const mockGraphQLOperation = ( operationName: string, responder: GqlResponder, options?: GqlOperationConfig, ): void => { const { timeout, ...responseOptions } = options ?? {}; interceptGraphQLOperation(operationName, (req) => { if (timeout) { req.on('response', (res) => { res.setDelay(timeout); }); } if (typeof responder === 'function') { responder(req); return; } if (typeof responder === 'string') { req.reply({ fixture: responder, ...responseOptions }); return; } req.reply({ body: responder, ...responseOptions }); }); }; /** * Mock a GraphQL error response for a named operation. * * @param operationName - GraphQL operationName to mock. * @param message - Error message returned in the GraphQL errors array. * @param code - Optional error code (default: 'GRAPHQL_ERROR'). * @param extensions - Optional GraphQL error extensions. * @returns void * * @example * mockGraphQLError('CreateOrganization', 'Organization name already exists', 'CONFLICT'); */ export const mockGraphQLError = ( operationName: string, message: string, code = 'GRAPHQL_ERROR', extensions: GqlErrorExtensions = {}, ): void => { mockGraphQLOperation(operationName, { errors: [{ message, extensions: { code, ...extensions } }], }); }; declare global { namespace Cypress { interface Chainable { aliasGraphQLOperation(operationName: string): Chainable; waitForGraphQLOperation( operationName: string, ): Chainable; mockGraphQLOperation( operationName: string, responder: GqlResponder, options?: GqlOperationConfig, ): Chainable; mockGraphQLError( operationName: string, message: string, code?: string, extensions?: GqlErrorExtensions, ): Chainable; } } } Cypress.Commands.add('aliasGraphQLOperation', aliasGraphQLOperation); Cypress.Commands.add('waitForGraphQLOperation', waitForGraphQLOperation); Cypress.Commands.add('mockGraphQLOperation', mockGraphQLOperation); Cypress.Commands.add('mockGraphQLError', mockGraphQLError); ================================================ FILE: cypress.config.ts ================================================ import { defineConfig } from 'cypress'; import fs from 'node:fs'; import { URL } from 'node:url'; import codeCoverageTask from '@cypress/code-coverage/task'; import dotenv from 'dotenv'; dotenv.config(); const PORT = process.env.PORT || '4321'; const DEFAULT_API_URL = 'http://localhost:4000/graphql'; type GraphQLError = { message: string; extensions?: Record }; type GraphQLResponse = { data?: T; errors?: GraphQLError[] }; /** Returns true when a GraphQL error array contains a 'forbidden' code whose * extensions.issues indicate the resource already exists / is installed. */ const isForbiddenWithExistingResource = ( errors: { message: string; extensions?: Record }[], ): boolean => errors.some((error) => { const code = typeof error.extensions?.code === 'string' ? error.extensions.code.toLowerCase() : ''; const issues = Array.isArray(error.extensions?.issues) ? (error.extensions.issues as { message?: string }[]) : []; return ( code.includes('forbidden') && issues.some((issue) => /already\s*exists|installed/i.test(issue.message ?? ''), ) ); }); const resolveApiUrl = (rawUrl?: string): string => { const baseUrl = rawUrl || process.env.CYPRESS_API_URL || process.env.API_URL || DEFAULT_API_URL; if (baseUrl.endsWith('/graphql')) { return baseUrl; } return new URL('/graphql', baseUrl).toString(); }; const postGraphQL = async ( apiUrl: string, token: string | undefined, body: { operationName: string; query: string; variables?: Record; }, ): Promise> => { const fetcher = globalThis.fetch; if (!fetcher) { throw new Error('Global fetch is not available in this Node runtime.'); } const response = await fetcher(apiUrl, { method: 'POST', headers: { 'Content-Type': 'application/json', ...(token ? { authorization: `Bearer ${token}` } : {}), }, body: JSON.stringify(body), }); let json: GraphQLResponse; try { json = (await response.clone().json()) as GraphQLResponse; } catch (error) { let rawBody = ''; try { rawBody = await response.text(); } catch (readError) { const readMessage = readError instanceof Error ? readError.message : String(readError); rawBody = `Unable to read response body: ${readMessage}`; } const errorMessage = error instanceof Error ? error.message : 'Unknown JSON parse error'; return { errors: [ { message: `GraphQL response parse failed (${response.status} ${response.statusText}). ${rawBody || errorMessage}`, }, ], }; } if (!response.ok && !json.errors?.length) { return { errors: [ { message: `GraphQL request failed (${response.status} ${response.statusText})`, }, ], }; } return json; }; const SIGN_IN_QUERY = ` query SignIn($email: EmailAddress!, $password: String!) { signIn( input: { emailAddress: $email password: $password } ) { user { id } authenticationToken } } `; const CREATE_ORGANIZATION_MUTATION = ` mutation CreateOrganization($input: MutationCreateOrganizationInput!) { createOrganization(input: $input) { id } } `; const CREATE_ORGANIZATION_MEMBERSHIP_MUTATION = ` mutation CreateOrganizationMembership( $input: MutationCreateOrganizationMembershipInput! ) { createOrganizationMembership(input: $input) { id } } `; const CREATE_EVENT_MUTATION = ` mutation CreateEvent($input: MutationCreateEventInput!) { createEvent(input: $input) { id } } `; const CREATE_USER_MUTATION = ` mutation CreateUser($input: MutationCreateUserInput!) { createUser(input: $input) { authenticationToken user { id } } } `; const CREATE_VOLUNTEER_MUTATION = ` mutation CreateEventVolunteer($data: EventVolunteerInput!) { createEventVolunteer(data: $data) { id } } `; const CREATE_POST_MUTATION = ` mutation CreatePost($input: MutationCreatePostInput!) { createPost(input: $input) { id } } `; const CREATE_PLUGIN_MUTATION = ` mutation CreatePlugin($input: CreatePluginInput!) { createPlugin(input: $input) { id pluginId isInstalled isActivated } } `; const INSTALL_PLUGIN_MUTATION = ` mutation InstallPlugin($input: InstallPluginInput!) { installPlugin(input: $input) { id pluginId isInstalled isActivated } } `; const CREATE_ACTION_ITEM_CATEGORY_MUTATION = ` mutation CreateActionItemCategory($input: MutationCreateActionItemCategoryInput!) { createActionItemCategory(input: $input) { id name } } `; const DELETE_ORGANIZATION_MUTATION = ` mutation DeleteOrganization($input: MutationDeleteOrganizationInput!) { deleteOrganization(input: $input) { id } } `; const DELETE_USER_MUTATION = ` mutation DeleteUser($input: MutationDeleteUserInput!) { deleteUser(input: $input) { id } } `; export default defineConfig({ e2e: { baseUrl: `http://localhost:${PORT}`, // Viewport settings viewportWidth: 1920, viewportHeight: 1080, specPattern: 'cypress/e2e/**/*.cy.ts', supportFile: 'cypress/support/e2e.ts', defaultCommandTimeout: 50000, requestTimeout: 50000, responseTimeout: 50000, pageLoadTimeout: 50000, testIsolation: true, // Reset browser context between tests experimentalRunAllSpecs: true, watchForFileChanges: true, chromeWebSecurity: false, retries: { runMode: 2, openMode: 0, }, // Environment variables env: { apiUrl: resolveApiUrl(), RECAPTCHA_SITE_KEY: process.env.REACT_APP_RECAPTCHA_SITE_KEY, E2E_ADMIN_EMAIL: process.env.E2E_ADMIN_EMAIL || process.env.CYPRESS_E2E_ADMIN_EMAIL, E2E_ADMIN_PASSWORD: process.env.E2E_ADMIN_PASSWORD || process.env.CYPRESS_E2E_ADMIN_PASSWORD, E2E_SUPERADMIN_EMAIL: process.env.E2E_SUPERADMIN_EMAIL || process.env.CYPRESS_E2E_SUPERADMIN_EMAIL, E2E_SUPERADMIN_PASSWORD: process.env.E2E_SUPERADMIN_PASSWORD || process.env.CYPRESS_E2E_SUPERADMIN_PASSWORD, E2E_USER_EMAIL: process.env.E2E_USER_EMAIL || process.env.CYPRESS_E2E_USER_EMAIL, E2E_USER_PASSWORD: process.env.E2E_USER_PASSWORD || process.env.CYPRESS_E2E_USER_PASSWORD, }, setupNodeEvents(on, config) { codeCoverageTask(on, config); const runGraphQLTask = async ({ apiUrl, token, operationName, query, variables, extract, onErrors, }: { apiUrl?: string; token?: string; operationName: string; query: string; variables?: Record; extract: (data: TData | undefined) => TResult; onErrors?: (errors: GraphQLError[]) => TResult | undefined; }): Promise => { const resolvedApiUrl = resolveApiUrl( apiUrl || (config.env.apiUrl as string | undefined), ); const response = await postGraphQL(resolvedApiUrl, token, { operationName, query, variables, }); if (response.errors?.length) { const fallback = onErrors?.(response.errors); if (fallback !== undefined) { return fallback; } const errorMessage = response.errors .map((error) => error.message) .join(', '); throw new Error(`${operationName} failed: ${errorMessage}`); } return extract(response.data); }; const isNotFoundError = (errors: GraphQLError[]): boolean => { return errors.some((error) => { const extensions = error.extensions ?? {}; const code = typeof extensions.code === 'string' ? extensions.code : undefined; const classification = typeof extensions.classification === 'string' ? extensions.classification : undefined; const indicator = `${code ?? ''} ${classification ?? ''}`.toUpperCase(); if ( indicator.includes('NOT_FOUND') || indicator.includes('NOT_EXISTS') ) { return true; } return /not found|does not exist|no such/i.test(error.message); }); }; // Custom task to log messages and read files on('task', { log(message: string) { console.log(message); return null; }, readFileMaybe(filename: string) { return fs.existsSync(filename) ? fs.readFileSync(filename, 'utf8') : null; }, async gqlSignIn({ apiUrl, email, password, }: { apiUrl?: string; email: string; password: string; }) { return runGraphQLTask< { signIn?: { authenticationToken?: string; user?: { id?: string }; }; }, { token: string; userId: string } >({ apiUrl, operationName: 'SignIn', query: SIGN_IN_QUERY, variables: { email, password }, extract: (data) => { const token = data?.signIn?.authenticationToken; const userId = data?.signIn?.user?.id; if (!token) { throw new Error( 'SignIn response missing authentication token.', ); } if (!userId) { throw new Error('SignIn response missing userId.'); } return { token, userId }; }, }); }, async createTestOrganization({ apiUrl, token, input, }: { apiUrl?: string; token: string; input: Record; }) { return runGraphQLTask< { createOrganization?: { id?: string } }, { orgId: string } >({ apiUrl, token, operationName: 'CreateOrganization', query: CREATE_ORGANIZATION_MUTATION, variables: { input }, extract: (data) => { const orgId = data?.createOrganization?.id; if (!orgId) { throw new Error('CreateOrganization response missing org id.'); } return { orgId }; }, }); }, async createOrganizationMembership({ apiUrl, token, input, }: { apiUrl?: string; token: string; input: Record; }) { return runGraphQLTask< { createOrganizationMembership?: { id?: string } }, { ok: boolean } >({ apiUrl, token, operationName: 'CreateOrganizationMembership', query: CREATE_ORGANIZATION_MEMBERSHIP_MUTATION, variables: { input }, extract: (data) => ({ ok: Boolean(data?.createOrganizationMembership?.id), }), onErrors: (responseErrors) => { const errorMessage = responseErrors .map((error) => error.message) .join(', '); if (/already|exists/i.test(errorMessage)) { return { ok: true }; } return undefined; }, }); }, async createTestEvent({ apiUrl, token, input, }: { apiUrl?: string; token: string; input: Record; }) { return runGraphQLTask< { createEvent?: { id?: string } }, { eventId: string } >({ apiUrl, token, operationName: 'CreateEvent', query: CREATE_EVENT_MUTATION, variables: { input }, extract: (data) => { const eventId = data?.createEvent?.id; if (!eventId) { throw new Error('CreateEvent response missing event id.'); } return { eventId }; }, }); }, async createTestUser({ apiUrl, token, input, }: { apiUrl?: string; token: string; input: Record; }) { return runGraphQLTask< { createUser?: { authenticationToken?: string; user?: { id?: string }; }; }, { userId: string; authenticationToken?: string } >({ apiUrl, token, operationName: 'CreateUser', query: CREATE_USER_MUTATION, variables: { input }, extract: (data) => { const userId = data?.createUser?.user?.id; if (!userId) { throw new Error('CreateUser response missing user id.'); } return { userId, authenticationToken: data?.createUser?.authenticationToken, }; }, }); }, async createTestVolunteer({ apiUrl, token, input, }: { apiUrl?: string; token: string; input: Record; }) { return runGraphQLTask< { createEventVolunteer?: { id?: string } }, { volunteerId: string } >({ apiUrl, token, operationName: 'CreateEventVolunteer', query: CREATE_VOLUNTEER_MUTATION, // CREATE_VOLUNTEER_MUTATION uses $data for CreateEventVolunteer, not $input. variables: { data: input }, extract: (data) => { const volunteerId = data?.createEventVolunteer?.id; if (!volunteerId) { throw new Error('CreateEventVolunteer response missing id.'); } return { volunteerId }; }, }); }, async createTestPost({ apiUrl, token, input, }: { apiUrl?: string; token: string; input: Record; }) { return runGraphQLTask< { createPost?: { id?: string } }, { postId: string } >({ apiUrl, token, operationName: 'CreatePost', query: CREATE_POST_MUTATION, variables: { input }, extract: (data) => { const postId = data?.createPost?.id; if (!postId) { throw new Error('CreatePost response missing id.'); } return { postId }; }, }); }, async createTestPlugin({ apiUrl, token, pluginId, }: { apiUrl?: string; token: string; pluginId: string; }) { return runGraphQLTask< { createPlugin?: { id?: string } }, { ok: boolean } >({ apiUrl, token, operationName: 'CreatePlugin', query: CREATE_PLUGIN_MUTATION, variables: { input: { pluginId } }, extract: (data) => ({ ok: Boolean(data?.createPlugin?.id) }), onErrors: (responseErrors) => { const errorMessage = responseErrors .map((error) => error.message) .join(', '); if (/already|exists|duplicate/i.test(errorMessage)) { return { ok: true }; } if (isForbiddenWithExistingResource(responseErrors)) { return { ok: true }; } return undefined; }, }); }, async installTestPlugin({ apiUrl, token, pluginId, }: { apiUrl?: string; token: string; pluginId: string; }) { return runGraphQLTask< { installPlugin?: { id?: string } }, { ok: boolean } >({ apiUrl, token, operationName: 'InstallPlugin', query: INSTALL_PLUGIN_MUTATION, variables: { input: { pluginId } }, extract: (data) => ({ ok: Boolean(data?.installPlugin?.id) }), onErrors: (responseErrors) => { const errorMessage = responseErrors .map((error) => error.message) .join(', '); if ( /already.*installed|is installed|exists/i.test(errorMessage) ) { return { ok: true }; } if (isForbiddenWithExistingResource(responseErrors)) { return { ok: true }; } return undefined; }, }); }, async createTestActionItemCategory({ apiUrl, token, input, }: { apiUrl?: string; token: string; input: Record; }) { return runGraphQLTask< { createActionItemCategory?: { id?: string; name?: string } }, { categoryId: string; name?: string } >({ apiUrl, token, operationName: 'CreateActionItemCategory', query: CREATE_ACTION_ITEM_CATEGORY_MUTATION, variables: { input }, extract: (data) => { const categoryId = data?.createActionItemCategory?.id; if (!categoryId) { throw new Error( 'CreateActionItemCategory response missing category id.', ); } return { categoryId, name: data?.createActionItemCategory?.name, }; }, }); }, async deleteTestOrganization({ apiUrl, token, orgId, allowNotFound, }: { apiUrl?: string; token: string; orgId: string; allowNotFound?: boolean; }) { return runGraphQLTask< { deleteOrganization?: { id?: string } }, { ok: boolean } >({ apiUrl, token, operationName: 'DeleteOrganization', query: DELETE_ORGANIZATION_MUTATION, variables: { input: { id: orgId } }, extract: (data) => { const deletedId = data?.deleteOrganization?.id; return { ok: Boolean(deletedId) }; }, onErrors: (responseErrors) => { const errorMessage = responseErrors .map((error) => error.message) .join(', '); if (allowNotFound && isNotFoundError(responseErrors)) { return { ok: true }; } if (allowNotFound) { console.warn( `DeleteOrganization failed for ${orgId} with allowNotFound=true: ${errorMessage}`, ); } return undefined; }, }); }, async deleteTestUser({ apiUrl, token, userId, allowNotFound, }: { apiUrl?: string; token: string; userId: string; allowNotFound?: boolean; }) { return runGraphQLTask< { deleteUser?: { id?: string } }, { ok: boolean } >({ apiUrl, token, operationName: 'DeleteUser', query: DELETE_USER_MUTATION, variables: { input: { id: userId } }, extract: (data) => ({ ok: Boolean(data?.deleteUser?.id) }), onErrors: (responseErrors) => { const errorMessage = responseErrors .map((error) => error.message) .join(', '); if (allowNotFound && isNotFoundError(responseErrors)) { return { ok: true }; } if (allowNotFound) { console.warn( `DeleteUser failed for ${userId} with allowNotFound=true: ${errorMessage}`, ); } return undefined; }, }); }, }); // Browser launch options for both Chrome and Firefox on('before:browser:launch', (browser, launchOptions) => { // Chrome specific configurations if (browser.name === 'chrome') { if (browser.isHeadless) { launchOptions.args.push('--max_old_space_size=4096'); } // Chrome performance optimizations launchOptions.args.push('--disable-dev-shm-usage'); launchOptions.args.push('--no-sandbox'); } // Firefox specific configurations if (browser.name === 'firefox') { // Firefox preferences launchOptions.preferences = { ...launchOptions.preferences, 'signon.rememberSignons': false, 'browser.safebrowsing.enabled': false, 'browser.safebrowsing.malware.enabled': false, 'app.update.enabled': false, 'browser.download.folderList': 2, 'browser.download.manager.showWhenStarting': false, 'browser.helperApps.neverAsk.saveToDisk': 'application/pdf,text/csv,application/csv', }; launchOptions.args = launchOptions.args || []; } return launchOptions; }); // Custom plugins can be registered here // Example: require('@cypress/code-coverage/task')(on, config); return config; }, }, includeShadowDom: true, experimentalStudio: true, downloadsFolder: 'cypress/downloads', fixturesFolder: 'cypress/fixtures', }); ================================================ FILE: docker/Dockerfile.deploy ================================================ ############################################################################### # # DO NOT EDIT!!! # # This file is used to deploy the https://test.talawa.io site # ############################################################################### FROM node:24-slim AS build ARG PORT=4321 ARG PNPM_VERSION=10.4.1 ENV PORT=${PORT} WORKDIR /usr/src/app RUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate COPY package.json pnpm-lock.yaml ./ RUN pnpm install --frozen-lockfile COPY . . RUN pnpm run build ENV NODE_ENV=production EXPOSE ${PORT} CMD ["pnpm", "run", "serve"] ================================================ FILE: docker/Dockerfile.dev ================================================ FROM node:24-slim AS build ARG PORT=4321 ARG PNPM_VERSION=10.4.1 ENV PORT=${PORT} WORKDIR /usr/src/app RUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate COPY package.json pnpm-lock.yaml ./ RUN pnpm install --frozen-lockfile COPY . . RUN pnpm run build EXPOSE ${PORT} CMD ["pnpm", "run", "serve"] ================================================ FILE: docker/Dockerfile.prod ================================================ # Step 1: Build Stage FROM node:24-slim AS builder WORKDIR /talawa-admin ARG PNPM_VERSION=10.4.1 RUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate COPY package.json pnpm-lock.yaml ./ RUN pnpm install --frozen-lockfile COPY . . ENV NODE_ENV=production RUN pnpm run build # Step 2: Production FROM nginx:1.27.3-alpine AS production ENV NODE_ENV=production COPY config/docker/setup/nginx.conf /etc/nginx/conf.d/default.conf COPY --from=builder /talawa-admin/build /usr/share/nginx/html EXPOSE 80 CMD ["nginx", "-g", "daemon off;"] ================================================ FILE: docker/Dockerfile.rootless.dev ================================================ FROM node:24-slim SHELL ["/bin/bash", "-o", "pipefail", "-c"] ARG PORT=4321 ARG PNPM_VERSION=10.4.1 ARG WGET_VERSION=1.21.3-1+deb12u1 ARG CA_CERTIFICATES_VERSION=20230311+deb12u1 ENV PORT=${PORT} # Build args are populated from host UID/GID by compose. ARG USER_UID=1000 ARG USER_GID=1000 RUN set -eux; \ current_uid="$(id -u node)"; \ current_gid="$(id -g node)"; \ if [ "${USER_GID}" != "${current_gid}" ]; then \ if getent group "${USER_GID}" >/dev/null 2>&1; then \ target_group="$(getent group "${USER_GID}" | cut -d: -f1)"; \ usermod -g "${target_group}" node; \ else \ groupmod -g "${USER_GID}" node; \ fi; \ fi; \ if [ "${USER_UID}" != "${current_uid}" ]; then \ usermod -u "${USER_UID}" node; \ fi WORKDIR /usr/src/app RUN apt-get update \ && apt-get install -y --no-install-recommends \ wget=${WGET_VERSION} \ ca-certificates=${CA_CERTIFICATES_VERSION} \ && rm -rf /var/lib/apt/lists/* RUN chown -R node:node /usr/src/app /home/node RUN corepack enable USER node ENV HOME=/home/node ENV XDG_CACHE_HOME=/home/node/.cache ENV COREPACK_HOME=/home/node/.cache/corepack RUN corepack prepare pnpm@${PNPM_VERSION} --activate COPY --chown=node:node package.json pnpm-lock.yaml ./ RUN pnpm install --frozen-lockfile COPY --chown=node:node . . EXPOSE ${PORT} CMD ["pnpm", "run", "serve"] ================================================ FILE: docker/Dockerfile.rootless.prod ================================================ # Step 1: Build Stage FROM node:24-slim AS builder WORKDIR /talawa-admin ARG PNPM_VERSION=10.4.1 RUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate COPY package.json pnpm-lock.yaml ./ RUN pnpm install --frozen-lockfile COPY . . ENV NODE_ENV=production RUN pnpm run build # Step 2: Production FROM nginx:1.27.3-alpine AS production ENV NODE_ENV=production ENV NGINX_PORT=8080 COPY config/docker/setup/nginx.rootless.conf.template /etc/nginx/templates/default.conf.template COPY --from=builder /talawa-admin/build /usr/share/nginx/html RUN set -eux; \ apk add --no-cache gettext=~0.22; \ envsubst '${NGINX_PORT}' < /etc/nginx/templates/default.conf.template > /etc/nginx/conf.d/default.conf; \ rm -rf /etc/nginx/templates; \ mkdir -p /var/cache/nginx /var/run /var/log/nginx; \ touch /var/run/nginx.pid; \ chown -R nginx:nginx /var/cache/nginx /var/run /var/log/nginx /usr/share/nginx/html /etc/nginx/conf.d USER nginx EXPOSE 8080 HEALTHCHECK --interval=30s --timeout=5s --start-period=15s --retries=3 \ CMD wget -q -O /dev/null http://127.0.0.1:8080 || exit 1 CMD ["nginx", "-g", "daemon off;"] ================================================ FILE: docker/docker-compose.deploy.yaml ================================================ ############################################################################### # # DO NOT EDIT!!! # # This file is used to deploy the https://test.talawa.io site # ############################################################################### services: app: build: context: .. dockerfile: docker/Dockerfile.deploy args: PNPM_VERSION: '${PNPM_VERSION:-10.4.1}' ports: - '${PORT:-4321}:${PORT:-4321}' env_file: - ../.env healthcheck: test: ['CMD', 'curl', '-f', 'http://localhost:${PORT:-4321}'] interval: 30s timeout: 10s retries: 3 restart: unless-stopped ================================================ FILE: docker/docker-compose.dev.yaml ================================================ services: app: build: context: .. dockerfile: docker/Dockerfile.dev args: PNPM_VERSION: '${PNPM_VERSION:-10.4.1}' ports: - '${PORT:-4321}:${PORT:-4321}' env_file: - ../.env #environment: # - REACT_APP_TALAWA_URL=${REACT_APP_TALAWA_URL} # - PORT=${PORT} # - REACT_APP_USE_RECAPTCHA=${REACT_APP_USE_RECAPTCHA} # - REACT_APP_RECAPTCHA_SITE_KEY=${REACT_APP_RECAPTCHA_SITE_KEY} volumes: - ..:/usr/src/app - /usr/src/app/node_modules healthcheck: test: ['CMD', 'wget', '--spider', '-q', 'http://localhost:${PORT:-4321}'] interval: 30s timeout: 10s retries: 3 restart: unless-stopped ================================================ FILE: docker/docker-compose.prod.yaml ================================================ services: app: build: context: .. dockerfile: docker/Dockerfile.prod args: PNPM_VERSION: '${PNPM_VERSION:-10.4.1}' ports: - '${PORT:-4321}:80' env_file: - ../.env #environment: # - REACT_APP_TALAWA_URL=${REACT_APP_TALAWA_URL} # - PORT=${PORT} # - REACT_APP_USE_RECAPTCHA=${REACT_APP_USE_RECAPTCHA} # - REACT_APP_RECAPTCHA_SITE_KEY=${REACT_APP_RECAPTCHA_SITE_KEY} healthcheck: test: ['CMD', 'curl', '-f', 'http://localhost:80'] interval: 30s timeout: 10s retries: 3 restart: unless-stopped ================================================ FILE: docker/docker-compose.rootless.dev.yaml ================================================ # Rootless compose requires UID/GID exported for USER_UID/USER_GID mapping. # Local setup example: # export UID="$(id -u)" # export GID="$(id -g)" # CI already exports these values. services: app: build: context: .. dockerfile: docker/Dockerfile.rootless.dev args: PNPM_VERSION: '${PNPM_VERSION:-10.4.1}' USER_UID: '${UID:-1000}' USER_GID: '${GID:-1000}' ports: - '${PORT:-4321}:${PORT:-4321}' env_file: - ../.env user: '${UID:-1000}:${GID:-1000}' volumes: - ..:/usr/src/app - /usr/src/app/node_modules healthcheck: test: ['CMD', 'wget', '--spider', '-q', 'http://localhost:${PORT:-4321}'] interval: 30s timeout: 10s retries: 3 restart: unless-stopped ================================================ FILE: docker/docker-compose.rootless.prod.yaml ================================================ services: app: build: context: .. dockerfile: docker/Dockerfile.rootless.prod args: PNPM_VERSION: '${PNPM_VERSION:-10.4.1}' ports: - '${PORT:-4321}:8080' env_file: - ../.env healthcheck: test: ['CMD-SHELL', 'wget -q -O /dev/null http://localhost:8080 || exit 1'] interval: 30s timeout: 10s retries: 3 restart: unless-stopped ================================================ FILE: docs/.gitignore ================================================ # Dependencies /node_modules # Production /build # Generated files .docusaurus .cache-loader .package-lock.json package-lock.json yarn.lock # Misc .DS_Store .env.local .env.development.local .env.test.local .env.production.local npm-debug.log* yarn-debug.log* yarn-error.log* ================================================ FILE: docs/CNAME ================================================ docs-admin.talawa.io ================================================ FILE: docs/README.md ================================================ # Talawa Admin Documentation Website [![N|Solid](static/img/markdown/misc/logo.png)](https://github.com/PalisadoesFoundation/talawa-admin) ## Installation This 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. ## Table of Contents - [Talawa Admin Documentation Website](#talawa-admin-documentation-website) - [Installation](#installation) - [Table of Contents](#table-of-contents) - [Prerequisites for Developers](#prerequisites-for-developers) - [Install the Required PNPM Package Manager](#install-the-required-npm-package-manager) - [Install the Required Packages](#install-the-required-packages) - [Running the Development Server](#running-the-development-server) - [Building Static HTML Pages](#building-static-html-pages) ## Prerequisites for Developers The 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. We recommend that you follow these steps before beginning development work in this repository. ### Install the Required PNPM Package Manager For the package installation use `pnpm`. The steps are simple: 1. Validate the `pnpm` installation on your local device by running the following command. You should get the `pnpm` version. ```terminal $ pnpm -version ``` 1. 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). ### Install the Required Packages From the `talawa-admin/docs` directory, run the following command. ```console $ pnpm install ``` ## Running the Development Server To 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. The command to run the server is: ```console $ pnpm run start OR $ pnpm start ``` By default, a browser window will open at http://localhost:3000. This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. ## Building Static HTML Pages **In most cases is unnecessary**. Running the `development server` will be sufficient. If you need to generate static HTML pages (unlikely), then follow these steps. ```console $ pnpm run build ``` This command generates static content into the `/build` directory and can be served using any static contents hosting service. ================================================ FILE: docs/docs/auto-docs/App/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `ReactElement` Defined in: [src/App.tsx:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/App.tsx#L138) This is the main function for our application. It sets up all the routes and components, defining how the user can navigate through the app. The function uses React Router's `Routes` and `Route` components to map different URL paths to corresponding screens and components. ## Important Details - **UseEffect Hook**: This hook checks user authentication status using the `CHECK_AUTH` GraphQL query. - **Routes**: - The root route ("/") takes the user to the `LoginPage`. - Protected routes are wrapped with the `SecuredRoute` component to ensure they are only accessible to authenticated users. - Admin and Super Admin routes allow access to organization and user management screens. - User portal routes allow end-users to interact with organizations, settings, chat, events, etc. - Plugin routes are dynamically added based on loaded plugins and user permissions. ## Returns `ReactElement` The rendered routes and components of the application. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/FILE_NAME_TEMPLATE_BACKUP_ENV.md ================================================ [Admin Docs](/) *** # Function: FILE\_NAME\_TEMPLATE\_BACKUP\_ENV() > **FILE\_NAME\_TEMPLATE\_BACKUP\_ENV**(`timestamp`): `string` Defined in: [src/Constant/common.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L91) Generates the backup environment filename. ## Parameters ### timestamp `string` The timestamp. ## Returns `string` The formatted filename. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/ROUTE_USER.md ================================================ [Admin Docs](/) *** # Function: ROUTE\_USER() > **ROUTE\_USER**(`compId`): `string` Defined in: [src/Constant/common.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L62) Generates the route for a user component. ## Parameters ### compId `string` The component ID. ## Returns `string` The formatted route. ## Throws Error If compId is missing or empty. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/ROUTE_USER_ORG.md ================================================ [Admin Docs](/) *** # Function: ROUTE\_USER\_ORG() > **ROUTE\_USER\_ORG**(`compId`, `orgId`): `string` Defined in: [src/Constant/common.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L76) Generates the route for a user component within an organization. ## Parameters ### compId `string` The component ID. ### orgId `string` The organization ID. ## Returns `string` The formatted route. ## Throws Error If compId is missing or empty. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_DELETE_EVENT_MODAL.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_DELETE\_EVENT\_MODAL() > **TEST\_ID\_DELETE\_EVENT\_MODAL**(`id`): `string` Defined in: [src/Constant/common.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L40) Generates the data-testid for the delete event modal. ## Parameters ### id `string` The ID of the event. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_CARD.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_PEOPLE\_CARD() > **TEST\_ID\_PEOPLE\_CARD**(`id`): `string` Defined in: [src/Constant/common.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L26) Generates the data-testid for the people card. ## Parameters ### id `string` The ID of the person. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_EMAIL.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_PEOPLE\_EMAIL() > **TEST\_ID\_PEOPLE\_EMAIL**(`id`): `string` Defined in: [src/Constant/common.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L124) Generates the data-testid for the people email. ## Parameters ### id `string` The ID of the person. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_IMAGE.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_PEOPLE\_IMAGE() > **TEST\_ID\_PEOPLE\_IMAGE**(`id`): `string` Defined in: [src/Constant/common.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L109) Generates the data-testid for the people image. ## Parameters ### id `string` The ID of the person. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_NAME.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_PEOPLE\_NAME() > **TEST\_ID\_PEOPLE\_NAME**(`id`): `string` Defined in: [src/Constant/common.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L117) Generates the data-testid for the people name. ## Parameters ### id `string` The ID of the person. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_ROLE.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_PEOPLE\_ROLE() > **TEST\_ID\_PEOPLE\_ROLE**(`id`): `string` Defined in: [src/Constant/common.ts:132](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L132) Generates the data-testid for the people role. ## Parameters ### id `string` The ID of the person. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_SNO.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_PEOPLE\_SNO() > **TEST\_ID\_PEOPLE\_SNO**(`id`): `string` Defined in: [src/Constant/common.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L33) Generates the data-testid for the people sno badge. ## Parameters ### id `string` The ID of the person. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/functions/TEST_ID_UPDATE_EVENT_MODAL.md ================================================ [Admin Docs](/) *** # Function: TEST\_ID\_UPDATE\_EVENT\_MODAL() > **TEST\_ID\_UPDATE\_EVENT\_MODAL**(`id`): `string` Defined in: [src/Constant/common.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L48) Generates the data-testid for the update event modal. ## Parameters ### id `string` The ID of the event. ## Returns `string` The formatted data-testid. ================================================ FILE: docs/docs/auto-docs/Constant/common/variables/DATE_FORMAT.md ================================================ [Admin Docs](/) *** # Variable: DATE\_FORMAT > `const` **DATE\_FORMAT**: `"YYYY-MM-DDTHH:mm:ssZ"` = `'YYYY-MM-DDTHH:mm:ssZ'` Defined in: [src/Constant/common.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L9) Date format for ISO date time strings. ================================================ FILE: docs/docs/auto-docs/Constant/common/variables/DATE_FORMAT_ISO_DATE.md ================================================ [Admin Docs](/) *** # Variable: DATE\_FORMAT\_ISO\_DATE > `const` **DATE\_FORMAT\_ISO\_DATE**: `"YYYY-MM-DD"` = `'YYYY-MM-DD'` Defined in: [src/Constant/common.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L54) Date format for ISO date string (YYYY-MM-DD). ================================================ FILE: docs/docs/auto-docs/Constant/common/variables/DATE_TIME_SEPARATOR.md ================================================ [Admin Docs](/) *** # Variable: DATE\_TIME\_SEPARATOR > `const` **DATE\_TIME\_SEPARATOR**: `"T"` = `'T'` Defined in: [src/Constant/common.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L14) Separator for ISO date time strings. ================================================ FILE: docs/docs/auto-docs/Constant/common/variables/DUMMY_DATE_TIME_PREFIX.md ================================================ [Admin Docs](/) *** # Variable: DUMMY\_DATE\_TIME\_PREFIX > `const` **DUMMY\_DATE\_TIME\_PREFIX**: `"2015-03-04T"` = `'2015-03-04T'` Defined in: [src/Constant/common.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L19) Prefix for dummy date time for dayjs parsing. ================================================ FILE: docs/docs/auto-docs/Constant/common/variables/IDENTIFIER_ID.md ================================================ [Admin Docs](/) *** # Variable: IDENTIFIER\_ID > `const` **IDENTIFIER\_ID**: `"id"` = `'id'` Defined in: [src/Constant/common.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L102) Identifier constant for ID. ================================================ FILE: docs/docs/auto-docs/Constant/common/variables/IDENTIFIER_USER_ID.md ================================================ [Admin Docs](/) *** # Variable: IDENTIFIER\_USER\_ID > `const` **IDENTIFIER\_USER\_ID**: `"userId"` = `'userId'` Defined in: [src/Constant/common.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L97) Identifier constant for user ID. ================================================ FILE: docs/docs/auto-docs/Constant/common/variables/MAX_NAME_LENGTH.md ================================================ [Admin Docs](/) *** # Variable: MAX\_NAME\_LENGTH > `const` **MAX\_NAME\_LENGTH**: `20` = `20` Defined in: [src/Constant/common.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L137) Maximum length for the displayed user name before truncation. ================================================ FILE: docs/docs/auto-docs/Constant/constant/functions/deriveBackendWebsocketUrl.md ================================================ [Admin Docs](/) *** # Function: deriveBackendWebsocketUrl() > **deriveBackendWebsocketUrl**(`httpUrl`): `string` Defined in: [src/Constant/constant.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L5) ## Parameters ### httpUrl `string` ## Returns `string` ================================================ FILE: docs/docs/auto-docs/Constant/constant/variables/AUTH_TOKEN.md ================================================ [Admin Docs](/) *** # Variable: AUTH\_TOKEN > `const` **AUTH\_TOKEN**: `""` = `''` Defined in: [src/Constant/constant.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L1) ================================================ FILE: docs/docs/auto-docs/Constant/constant/variables/BACKEND_URL.md ================================================ [Admin Docs](/) *** # Variable: BACKEND\_URL > `const` **BACKEND\_URL**: `string` = `process.env.REACT_APP_TALAWA_URL` Defined in: [src/Constant/constant.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L2) ================================================ FILE: docs/docs/auto-docs/Constant/constant/variables/BACKEND_WEBSOCKET_URL.md ================================================ [Admin Docs](/) *** # Variable: BACKEND\_WEBSOCKET\_URL > `const` **BACKEND\_WEBSOCKET\_URL**: `string` Defined in: [src/Constant/constant.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L25) ================================================ FILE: docs/docs/auto-docs/Constant/constant/variables/REACT_APP_USE_RECAPTCHA.md ================================================ [Admin Docs](/) *** # Variable: REACT\_APP\_USE\_RECAPTCHA > `const` **REACT\_APP\_USE\_RECAPTCHA**: `string` = `process.env.REACT_APP_USE_RECAPTCHA` Defined in: [src/Constant/constant.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L4) ================================================ FILE: docs/docs/auto-docs/Constant/constant/variables/RECAPTCHA_SITE_KEY.md ================================================ [Admin Docs](/) *** # Variable: RECAPTCHA\_SITE\_KEY > `const` **RECAPTCHA\_SITE\_KEY**: `string` = `process.env.REACT_APP_RECAPTCHA_SITE_KEY` Defined in: [src/Constant/constant.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L3) ================================================ FILE: docs/docs/auto-docs/Constant/fileUpload/variables/AGENDA_ITEM_ALLOWED_MIME_TYPES.md ================================================ [Admin Docs](/) *** # Variable: AGENDA\_ITEM\_ALLOWED\_MIME\_TYPES > `const` **AGENDA\_ITEM\_ALLOWED\_MIME\_TYPES**: `string`[] Defined in: [src/Constant/fileUpload.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L30) List of MIME types allowed for agenda item attachments. Used for file input validation. ================================================ FILE: docs/docs/auto-docs/Constant/fileUpload/variables/AGENDA_ITEM_MIME_TYPE.md ================================================ [Admin Docs](/) *** # Variable: AGENDA\_ITEM\_MIME\_TYPE > `const` **AGENDA\_ITEM\_MIME\_TYPE**: `Record`\<`string`, `string`\> Defined in: [src/Constant/fileUpload.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L17) Maps browser MIME types to internal attachment type identifiers used by the agenda item attachment system. ================================================ FILE: docs/docs/auto-docs/Constant/fileUpload/variables/FILE_UPLOAD_ALLOWED_TYPES.md ================================================ [Admin Docs](/) *** # Variable: FILE\_UPLOAD\_ALLOWED\_TYPES > `const` **FILE\_UPLOAD\_ALLOWED\_TYPES**: `string`[] Defined in: [src/Constant/fileUpload.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L7) ================================================ FILE: docs/docs/auto-docs/Constant/fileUpload/variables/FILE_UPLOAD_MAX_SIZE_MB.md ================================================ [Admin Docs](/) *** # Variable: FILE\_UPLOAD\_MAX\_SIZE\_MB > `const` **FILE\_UPLOAD\_MAX\_SIZE\_MB**: `number` Defined in: [src/Constant/fileUpload.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L4) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/CREATE_ACTION_ITEM_CATEGORY_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_ACTION\_ITEM\_CATEGORY\_MUTATION > `const` **CREATE\_ACTION\_ITEM\_CATEGORY\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemCategoryMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L11) GraphQL mutation to create an action item category. ## Param MutationCreateActionItemCategoryInput containing: - name: String! - Name of the action item category - isDisabled: Boolean - Whether the category is disabled (optional, defaults to false) - organizationId: ID! - ID of the organization this category belongs to ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/DELETE_ACTION_ITEM_CATEGORY_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_ACTION\_ITEM\_CATEGORY\_MUTATION > `const` **DELETE\_ACTION\_ITEM\_CATEGORY\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemCategoryMutations.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L65) GraphQL mutation to delete an action item category. Updated to match new backend schema using input object ## Param MutationDeleteActionItemCategoryInput containing: - id: ID! - ID of the action item category to delete This mutation will permanently delete the category. Ensure the category is not associated with any action items before deletion. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/UPDATE_ACTION_ITEM_CATEGORY_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_ACTION\_ITEM\_CATEGORY\_MUTATION > `const` **UPDATE\_ACTION\_ITEM\_CATEGORY\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemCategoryMutations.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L41) GraphQL mutation to update an action item category. ## Param MutationUpdateActionItemCategoryInput containing: - id: ID! - ID of the action item category to update - name: String - New name of the action item category (optional) - isDisabled: Boolean - Whether the category should be disabled (optional) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/COMPLETE_ACTION_ITEM_FOR_INSTANCE.md ================================================ [Admin Docs](/) *** # Variable: COMPLETE\_ACTION\_ITEM\_FOR\_INSTANCE > `const` **COMPLETE\_ACTION\_ITEM\_FOR\_INSTANCE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L149) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/CREATE_ACTION_ITEM_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_ACTION\_ITEM\_MUTATION > `const` **CREATE\_ACTION\_ITEM\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L7) GraphQL mutation to create an action item. Updated to match new volunteer-based schema structure. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/DELETE_ACTION_ITEM_FOR_INSTANCE.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_ACTION\_ITEM\_FOR\_INSTANCE > `const` **DELETE\_ACTION\_ITEM\_FOR\_INSTANCE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L177) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/DELETE_ACTION_ITEM_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_ACTION\_ITEM\_MUTATION > `const` **DELETE\_ACTION\_ITEM\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L129) GraphQL mutation to delete an action item. Updated to match new schema structure. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/MARK_ACTION_ITEM_AS_PENDING_FOR_INSTANCE.md ================================================ [Admin Docs](/) *** # Variable: MARK\_ACTION\_ITEM\_AS\_PENDING\_FOR\_INSTANCE > `const` **MARK\_ACTION\_ITEM\_AS\_PENDING\_FOR\_INSTANCE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L158) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/MARK_ACTION_ITEM_AS_PENDING_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: MARK\_ACTION\_ITEM\_AS\_PENDING\_MUTATION > `const` **MARK\_ACTION\_ITEM\_AS\_PENDING\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L141) GraphQL mutation to mark action item as pending. New mutation for status updates. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/UPDATE_ACTION_ITEM_FOR_INSTANCE.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_ACTION\_ITEM\_FOR\_INSTANCE > `const` **UPDATE\_ACTION\_ITEM\_FOR\_INSTANCE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L167) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/UPDATE_ACTION_ITEM_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_ACTION\_ITEM\_MUTATION > `const` **UPDATE\_ACTION\_ITEM\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L68) GraphQL mutation to update an action item. Updated to match new volunteer-based schema structure. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AdvertisementMutations/variables/ADD_ADVERTISEMENT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: ADD\_ADVERTISEMENT\_MUTATION > `const` **ADD\_ADVERTISEMENT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AdvertisementMutations.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AdvertisementMutations.ts#L14) GraphQL mutation to create an advertisement. ## Param Global identifier of the associated organization. ## Param Name of the advertisement. ## Param Type of the advertisement. ## Param Date time at which the advertised event starts. ## Param Date time at which the advertised event ends. ## Param Custom information about the advertisement. ## Param Attachments of the advertisement (FileMetadataInput from MinIO presigned upload). ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AdvertisementMutations/variables/DELETE_ADVERTISEMENT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_ADVERTISEMENT\_MUTATION > `const` **DELETE\_ADVERTISEMENT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AdvertisementMutations.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AdvertisementMutations.ts#L80) GraphQL mutation to delete an advertisement. ## Param Global identifier of the advertisement. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AdvertisementMutations/variables/UPDATE_ADVERTISEMENT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_ADVERTISEMENT\_MUTATION > `const` **UPDATE\_ADVERTISEMENT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AdvertisementMutations.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AdvertisementMutations.ts#L50) GraphQL mutation to update an advertisement. ## Param Global identifier of the advertisement. ## Param Optional updated name of the advertisement ## Param Optional updated description of the advertisement ## Param Optional updated type of the advertisement ## Param Optional updated starting date of the advertisement ## Param Optional updated ending date of the advertisement ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AgendaFolderMutations/variables/CREATE_AGENDA_FOLDER_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_AGENDA\_FOLDER\_MUTATION > `const` **CREATE\_AGENDA\_FOLDER\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AgendaFolderMutations.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaFolderMutations.ts#L9) GraphQL mutation to create a new agenda folder. ## Param MutationCreateAgendaFolderInput containing folder details ## Returns The created agenda folder with id, name, description, sequence, event, and creator ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AgendaFolderMutations/variables/DELETE_AGENDA_FOLDER_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_AGENDA\_FOLDER\_MUTATION > `const` **DELETE\_AGENDA\_FOLDER\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AgendaFolderMutations.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaFolderMutations.ts#L50) GraphQL mutation to delete an agenda folder. ## Param MutationDeleteAgendaFolderInput containing the folder id to delete ## Returns The deleted folder's id ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AgendaFolderMutations/variables/UPDATE_AGENDA_FOLDER_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_AGENDA\_FOLDER\_MUTATION > `const` **UPDATE\_AGENDA\_FOLDER\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AgendaFolderMutations.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaFolderMutations.ts#L34) GraphQL mutation to update an existing agenda folder. ## Param MutationUpdateAgendaFolderInput containing folder id and fields to update ## Returns The updated agenda folder with id, name, and description ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/CREATE_AGENDA_ITEM_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_AGENDA\_ITEM\_MUTATION > `const` **CREATE\_AGENDA\_ITEM\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L9) GraphQL mutation to create a new agenda item. ## Param The agenda item creation input containing title, description, duration, etc. ## Returns The created agenda item with its details. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/DELETE_AGENDA_ITEM_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_AGENDA\_ITEM\_MUTATION > `const` **DELETE\_AGENDA\_ITEM\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L44) GraphQL mutation to delete an agenda item. ## Param The deletion input containing the agenda item ID. ## Returns The ID of the deleted agenda item. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/UPDATE_AGENDA_ITEM_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_AGENDA\_ITEM\_MUTATION > `const` **UPDATE\_AGENDA\_ITEM\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L75) GraphQL mutation to update an agenda item's details. ## Param The update input containing item ID and fields to update. ## Returns The updated agenda item with its details. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/UPDATE_AGENDA_ITEM_SEQUENCE_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_AGENDA\_ITEM\_SEQUENCE\_MUTATION > `const` **UPDATE\_AGENDA\_ITEM\_SEQUENCE\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L58) GraphQL mutation to update the sequence/order of an agenda item. ## Param The sequence update input containing item ID and new sequence. ## Returns The updated agenda item with its new sequence. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/CREATE_CAMPAIGN_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_CAMPAIGN\_MUTATION > `const` **CREATE\_CAMPAIGN\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/CampaignMutation.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CampaignMutation.ts#L15) GraphQL mutation to create a new fund Campaign. ## Param The name of the fund. ## Param The fund ID the campaign is associated with. ## Param The funding goal of the campaign. ## Param The start date of the campaign. ## Param The end date of the campaign. ## Param The currency of the campaign. ## Returns The ID of the created campaign. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/UPDATE_CAMPAIGN_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_CAMPAIGN\_MUTATION > `const` **UPDATE\_CAMPAIGN\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/CampaignMutation.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CampaignMutation.ts#L51) GraphQL mutation to update a fund Campaign. ## Param The ID of the campaign being updated. ## Param The name of the campaign. ## Param The funding goal of the campaign. ## Param The start date of the campaign. ## Param The end date of the campaign. ## Param The currency of the campaign. ## Returns The ID of the updated campaign. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/CREATE_COMMENT_POST.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_COMMENT\_POST > `const` **CREATE\_COMMENT\_POST**: `DocumentNode` Defined in: [src/GraphQl/Mutations/CommentMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L11) GraphQL mutation to create a new comment on a post. ## Param The text content of the comment. ## Param The ID of the post to which the comment is being added. ## Returns The created comment object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/DELETE_COMMENT.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_COMMENT > `const` **DELETE\_COMMENT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/CommentMutations.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L61) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/LIKE_COMMENT.md ================================================ [Admin Docs](/) *** # Variable: LIKE\_COMMENT > `const` **LIKE\_COMMENT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/CommentMutations.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L39) GraphQL mutation to like a comment. ## Param The ID of the comment to be liked. ## Returns The liked comment object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/UNLIKE_COMMENT.md ================================================ [Admin Docs](/) *** # Variable: UNLIKE\_COMMENT > `const` **UNLIKE\_COMMENT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/CommentMutations.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L54) GraphQL mutation to unlike a comment. ## Param The ID of the comment to be unliked. ## Returns The unliked comment object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/UPDATE_COMMENT.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_COMMENT > `const` **UPDATE\_COMMENT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/CommentMutations.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L69) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/ADD_EVENT_ATTENDEE.md ================================================ [Admin Docs](/) *** # Variable: ADD\_EVENT\_ATTENDEE > `const` **ADD\_EVENT\_ATTENDEE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventAttendeeMutations.ts#L11) GraphQL mutation to add an attendee to an event. ## Param The ID of the user being added as an attendee. ## Param The ID of the event to which the user is being added as an attendee. ## Returns The updated event object with the added attendee. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/MARK_CHECKIN.md ================================================ [Admin Docs](/) *** # Variable: MARK\_CHECKIN > `const` **MARK\_CHECKIN**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventAttendeeMutations.ts#L108) GraphQL mutation to mark a user's check-in at an event. ## Param The ID of the user checking in. ## Param The ID of the event at which the user is checking in. ## Returns The updated event object with the user's check-in information. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/REMOVE_EVENT_ATTENDEE.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_EVENT\_ATTENDEE > `const` **REMOVE\_EVENT\_ATTENDEE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventAttendeeMutations.ts#L39) GraphQL mutation to remove an attendee from an event. ## Param The ID of the user being removed as an attendee. ## Param The ID of the event from which the user is being removed as an attendee. ## Returns The updated event object without the removed attendee. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/CREATE_EVENT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_EVENT\_MUTATION > `const` **CREATE\_EVENT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L5) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_ENTIRE_RECURRING_EVENT_SERIES_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_ENTIRE\_RECURRING\_EVENT\_SERIES\_MUTATION > `const` **DELETE\_ENTIRE\_RECURRING\_EVENT\_SERIES\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L83) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_SINGLE_EVENT_INSTANCE_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_SINGLE\_EVENT\_INSTANCE\_MUTATION > `const` **DELETE\_SINGLE\_EVENT\_INSTANCE\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L94) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_STANDALONE_EVENT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_STANDALONE\_EVENT\_MUTATION > `const` **DELETE\_STANDALONE\_EVENT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L75) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_THIS_AND_FOLLOWING_EVENTS_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_THIS\_AND\_FOLLOWING\_EVENTS\_MUTATION > `const` **DELETE\_THIS\_AND\_FOLLOWING\_EVENTS\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L105) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/REGISTER_EVENT.md ================================================ [Admin Docs](/) *** # Variable: REGISTER\_EVENT > `const` **REGISTER\_EVENT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L172) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_ENTIRE_RECURRING_EVENT_SERIES_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_ENTIRE\_RECURRING\_EVENT\_SERIES\_MUTATION > `const` **UPDATE\_ENTIRE\_RECURRING\_EVENT\_SERIES\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L160) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_EVENT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_EVENT\_MUTATION > `const` **UPDATE\_EVENT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L50) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_SINGLE_RECURRING_EVENT_INSTANCE_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_SINGLE\_RECURRING\_EVENT\_INSTANCE\_MUTATION > `const` **UPDATE\_SINGLE\_RECURRING\_EVENT\_INSTANCE\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L116) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_THIS_AND_FOLLOWING_EVENTS_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_THIS\_AND\_FOLLOWING\_EVENTS\_MUTATION > `const` **UPDATE\_THIS\_AND\_FOLLOWING\_EVENTS\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventMutations.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L138) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/ADD_VOLUNTEER.md ================================================ [Admin Docs](/) *** # Variable: ADD\_VOLUNTEER > `const` **ADD\_VOLUNTEER**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L11) GraphQL mutation to create an event volunteer. ## Param The data required to create an event volunteer. ## Returns The created event volunteer with full details. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_GROUP.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_VOLUNTEER\_GROUP > `const` **CREATE\_VOLUNTEER\_GROUP**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L69) GraphQL mutation to create an event volunteer group. ## Param The data required to create an event volunteer group. - data contains following fileds: - eventId: string - leaderId: string - name: string - description?: string - volunteers: [string] - volunteersRequired?: number ## Returns The ID of the created event volunteer group. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_VOLUNTEER > `const` **DELETE\_VOLUNTEER**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L39) GraphQL mutation to delete an event volunteer. ## Param The ID of the event volunteer being deleted. ## Returns The deleted event volunteer. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_FOR_INSTANCE.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_VOLUNTEER\_FOR\_INSTANCE > `const` **DELETE\_VOLUNTEER\_FOR\_INSTANCE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L117) GraphQL mutation to delete a volunteer from a specific recurring event instance. ## Param The input containing volunteerId and recurringEventInstanceId. ## Returns The deleted volunteer information. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_GROUP.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_VOLUNTEER\_GROUP > `const` **DELETE\_VOLUNTEER\_GROUP**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L103) GraphQL mutation to delete an event volunteer group. ## Param The ID of the event volunteer group being deleted. ## Returns The ID of the deleted event volunteer group. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_GROUP_FOR_INSTANCE.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_VOLUNTEER\_GROUP\_FOR\_INSTANCE > `const` **DELETE\_VOLUNTEER\_GROUP\_FOR\_INSTANCE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L141) GraphQL mutation to delete a volunteer group from a specific recurring event instance. ## Param The input containing volunteerGroupId and recurringEventInstanceId. ## Returns The deleted volunteer group information. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_GROUP.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_VOLUNTEER\_GROUP > `const` **UPDATE\_VOLUNTEER\_GROUP**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L85) GraphQL mutation to update an event volunteer group. ## Param The ID of the event volunteer group being updated. ## Param The data required to update an event volunteer group. ## Returns The ID of the updated event volunteer group. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_MEMBERSHIP.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_VOLUNTEER\_MEMBERSHIP > `const` **UPDATE\_VOLUNTEER\_MEMBERSHIP**: `DocumentNode` Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L172) GraphQL mutation to update an event volunteer group. ## Param The ID of the event volunteer group being updated. ## Param The data required to update an event volunteer group. ## Returns The ID of the updated event volunteer group. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/CREATE_FUND_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_FUND\_MUTATION > `const` **CREATE\_FUND\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/FundMutation.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/FundMutation.ts#L11) GraphQL mutation to create a new fund. ## Param The name of the fund. ## Param The organization ID the fund is associated with. ## Param Whether the fund is tax deductible. ## Returns The ID of the created fund. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/UPDATE_FUND_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_FUND\_MUTATION > `const` **UPDATE\_FUND\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/FundMutation.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/FundMutation.ts#L37) GraphQL mutation to update a fund. ## Param The ID of the fund being updated. ## Param The name of the fund. ## Param Whether the fund is tax deductible. ## Returns The ID of the updated fund. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CANCEL_MEMBERSHIP_REQUEST.md ================================================ [Admin Docs](/) *** # Variable: CANCEL\_MEMBERSHIP\_REQUEST > `const` **CANCEL\_MEMBERSHIP\_REQUEST**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:266](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L266) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_CHAT.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_CHAT > `const` **CREATE\_CHAT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L69) GraphQL mutation to create a chat between users in an organization. ## Param An array of user IDs participating in the direct chat. ## Param The ID of the organization where the direct chat is created. ## Returns The created direct chat object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_CHAT_MEMBERSHIP.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_CHAT\_MEMBERSHIP > `const` **CREATE\_CHAT\_MEMBERSHIP**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L83) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_SAMPLE_ORGANIZATION_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_SAMPLE\_ORGANIZATION\_MUTATION > `const` **CREATE\_SAMPLE\_ORGANIZATION\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L43) GraphQL mutation to create a sample organization. ## Returns The created sample organization object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/DELETE_CHAT.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_CHAT > `const` **DELETE\_CHAT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:284](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L284) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/DELETE_CHAT_MEMBERSHIP.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_CHAT\_MEMBERSHIP > `const` **DELETE\_CHAT\_MEMBERSHIP**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L315) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/DELETE_CHAT_MESSAGE.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_CHAT\_MESSAGE > `const` **DELETE\_CHAT\_MESSAGE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L28) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/EDIT_CHAT_MESSAGE.md ================================================ [Admin Docs](/) *** # Variable: EDIT\_CHAT\_MESSAGE > `const` **EDIT\_CHAT\_MESSAGE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L123) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/JOIN_PUBLIC_ORGANIZATION.md ================================================ [Admin Docs](/) *** # Variable: JOIN\_PUBLIC\_ORGANIZATION > `const` **JOIN\_PUBLIC\_ORGANIZATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:256](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L256) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MARK_CHAT_MESSAGES_AS_READ.md ================================================ [Admin Docs](/) *** # Variable: MARK\_CHAT\_MESSAGES\_AS\_READ > `const` **MARK\_CHAT\_MESSAGES\_AS\_READ**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L204) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MESSAGE_SENT_TO_CHAT.md ================================================ [Admin Docs](/) *** # Variable: MESSAGE\_SENT\_TO\_CHAT > `const` **MESSAGE\_SENT\_TO\_CHAT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L175) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_SAMPLE_ORGANIZATION_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_SAMPLE\_ORGANIZATION\_MUTATION > `const` **REMOVE\_SAMPLE\_ORGANIZATION\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L55) GraphQL mutation to remove a sample organization. ## Returns The removed sample organization object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MEMBERSHIP_REQUEST.md ================================================ [Admin Docs](/) *** # Variable: SEND\_MEMBERSHIP\_REQUEST > `const` **SEND\_MEMBERSHIP\_REQUEST**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:241](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L241) GraphQL mutation to remove a custom field from an organization. ## Param The ID of the organization from which the custom field is being removed. ## Param The ID of the custom field to be removed. ## Returns The removed organization custom field object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MESSAGE_TO_CHAT.md ================================================ [Admin Docs](/) *** # Variable: SEND\_MESSAGE\_TO\_CHAT > `const` **SEND\_MESSAGE\_TO\_CHAT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L149) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/TOGGLE_PINNED_POST.md ================================================ [Admin Docs](/) *** # Variable: TOGGLE\_PINNED\_POST > `const` **TOGGLE\_PINNED\_POST**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L217) GraphQL mutation to toggle the pinned status of a post. ## Param The ID of the post to be toggled. ## Returns The updated post object with the new pinned status. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_CHAT.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_CHAT > `const` **UPDATE\_CHAT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:110](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L110) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_CHAT_MEMBERSHIP.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_CHAT\_MEMBERSHIP > `const` **UPDATE\_CHAT\_MEMBERSHIP**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:274](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L274) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_USER_ROLE_IN_ORG_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_USER\_ROLE\_IN\_ORG\_MUTATION > `const` **UPDATE\_USER\_ROLE\_IN\_ORG\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L12) GraphQL mutation to update the role of a user in an organization. ## Param The ID of the organization in which the user's role is being updated. ## Param The ID of the user whose role is being updated. ## Param The new role to be assigned to the user in the organization. ## Returns The updated user object with the new role in the organization. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/CREATE_PLEDGE.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_PLEDGE > `const` **CREATE\_PLEDGE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PledgeMutation.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PledgeMutation.ts#L12) GraphQL mutation to create a pledge. ## Param The ID of the campaign the pledge is associated with. ## Param The amount of the pledge. ## Param The ID of the pledger associated with the pledge. ## Param A note associated with the pledge. ## Returns The details of the created pledge. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/DELETE_PLEDGE.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_PLEDGE > `const` **DELETE\_PLEDGE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PledgeMutation.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PledgeMutation.ts#L77) GraphQL mutation to delete a pledge. ## Param The ID of the pledge being deleted. ## Returns Whether the pledge was successfully deleted. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/UPDATE_PLEDGE.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_PLEDGE > `const` **UPDATE\_PLEDGE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PledgeMutation.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PledgeMutation.ts#L51) GraphQL mutation to update a pledge. ## Param The ID of the pledge being updated. ## Param The amount of the pledge. ## Returns The details of the updated pledge. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/CREATE_PLUGIN_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_PLUGIN\_MUTATION > `const` **CREATE\_PLUGIN\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PluginMutations.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L9) GraphQL mutation to create a new plugin. ## Param The ID of the plugin to create. ## Returns The created plugin object with id, pluginId, isActivated, isInstalled, and backup status. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/DELETE_PLUGIN_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_PLUGIN\_MUTATION > `const` **DELETE\_PLUGIN\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PluginMutations.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L72) GraphQL mutation to delete a plugin. ## Param The ID of the plugin to delete. ## Returns The deleted plugin object with id and pluginId. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/INSTALL_PLUGIN_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: INSTALL\_PLUGIN\_MUTATION > `const` **INSTALL\_PLUGIN\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PluginMutations.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L29) GraphQL mutation to install a plugin. ## Param The ID of the plugin to install. ## Returns The installed plugin object with id, pluginId, isActivated, isInstalled, and backup status. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/UPDATE_PLUGIN_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_PLUGIN\_MUTATION > `const` **UPDATE\_PLUGIN\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PluginMutations.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L52) GraphQL mutation to update a plugin. ## Param The ID of the plugin to update. ## Param Whether the plugin is activated. ## Param Whether the plugin is installed. ## Param Whether the plugin is backed up. ## Returns The updated plugin object. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/UPLOAD_PLUGIN_ZIP_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPLOAD\_PLUGIN\_ZIP\_MUTATION > `const` **UPLOAD\_PLUGIN\_ZIP\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/PluginMutations.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L81) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ADD_PEOPLE_TO_TAG.md ================================================ [Admin Docs](/) *** # Variable: ADD\_PEOPLE\_TO\_TAG > `const` **ADD\_PEOPLE\_TO\_TAG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/TagMutations.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L76) GraphQL mutation to add people to tag. ## Param Id of the tag to be assigned. ## Param Ids of the users to assign to. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ASSIGN_TO_TAGS.md ================================================ [Admin Docs](/) *** # Variable: ASSIGN\_TO\_TAGS > `const` **ASSIGN\_TO\_TAGS**: `DocumentNode` Defined in: [src/GraphQl/Mutations/TagMutations.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L91) GraphQL mutation to assign people to multiple tags. ## Param Id of the current tag. ## Param Ids of the selected tags to be assined. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/CREATE_USER_TAG.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_USER\_TAG > `const` **CREATE\_USER\_TAG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/TagMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L11) GraphQL mutation to create a user tag. ## Param Name of the tag. ## Param Id of the folder/parent tag to organize tags. ## Param Organization to which the tag belongs. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_FROM_TAGS.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_FROM\_TAGS > `const` **REMOVE\_FROM\_TAGS**: `DocumentNode` Defined in: [src/GraphQl/Mutations/TagMutations.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L108) GraphQL mutation to remove people from multiple tags. ## Param Id of the current tag. ## Param Ids of the selected tags to be removed from. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_USER_TAG.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_USER\_TAG > `const` **REMOVE\_USER\_TAG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/TagMutations.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L61) GraphQL mutation to remove a user tag. ## Param Id of the tag to be removed . ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UNASSIGN_USER_TAG.md ================================================ [Admin Docs](/) *** # Variable: UNASSIGN\_USER\_TAG > `const` **UNASSIGN\_USER\_TAG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/TagMutations.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L32) GraphQL mutation to unsssign a user tag from a user. ## Param Id the tag. ## Param Id of the user to be unassigned. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UPDATE_USER_TAG.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_USER\_TAG > `const` **UPDATE\_USER\_TAG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/TagMutations.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L47) GraphQL mutation to update a user tag. ## Param Id the tag. ## Param Updated name of the tag. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/CREATE_VENUE_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_VENUE\_MUTATION > `const` **CREATE\_VENUE\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/VenueMutations.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/VenueMutations.ts#L13) GraphQL mutation to create a venue. ## Param Name of the venue. ## Param Ineteger representing capacity of venue. ## Param Description of the venue. ## Param Image file for the venue. ## Param Organization to which the ActionItemCategory belongs. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/DELETE_VENUE_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_VENUE\_MUTATION > `const` **DELETE\_VENUE\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/VenueMutations.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/VenueMutations.ts#L74) GraphQL mutation to delete a venue. ## Param The id of the Venue to be deleted. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/UPDATE_VENUE_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_VENUE\_MUTATION > `const` **UPDATE\_VENUE\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/VenueMutations.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/VenueMutations.ts#L44) GraphQL mutation to update a venue. ## Param The id of the Venue to be updated. ## Param Description of the venue. ## Param Name of the venue. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ACCEPT_EVENT_INVITATION.md ================================================ [Admin Docs](/) *** # Variable: ACCEPT\_EVENT\_INVITATION > `const` **ACCEPT\_EVENT\_INVITATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:196](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L196) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ACCEPT_ORGANIZATION_REQUEST_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: ACCEPT\_ORGANIZATION\_REQUEST\_MUTATION > `const` **ACCEPT\_ORGANIZATION\_REQUEST\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L32) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/BLOCK_USER_MUTATION_PG.md ================================================ [Admin Docs](/) *** # Variable: BLOCK\_USER\_MUTATION\_PG > `const` **BLOCK\_USER\_MUTATION\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L5) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_MEMBER_PG.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_MEMBER\_PG > `const` **CREATE\_MEMBER\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L218) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MEMBERSHIP_MUTATION_PG.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_ORGANIZATION\_MEMBERSHIP\_MUTATION\_PG > `const` **CREATE\_ORGANIZATION\_MEMBERSHIP\_MUTATION\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:374](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L374) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_ORGANIZATION\_MUTATION > `const` **CREATE\_ORGANIZATION\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L318) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MUTATION_PG.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_ORGANIZATION\_MUTATION\_PG > `const` **CREATE\_ORGANIZATION\_MUTATION\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:342](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L342) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_POST_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: CREATE\_POST\_MUTATION > `const` **CREATE\_POST\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:425](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L425) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ORGANIZATION_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_ORGANIZATION\_MUTATION > `const` **DELETE\_ORGANIZATION\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:394](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L394) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_POST_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: DELETE\_POST\_MUTATION > `const` **DELETE\_POST\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:437](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L437) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DONATE_TO_ORGANIZATION.md ================================================ [Admin Docs](/) *** # Variable: DONATE\_TO\_ORGANIZATION > `const` **DONATE\_TO\_ORGANIZATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:602](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L602) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/FORGOT_PASSWORD_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: FORGOT\_PASSWORD\_MUTATION > `const` **FORGOT\_PASSWORD\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:453](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L453) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/GENERATE_OTP_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: GENERATE\_OTP\_MUTATION > `const` **GENERATE\_OTP\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:445](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L445) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/GET_FILE_PRESIGNEDURL.md ================================================ [Admin Docs](/) *** # Variable: GET\_FILE\_PRESIGNEDURL > `const` **GET\_FILE\_PRESIGNEDURL**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:708](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L708) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LINK_OAUTH_ACCOUNT.md ================================================ [Admin Docs](/) *** # Variable: LINK\_OAUTH\_ACCOUNT > `const` **LINK\_OAUTH\_ACCOUNT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:717](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L717) Links an OAuth provider account to the currently authenticated user. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LOGOUT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: LOGOUT\_MUTATION > `const` **LOGOUT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:298](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L298) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/PRESIGNED_URL.md ================================================ [Admin Docs](/) *** # Variable: PRESIGNED\_URL > `const` **PRESIGNED\_URL**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:698](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L698) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REFRESH_TOKEN_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: REFRESH\_TOKEN\_MUTATION > `const` **REFRESH\_TOKEN\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:286](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L286) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REJECT_ORGANIZATION_REQUEST_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: REJECT\_ORGANIZATION\_REQUEST\_MUTATION > `const` **REJECT\_ORGANIZATION\_REQUEST\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L19) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_MEMBER_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_MEMBER\_MUTATION > `const` **REMOVE\_MEMBER\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:404](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L404) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_MEMBER_MUTATION_PG.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_MEMBER\_MUTATION\_PG > `const` **REMOVE\_MEMBER\_MUTATION\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:415](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L415) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RESEND_VERIFICATION_EMAIL_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: RESEND\_VERIFICATION\_EMAIL\_MUTATION > `const` **RESEND\_VERIFICATION\_EMAIL\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L272) Resends the email verification link to the currently authenticated user. ## Remarks The user must be logged in for this mutation to work. No parameters are required as it uses the authenticated user's session. ## Returns An object containing: - success: boolean indicating if the email was sent successfully - message: A descriptive message about the result ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RESET_COMMUNITY.md ================================================ [Admin Docs](/) *** # Variable: RESET\_COMMUNITY > `const` **RESET\_COMMUNITY**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:596](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L596) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REVOKE_REFRESH_TOKEN.md ================================================ [Admin Docs](/) *** # Variable: REVOKE\_REFRESH\_TOKEN > `const` **REVOKE\_REFRESH\_TOKEN**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:310](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L310) to revoke a refresh token (legacy - use LOGOUT_MUTATION for cookie-based auth) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SEND_EVENT_INVITATIONS.md ================================================ [Admin Docs](/) *** # Variable: SEND\_EVENT\_INVITATIONS > `const` **SEND\_EVENT\_INVITATIONS**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L158) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SIGNUP_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: SIGNUP\_MUTATION > `const` **SIGNUP\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L131) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SIGN_IN_WITH_OAUTH.md ================================================ [Admin Docs](/) *** # Variable: SIGN\_IN\_WITH\_OAUTH > `const` **SIGN\_IN\_WITH\_OAUTH**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:752](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L752) Authenticates a user using an OAuth provider and returns authentication tokens. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNBLOCK_USER_MUTATION_PG.md ================================================ [Admin Docs](/) *** # Variable: UNBLOCK\_USER\_MUTATION\_PG > `const` **UNBLOCK\_USER\_MUTATION\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L11) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNLINK_OAUTH_ACCOUNT.md ================================================ [Admin Docs](/) *** # Variable: UNLINK\_OAUTH\_ACCOUNT > `const` **UNLINK\_OAUTH\_ACCOUNT**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:736](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L736) Unlinks an OAuth provider account from the currently authenticated user. ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_COMMUNITY_PG.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_COMMUNITY\_PG > `const` **UPDATE\_COMMUNITY\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:548](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L548) GraphQL mutation to update community profile settings including logo upload. ## Param Optional logo file (Upload scalar) - sent as multipart request via apollo-upload-client ## Param Community name ## Param Community website URL ## Param Facebook profile URL ## Param Instagram profile URL ## Param X (Twitter) profile URL ## Param GitHub organization URL ## Param YouTube channel URL ## Param LinkedIn profile URL ## Param Reddit community URL ## Param Slack workspace URL ## Param Session timeout in minutes ## Returns Updated community with id, logoURL (computed MinIO URL) and logoMimeType ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_CURRENT_USER_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_CURRENT\_USER\_MUTATION > `const` **UPDATE\_CURRENT\_USER\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L66) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_EVENT_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_EVENT\_MUTATION > `const` **UPDATE\_EVENT\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L485) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORGANIZATION_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_ORGANIZATION\_MUTATION > `const` **UPDATE\_ORGANIZATION\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L45) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_POST_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_POST\_MUTATION > `const` **UPDATE\_POST\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:469](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L469) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_POST_VOTE.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_POST\_VOTE > `const` **UPDATE\_POST\_VOTE**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:515](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L515) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_SESSION_TIMEOUT_PG.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_SESSION\_TIMEOUT\_PG > `const` **UPDATE\_SESSION\_TIMEOUT\_PG**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:586](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L586) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: UPDATE\_USER\_MUTATION > `const` **UPDATE\_USER\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L98) ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/VERIFY_EMAIL_MUTATION.md ================================================ [Admin Docs](/) *** # Variable: VERIFY\_EMAIL\_MUTATION > `const` **VERIFY\_EMAIL\_MUTATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L252) Verifies a user's email address using a token sent via email. ## Param The verification token received via email ## Returns An object containing: - success: boolean indicating if the verification succeeded - message: A descriptive message about the result ================================================ FILE: docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/VERIFY_EVENT_INVITATION.md ================================================ [Admin Docs](/) *** # Variable: VERIFY\_EVENT\_INVITATION > `const` **VERIFY\_EVENT\_INVITATION**: `DocumentNode` Defined in: [src/GraphQl/Mutations/mutations.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L180) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/ActionItemCategoryQueries/variables/ACTION_ITEM_CATEGORY_LIST.md ================================================ [Admin Docs](/) *** # Variable: ACTION\_ITEM\_CATEGORY\_LIST > `const` **ACTION\_ITEM\_CATEGORY\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/ActionItemCategoryQueries.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemCategoryQueries.ts#L7) GraphQL query to retrieve action item categories by organization. * ## Returns The list of action item categories associated with the organization. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/ActionItemCategoryQueries/variables/GET_ACTION_ITEM_CATEGORY.md ================================================ [Admin Docs](/) *** # Variable: GET\_ACTION\_ITEM\_CATEGORY > `const` **GET\_ACTION\_ITEM\_CATEGORY**: `DocumentNode` Defined in: [src/GraphQl/Queries/ActionItemCategoryQueries.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemCategoryQueries.ts#L29) Query to fetch a single action item category Using direct id parameter ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEM_LIST.md ================================================ [Admin Docs](/) *** # Variable: ACTION\_ITEM\_LIST > `const` **ACTION\_ITEM\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/ActionItemQueries.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemQueries.ts#L14) GraphQL query to retrieve action item categories by organization. ## Param The ID of the organization for which action item categories are being retrieved. ## Param Sort action items Latest/Earliest first. ## Param Filter action items belonging to an action item category. ## Param Filter action items belonging to an event. ## Param Filter all the completed action items. ## Returns The list of action item categories associated with the organization. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/GET_EVENT_ACTION_ITEMS.md ================================================ [Admin Docs](/) *** # Variable: GET\_EVENT\_ACTION\_ITEMS > `const` **GET\_EVENT\_ACTION\_ITEMS**: `DocumentNode` Defined in: [src/GraphQl/Queries/ActionItemQueries.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemQueries.ts#L85) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/AdvertisementQueries/variables/ORGANIZATION_ADVERTISEMENT_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_ADVERTISEMENT\_LIST > `const` **ORGANIZATION\_ADVERTISEMENT\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/AdvertisementQueries.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/AdvertisementQueries.ts#L15) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/AgendaCategoryQueries/variables/AGENDA_ITEM_CATEGORY_LIST.md ================================================ [Admin Docs](/) *** # Variable: AGENDA\_ITEM\_CATEGORY\_LIST > `const` **AGENDA\_ITEM\_CATEGORY\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/AgendaCategoryQueries.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/AgendaCategoryQueries.ts#L10) GraphQL query to retrieve agenda category by id. ## Param The ID of the category which is being retrieved. ## Returns Agenda category associated with the id. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/AgendaFolderQueries/variables/AGENDA_FOLDER_LIST.md ================================================ [Admin Docs](/) *** # Variable: AGENDA\_FOLDER\_LIST > `const` **AGENDA\_FOLDER\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/AgendaFolderQueries.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/AgendaFolderQueries.ts#L10) GraphQL query to retrieve agenda folders by event ID. ## Param The ID of the event for which folders are retrieved. ## Returns List of agenda folders with their items for the specified event. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/CommentQueries/variables/GET_POST_COMMENTS.md ================================================ [Admin Docs](/) *** # Variable: GET\_POST\_COMMENTS > `const` **GET\_POST\_COMMENTS**: `DocumentNode` Defined in: [src/GraphQl/Queries/CommentQueries.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/CommentQueries.ts#L14) GraphQL query to retrieve post comments with cursor-based pagination. ## Param The ID of the post to fetch comments for. ## Param Cursor to fetch comments after this point (for load more). ## Param Cursor to fetch comments before this point. ## Param Number of comments to fetch (forward pagination). ## Param Number of comments to fetch (backward pagination). ## Returns Post with paginated comments using cursor-based pagination. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_GROUP_LIST.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_VOLUNTEER\_GROUP\_LIST > `const` **EVENT\_VOLUNTEER\_GROUP\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L65) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/GET_EVENT_VOLUNTEERS.md ================================================ [Admin Docs](/) *** # Variable: GET\_EVENT\_VOLUNTEERS > `const` **GET\_EVENT\_VOLUNTEERS**: `DocumentNode` Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L12) GraphQL query to retrieve event volunteers. ## Param The filter to apply to the query. ## Param The order in which to return the results. ## Returns The list of event volunteers. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/GET_EVENT_VOLUNTEER_GROUPS.md ================================================ [Admin Docs](/) *** # Variable: GET\_EVENT\_VOLUNTEER\_GROUPS > `const` **GET\_EVENT\_VOLUNTEER\_GROUPS**: `DocumentNode` Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L102) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/USER_EVENTS_VOLUNTEER.md ================================================ [Admin Docs](/) *** # Variable: USER\_EVENTS\_VOLUNTEER > `const` **USER\_EVENTS\_VOLUNTEER**: `DocumentNode` Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:193](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L193) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/USER_VOLUNTEER_MEMBERSHIP.md ================================================ [Admin Docs](/) *** # Variable: USER\_VOLUNTEER\_MEMBERSHIP > `const` **USER\_VOLUNTEER\_MEMBERSHIP**: `DocumentNode` Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L147) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/VOLUNTEER_RANKING.md ================================================ [Admin Docs](/) *** # Variable: VOLUNTEER\_RANKING > `const` **VOLUNTEER\_RANKING**: `DocumentNode` Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L251) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/NotificationQueries/variables/GET_USER_NOTIFICATIONS.md ================================================ [Admin Docs](/) *** # Variable: GET\_USER\_NOTIFICATIONS > `const` **GET\_USER\_NOTIFICATIONS**: `DocumentNode` Defined in: [src/GraphQl/Queries/NotificationQueries.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/NotificationQueries.ts#L3) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/NotificationQueries/variables/MARK_NOTIFICATION_AS_READ.md ================================================ [Admin Docs](/) *** # Variable: MARK\_NOTIFICATION\_AS\_READ > `const` **MARK\_NOTIFICATION\_AS\_READ**: `DocumentNode` Defined in: [src/GraphQl/Queries/NotificationQueries.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/NotificationQueries.ts#L22) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_MEMBERS.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_MEMBERS > `const` **ORGANIZATION\_MEMBERS**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:368](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L368) GraphQL query to fetch organization members with pagination and filtering. This query uses the new connection-based schema with input objects. ## Param QueryOrganizationInput containing the organization ID ## Param Number of members to fetch ## Param Cursor for pagination ## Param MembersWhereInput for filtering (e.g., name_contains) ## Returns Organization members with connection structure ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_PINNED_POST_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_PINNED\_POST\_LIST > `const` **ORGANIZATION\_PINNED\_POST\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L16) GraphQL query to retrieve the list of organizations. ## Param Optional. Number of organizations to retrieve in the first batch. ## Param Optional. Number of organizations to skip before starting to collect the result set. ## Param Optional. Filter organizations by a specified string. ## Param Optional. The ID of a specific organization to retrieve. ## Returns The list of organizations based on the applied filters. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_POST_BY_ID.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_POST\_BY\_ID > `const` **ORGANIZATION\_POST\_BY\_ID**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L122) GraphQL query to retrieve a single post by its ID. ## Param The ID of the post to retrieve. ## Param The ID of the user to check vote status against. ## Returns The post with its metadata, attachments, vote information, and creator details. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_POST_LIST_WITH_VOTES.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_POST\_LIST\_WITH\_VOTES > `const` **ORGANIZATION\_POST\_LIST\_WITH\_VOTES**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L65) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_USER_TAGS_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_USER\_TAGS\_LIST > `const` **ORGANIZATION\_USER\_TAGS\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L194) GraphQL query to retrieve the list of user tags belonging to an organization. ## Param ID of the organization. ## Param Number of tags to retrieve "after" (if provided) a certain tag. ## Param Id of the last tag on the current page. ## Param Number of tags to retrieve "before" (if provided) a certain tag. ## Param Id of the first tag on the current page. ## Returns The list of organizations based on the applied filters. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_USER_TAGS_LIST_PG.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_USER\_TAGS\_LIST\_PG > `const` **ORGANIZATION\_USER\_TAGS\_LIST\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L245) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_CREATED_ORGANIZATIONS.md ================================================ [Admin Docs](/) *** # Variable: USER\_CREATED\_ORGANIZATIONS > `const` **USER\_CREATED\_ORGANIZATIONS**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L291) GraphQL query to retrieve organizations created by a user. ## Param The ID of the user for which created organizations are being retrieved. ## Returns The list of organizations created by the user. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_JOINED_ORGANIZATIONS_PG.md ================================================ [Admin Docs](/) *** # Variable: USER\_JOINED\_ORGANIZATIONS\_PG > `const` **USER\_JOINED\_ORGANIZATIONS\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L151) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/VENUE_LIST.md ================================================ [Admin Docs](/) *** # Variable: VENUE\_LIST > `const` **VENUE\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:330](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L330) GraphQL query to retrieve the list of venues for a specific organization. ## Param The ID of the organization for which venues are being retrieved. ## Returns The list of venues associated with the organization. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHATS_LIST.md ================================================ [Admin Docs](/) *** # Variable: CHATS\_LIST > `const` **CHATS\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/PlugInQueries.ts:240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L240) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHAT_BY_ID.md ================================================ [Admin Docs](/) *** # Variable: CHAT\_BY\_ID > `const` **CHAT\_BY\_ID**: `DocumentNode` Defined in: [src/GraphQl/Queries/PlugInQueries.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L54) GraphQL query to retrieve a list of chats based on user ID. ## Param The ID of the user for which chats are being retrieved. ## Returns The list of chats associated with the user, including details such as ID, creator, messages, organization, and participating users. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/GET_ALL_PLUGINS.md ================================================ [Admin Docs](/) *** # Variable: GET\_ALL\_PLUGINS > `const` **GET\_ALL\_PLUGINS**: `DocumentNode` Defined in: [src/GraphQl/Queries/PlugInQueries.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L8) GraphQL query to retrieve all plugins. ## Returns The list of plugins with details such as id, pluginId, isActivated, isInstalled, createdAt, and updatedAt. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/IS_SAMPLE_ORGANIZATION_QUERY.md ================================================ [Admin Docs](/) *** # Variable: IS\_SAMPLE\_ORGANIZATION\_QUERY > `const` **IS\_SAMPLE\_ORGANIZATION\_QUERY**: `DocumentNode` Defined in: [src/GraphQl/Queries/PlugInQueries.ts:359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L359) GraphQL query to check if an organization is a sample organization. ## Param The ID of the organization being checked. ## Returns A boolean indicating whether the organization is a sample organization. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/UNREAD_CHATS.md ================================================ [Admin Docs](/) *** # Variable: UNREAD\_CHATS > `const` **UNREAD\_CHATS**: `DocumentNode` Defined in: [src/GraphQl/Queries/PlugInQueries.ts:297](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L297) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ALL_ORGANIZATIONS_PG.md ================================================ [Admin Docs](/) *** # Variable: ALL\_ORGANIZATIONS\_PG > `const` **ALL\_ORGANIZATIONS\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L122) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/CURRENT_USER.md ================================================ [Admin Docs](/) *** # Variable: CURRENT\_USER > `const` **CURRENT\_USER**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L4) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_ATTENDEES.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_ATTENDEES > `const` **EVENT\_ATTENDEES**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:348](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L348) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_CHECKINS.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_CHECKINS > `const` **EVENT\_CHECKINS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L391) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_DETAILS.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_DETAILS > `const` **EVENT\_DETAILS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L294) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_FEEDBACKS.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_FEEDBACKS > `const` **EVENT\_FEEDBACKS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:411](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L411) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_REGISTRANTS.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_REGISTRANTS > `const` **EVENT\_REGISTRANTS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:368](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L368) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_DATA_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_COMMUNITY\_DATA\_PG > `const` **GET\_COMMUNITY\_DATA\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1183) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_SESSION_TIMEOUT_DATA_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_COMMUNITY\_SESSION\_TIMEOUT\_DATA\_PG > `const` **GET\_COMMUNITY\_SESSION\_TIMEOUT\_DATA\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1234) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_EVENTS_BY_ORGANIZATION_ID.md ================================================ [Admin Docs](/) *** # Variable: GET\_EVENTS\_BY\_ORGANIZATION\_ID > `const` **GET\_EVENTS\_BY\_ORGANIZATION\_ID**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1296) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_BASIC_DATA.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_BASIC\_DATA > `const` **GET\_ORGANIZATION\_BASIC\_DATA**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:750](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L750) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_BLOCKED_USERS_COUNT.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_BLOCKED\_USERS\_COUNT > `const` **GET\_ORGANIZATION\_BLOCKED\_USERS\_COUNT**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:507](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L507) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_BLOCKED_USERS_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_BLOCKED\_USERS\_PG > `const` **GET\_ORGANIZATION\_BLOCKED\_USERS\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L485) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_DATA_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_DATA\_PG > `const` **GET\_ORGANIZATION\_DATA\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:760](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L760) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_EVENTS_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_EVENTS\_PG > `const` **GET\_ORGANIZATION\_EVENTS\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:525](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L525) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_EVENTS_USER_PORTAL_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_EVENTS\_USER\_PORTAL\_PG > `const` **GET\_ORGANIZATION\_EVENTS\_USER\_PORTAL\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:612](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L612) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_MEMBERS_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_MEMBERS\_PG > `const` **GET\_ORGANIZATION\_MEMBERS\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:463](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L463) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_COUNT_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_POSTS\_COUNT\_PG > `const` **GET\_ORGANIZATION\_POSTS\_COUNT\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:427](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L427) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_POSTS\_PG > `const` **GET\_ORGANIZATION\_POSTS\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:694](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L694) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_VENUES_COUNT.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_VENUES\_COUNT > `const` **GET\_ORGANIZATION\_VENUES\_COUNT**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:516](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L516) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_VENUES_PG.md ================================================ [Admin Docs](/) *** # Variable: GET\_ORGANIZATION\_VENUES\_PG > `const` **GET\_ORGANIZATION\_VENUES\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1242) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_USER_BY_ID.md ================================================ [Admin Docs](/) *** # Variable: GET\_USER\_BY\_ID > `const` **GET\_USER\_BY\_ID**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:436](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L436) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_USER_TAGS.md ================================================ [Admin Docs](/) *** # Variable: GET\_USER\_TAGS > `const` **GET\_USER\_TAGS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1271) Fetches tags assigned to a user, including assignees (capped), creator, and folder. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERSHIP_REQUEST_PG.md ================================================ [Admin Docs](/) *** # Variable: MEMBERSHIP\_REQUEST\_PG > `const` **MEMBERSHIP\_REQUEST\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1065](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1065) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST.md ================================================ [Admin Docs](/) *** # Variable: MEMBERS\_LIST > `const` **MEMBERS\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:851](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L851) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST_PG.md ================================================ [Admin Docs](/) *** # Variable: MEMBERS\_LIST\_PG > `const` **MEMBERS\_LIST\_PG**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:832](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L832) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST_WITH_DETAILS.md ================================================ [Admin Docs](/) *** # Variable: MEMBERS\_LIST\_WITH\_DETAILS > `const` **MEMBERS\_LIST\_WITH\_DETAILS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:865](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L865) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATIONS\_LIST > `const` **ORGANIZATIONS\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:801](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L801) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST_BASIC.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATIONS\_LIST\_BASIC > `const` **ORGANIZATIONS\_LIST\_BASIC**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:823](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L823) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_MEMBER_CONNECTION_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATIONS\_MEMBER\_CONNECTION\_LIST > `const` **ORGANIZATIONS\_MEMBER\_CONNECTION\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:882](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L882) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_DONATION_CONNECTION_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_DONATION\_CONNECTION\_LIST > `const` **ORGANIZATION\_DONATION\_CONNECTION\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1044](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1044) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_CONNECTION_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_EVENT\_CONNECTION\_LIST > `const` **ORGANIZATION\_EVENT\_CONNECTION\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:988](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L988) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_FIELDS.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_FIELDS > `const` **ORGANIZATION\_FIELDS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:785](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L785) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_FILTER_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_FILTER\_LIST > `const` **ORGANIZATION\_FILTER\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L73) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_LIST.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_LIST > `const` **ORGANIZATION\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L54) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_LIST_NO_MEMBERS.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_LIST\_NO\_MEMBERS > `const` **ORGANIZATION\_LIST\_NO\_MEMBERS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L84) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_MEMBER_ADMIN_COUNT.md ================================================ [Admin Docs](/) *** # Variable: ORGANIZATION\_MEMBER\_ADMIN\_COUNT > `const` **ORGANIZATION\_MEMBER\_ADMIN\_COUNT**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L94) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/RECURRING_EVENTS.md ================================================ [Admin Docs](/) *** # Variable: RECURRING\_EVENTS > `const` **RECURRING\_EVENTS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:334](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L334) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/SIGNIN_QUERY.md ================================================ [Admin Docs](/) *** # Variable: SIGNIN\_QUERY > `const` **SIGNIN\_QUERY**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1206) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USERS_CONNECTION_LIST.md ================================================ [Admin Docs](/) *** # Variable: USERS\_CONNECTION\_LIST > `const` **USERS\_CONNECTION\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:1094](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1094) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_DETAILS.md ================================================ [Admin Docs](/) *** # Variable: USER\_DETAILS > `const` **USER\_DETAILS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:936](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L936) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_JOINED_ORGANIZATIONS_NO_MEMBERS.md ================================================ [Admin Docs](/) *** # Variable: USER\_JOINED\_ORGANIZATIONS\_NO\_MEMBERS > `const` **USER\_JOINED\_ORGANIZATIONS\_NO\_MEMBERS**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L104) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST.md ================================================ [Admin Docs](/) *** # Variable: USER\_LIST > `const` **USER\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L142) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_FOR_ADMIN.md ================================================ [Admin Docs](/) *** # Variable: USER\_LIST\_FOR\_ADMIN > `const` **USER\_LIST\_FOR\_ADMIN**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L217) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_FOR_TABLE.md ================================================ [Admin Docs](/) *** # Variable: USER\_LIST\_FOR\_TABLE > `const` **USER\_LIST\_FOR\_TABLE**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L182) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_ORGANIZATION_LIST.md ================================================ [Admin Docs](/) *** # Variable: USER\_ORGANIZATION\_LIST > `const` **USER\_ORGANIZATION\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/Queries.ts:922](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L922) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN.md ================================================ [Admin Docs](/) *** # Variable: FUND\_CAMPAIGN > `const` **FUND\_CAMPAIGN**: `DocumentNode` Defined in: [src/GraphQl/Queries/fundQueries.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L51) Query to fetch a specific fund by its ID, along with its associated campaigns. ## Param The ID of the fund campaign to be fetched. ## Param The name of the fund campaign to be fetched. ## Param The start date of the fund campaign to be fetched. ## Param The end date of the fund campaign to be fetched. ## Param The currency code of the fund campaign to be fetched. ## Param The goal amount of the fund campaign to be fetched. ## Returns The fund campaign with the specified ID. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN_PLEDGE.md ================================================ [Admin Docs](/) *** # Variable: FUND\_CAMPAIGN\_PLEDGE > `const` **FUND\_CAMPAIGN\_PLEDGE**: `DocumentNode` Defined in: [src/GraphQl/Queries/fundQueries.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L72) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_LIST.md ================================================ [Admin Docs](/) *** # Variable: FUND\_LIST > `const` **FUND\_LIST**: `DocumentNode` Defined in: [src/GraphQl/Queries/fundQueries.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L13) GraphQL query to retrieve the list of members for a specific organization. ## Param The ID of the organization for which members are being retrieved. ## Param The name of the organization for which members are being retrieved. ## Param The ID of the creator of the organization. ## Param The ID of the user who last updated the organization. ## Param A boolean value indicating whether the organization is tax deductible. ## Returns The list of members associated with the organization. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_FUND_CAMPAIGNS.md ================================================ [Admin Docs](/) *** # Variable: USER\_FUND\_CAMPAIGNS > `const` **USER\_FUND\_CAMPAIGNS**: `DocumentNode` Defined in: [src/GraphQl/Queries/fundQueries.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L108) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_PLEDGES.md ================================================ [Admin Docs](/) *** # Variable: USER\_PLEDGES > `const` **USER\_PLEDGES**: `DocumentNode` Defined in: [src/GraphQl/Queries/fundQueries.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L133) ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_ASSIGNED_MEMBERS.md ================================================ [Admin Docs](/) *** # Variable: USER\_TAGS\_ASSIGNED\_MEMBERS > `const` **USER\_TAGS\_ASSIGNED\_MEMBERS**: `DocumentNode` Defined in: [src/GraphQl/Queries/userTagQueries.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/userTagQueries.ts#L10) GraphQL query to retrieve organization members assigned a certain tag. ## Param The ID of the tag that is assigned. ## Returns The list of organization members. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_MEMBERS_TO_ASSIGN_TO.md ================================================ [Admin Docs](/) *** # Variable: USER\_TAGS\_MEMBERS\_TO\_ASSIGN\_TO > `const` **USER\_TAGS\_MEMBERS\_TO\_ASSIGN\_TO**: `DocumentNode` Defined in: [src/GraphQl/Queries/userTagQueries.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/userTagQueries.ts#L119) GraphQL query to retrieve organization members that aren't assigned a certain tag. ## Param The ID of the tag. ## Returns The list of organization members. ================================================ FILE: docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAG_SUB_TAGS.md ================================================ [Admin Docs](/) *** # Variable: USER\_TAG\_SUB\_TAGS > `const` **USER\_TAG\_SUB\_TAGS**: `DocumentNode` Defined in: [src/GraphQl/Queries/userTagQueries.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/userTagQueries.ts#L60) GraphQL query to retrieve the sub tags of a certain tag. ## Param The ID of the parent tag. ## Returns The list of sub tags. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTag/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAddPeopleToTagProps`](../../../../../types/AdminPortal/Tag/interface/interfaces/InterfaceAddPeopleToTagProps.md)\> Defined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTag.tsx:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTag.tsx#L76) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `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`; \}; \}; \})[] Defined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L5) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS_ERROR.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_ERROR > `const` **MOCKS\_ERROR**: `object`[] Defined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L277) ## Type Declaration ### error > **error**: `Error` ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `USER_TAGS_MEMBERS_TO_ASSIGN_TO` #### request.variables > **variables**: `object` #### request.variables.first > **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` #### request.variables.id > **id**: `string` = `'1'` #### request.variables.where > **where**: `object` #### request.variables.where.firstName > **firstName**: `object` #### request.variables.where.firstName.starts\_with > **starts\_with**: `string` = `''` #### request.variables.where.lastName > **lastName**: `object` #### request.variables.where.lastName.starts\_with > **starts\_with**: `string` = `''` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_EMPTY.md ================================================ [Admin Docs](/) *** # Variable: MOCK\_EMPTY > `const` **MOCK\_EMPTY**: `object`[] Defined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L294) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `USER_TAGS_MEMBERS_TO_ASSIGN_TO` #### request.variables > **variables**: `object` #### request.variables.first > **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` #### request.variables.id > **id**: `string` = `'1'` #### request.variables.where > **where**: `object` #### request.variables.where.firstName > **firstName**: `object` #### request.variables.where.firstName.starts\_with > **starts\_with**: `string` = `''` #### request.variables.where.lastName > **lastName**: `object` #### request.variables.where.lastName.starts\_with > **starts\_with**: `string` = `''` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.getUsersToAssignTo > **getUsersToAssignTo**: `object` #### result.data.getUsersToAssignTo.usersToAssignTo > **usersToAssignTo**: `object` #### result.data.getUsersToAssignTo.usersToAssignTo.edges > **edges**: `any`[] = `[]` #### result.data.getUsersToAssignTo.usersToAssignTo.pageInfo > **pageInfo**: `object` #### result.data.getUsersToAssignTo.usersToAssignTo.pageInfo.hasNextPage > **hasNextPage**: `boolean` = `false` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NON_ERROR.md ================================================ [Admin Docs](/) *** # Variable: MOCK\_NON\_ERROR > `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`; \})[] Defined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L322) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/Advertisements/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/AdminPortal/Advertisements/Advertisements.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/Advertisements.tsx#L51) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/functions/wait.md ================================================ [Admin Docs](/) *** # Function: wait() > **wait**(`ms`): `Promise`\<`void`\> Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:199](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L199) ## Parameters ### ms `number` = `100` ## Returns `Promise`\<`void`\> ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/client.md ================================================ [Admin Docs](/) *** # Variable: client > `const` **client**: `ApolloClient`\<`NormalizedCacheObject`\> Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L191) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisement.md ================================================ [Admin Docs](/) *** # Variable: createAdvertisement > `const` **createAdvertisement**: (`IAdvertisementListMock` \| `IBaseMutationMock`\<\{ `endAt`: `string`; `name`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \}\>)[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:465](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L465) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisementError.md ================================================ [Admin Docs](/) *** # Variable: createAdvertisementError > `const` **createAdvertisementError**: `IBaseMutationMock`\<\{ `endAt`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \}\>[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:517](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L517) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisementWithEndDateBeforeStart.md ================================================ [Admin Docs](/) *** # Variable: createAdvertisementWithEndDateBeforeStart > `const` **createAdvertisementWithEndDateBeforeStart**: `IBaseMutationMock`\<\{ `endAt`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \}\>[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:504](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L504) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisementWithoutName.md ================================================ [Admin Docs](/) *** # Variable: createAdvertisementWithoutName > `const` **createAdvertisementWithoutName**: `IBaseMutationMock`\<\{ `endAt`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \}\>[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:491](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L491) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createDates.md ================================================ [Admin Docs](/) *** # Variable: createDates > **createDates**: `object` Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L173) ## Type Declaration ### endAtCalledWith > **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'` ### endAtISO > **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'` ### endBeforeStartCalledWith > **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'` ### endBeforeStartISO > **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'` ### endBeforeStartISOReceived > **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'` ### endISOReceived > **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'` ### startAtCalledWith > **startAtCalledWith**: `string` ### startAtISO > **startAtISO**: `string` ### startISOReceived > **startISOReceived**: `string` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/dateConstants.md ================================================ [Admin Docs](/) *** # Variable: dateConstants > `const` **dateConstants**: `object` Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L138) ## Type Declaration ### create > **create**: `object` #### create.endAtCalledWith > **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'` #### create.endAtISO > **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'` #### create.endBeforeStartCalledWith > **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'` #### create.endBeforeStartISO > **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'` #### create.endBeforeStartISOReceived > **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'` #### create.endISOReceived > **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'` #### create.startAtCalledWith > **startAtCalledWith**: `string` #### create.startAtISO > **startAtISO**: `string` #### create.startISOReceived > **startISOReceived**: `string` ### update > **update**: `object` #### update.endAtCalledWith > **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'` #### update.endAtISO > **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'` #### update.endBeforeStartCalledWith > **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'` #### update.endBeforeStartISO > **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'` #### update.endBeforeStartISOReceived > **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'` #### update.endISOReceived > **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'` #### update.startAtCalledWith > **startAtCalledWith**: `string` #### update.startAtISO > **startAtISO**: `string` #### update.startISOReceived > **startISOReceived**: `string` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/deleteAdvertisementMocks.md ================================================ [Admin Docs](/) *** # Variable: deleteAdvertisementMocks > `const` **deleteAdvertisementMocks**: (`IAdvertisementListMock` \| `IBaseMutationMock`\<\{ `id`: `string`; \}\>)[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:357](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L357) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/emptyMocks.md ================================================ [Admin Docs](/) *** # Variable: emptyMocks > `const` **emptyMocks**: `IAdvertisementListMock`[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L318) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/fetchErrorMocks.md ================================================ [Admin Docs](/) *** # Variable: fetchErrorMocks > `const` **fetchErrorMocks**: `IBaseMutationMock`\<\{ `after`: `any`; `first`: `number`; `id`: `string`; `where`: \{ `isCompleted`: `boolean`; \}; \}\>[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:568](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L568) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/filterActiveAdvertisementData.md ================================================ [Admin Docs](/) *** # Variable: filterActiveAdvertisementData > `const` **filterActiveAdvertisementData**: `IAdvertisementListMock`[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:437](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L437) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/filterCompletedAdvertisementData.md ================================================ [Admin Docs](/) *** # Variable: filterCompletedAdvertisementData > `const` **filterCompletedAdvertisementData**: `IAdvertisementListMock`[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:451](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L451) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/getActiveAdvertisementMocks.md ================================================ [Admin Docs](/) *** # Variable: getActiveAdvertisementMocks > `const` **getActiveAdvertisementMocks**: `IAdvertisementListMock`[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:352](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L352) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/getCompletedAdvertisementMocks.md ================================================ [Admin Docs](/) *** # Variable: getCompletedAdvertisementMocks > `const` **getCompletedAdvertisementMocks**: `IAdvertisementListMock`[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:347](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L347) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/initialActiveData.md ================================================ [Admin Docs](/) *** # Variable: initialActiveData > `const` **initialActiveData**: `IAdvertisementListMock`[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:404](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L404) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/initialArchivedData.md ================================================ [Admin Docs](/) *** # Variable: initialArchivedData > `const` **initialArchivedData**: `IAdvertisementListMock`[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:371](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L371) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/link.md ================================================ [Admin Docs](/) *** # Variable: link > `const` **link**: `ApolloLink` Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L189) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/updateAdMocks.md ================================================ [Admin Docs](/) *** # Variable: updateAdMocks > `const` **updateAdMocks**: (`IAdvertisementListMock` \| `IBaseMutationMock`\<\{ `description`: `string`; `endAt`: `string`; `id`: `string`; `startAt`: `string`; \}\>)[] Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:531](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L531) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/updateDates.md ================================================ [Admin Docs](/) *** # Variable: updateDates > **updateDates**: `object` Defined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L173) ## Type Declaration ### endAtCalledWith > **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'` ### endAtISO > **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'` ### endBeforeStartCalledWith > **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'` ### endBeforeStartISO > **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'` ### endBeforeStartISOReceived > **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'` ### endISOReceived > **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'` ### startAtCalledWith > **startAtCalledWith**: `string` ### startAtISO > **startAtISO**: `string` ### startISOReceived > **startISOReceived**: `string` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementEntry/AdvertisementEntry/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters #### advertisement [`Advertisement`](../../../../../../../types/AdminPortal/Advertisement/type/type-aliases/Advertisement.md) #### setAfterActive `Dispatch`\<`SetStateAction`\<`string`\>\> #### setAfterCompleted `Dispatch`\<`SetStateAction`\<`string`\>\> ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegister/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`InterfaceAddOnRegisterProps`](../../../../../../../types/AdminPortal/Advertisement/interface/interfaces/InterfaceAddOnRegisterProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/createAdFailMock.md ================================================ [Admin Docs](/) *** # Variable: createAdFailMock > `const` **createAdFailMock**: `MockedResponse`\<`Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/createAdvertisement.md ================================================ [Admin Docs](/) *** # Variable: createAdvertisement > `const` **createAdvertisement**: `MockedResponse`\<`Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/dateConstants.md ================================================ [Admin Docs](/) *** # Variable: dateConstants > `const` **dateConstants**: `object` Defined 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) ## Type Declaration ### create > **create**: `object` #### create.endAtCalledWith > **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'` #### create.endAtISO > **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'` #### create.endBeforeStartCalledWith > **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'` #### create.endBeforeStartISO > **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'` #### create.endBeforeStartISOReceived > **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'` #### create.endISOReceived > **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'` #### create.startAtCalledWith > **startAtCalledWith**: `string` #### create.startAtISO > **startAtISO**: `string` #### create.startISOReceived > **startISOReceived**: `string` ### update > **update**: `object` #### update.endAtCalledWith > **endAtCalledWith**: `string` = `'2040-02-01T00:00:00.000Z'` #### update.endAtISO > **endAtISO**: `string` = `'2040-02-01T18:30:00.000Z'` #### update.endBeforeStartCalledWith > **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'` #### update.endBeforeStartISO > **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'` #### update.endBeforeStartISOReceived > **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'` #### update.endISOReceived > **endISOReceived**: `string` = `'2040-01-31T18:30:00.000Z'` #### update.startAtCalledWith > **startAtCalledWith**: `string` = `'2020-12-31T00:00:00.000Z'` #### update.startAtISO > **startAtISO**: `string` = `'2020-12-31T18:30:00.000Z'` #### update.startISOReceived > **startISOReceived**: `string` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/mockBigFile.md ================================================ [Admin Docs](/) *** # Variable: mockBigFile > `const` **mockBigFile**: `File` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/mockFile.md ================================================ [Admin Docs](/) *** # Variable: mockFile > `const` **mockFile**: `File` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/updateAdFailMock.md ================================================ [Admin Docs](/) *** # Variable: updateAdFailMock > `const` **updateAdFailMock**: `MockedResponse`\<`Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Advertisements/skeleton/AdvertisementSkeleton/functions/AdvertisementSkeleton.md ================================================ [Admin Docs](/) *** # Function: AdvertisementSkeleton() > **AdvertisementSkeleton**(): `Element`[] Defined 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) AdvertisementSkeleton Component This component renders a skeleton loader for advertisements, typically used as a placeholder while the actual advertisement data is being fetched or loaded. It creates a list of 6 skeleton items, each styled to resemble the layout of an advertisement card. Each skeleton item includes: - A shimmering image container to represent the advertisement image. - A shimmering title placeholder to represent the advertisement name. - A shimmering button placeholder. The skeleton items are styled using CSS classes provided by the `styles` object, and each item is uniquely identified with a `data-testid` attribute for testing purposes. ## Returns `Element`[] An array of JSX elements representing the skeleton loaders. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaFolder/AgendaFolderContainer/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/AdminPortal/AgendaFolder/AgendaFolderContainer.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaFolder/AgendaFolderContainer.tsx#L49) ## Parameters ### \_\_namedParameters #### agendaFolderConnection `"Event"` #### agendaFolderData [`InterfaceAgendaFolderInfo`](../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderInfo.md)[] #### agendaItemCategories [`InterfaceAgendaItemCategoryInfo`](../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemCategoryInfo.md)[] #### refetchAgendaFolder () => `void` #### t (`key`) => `string` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaFolder/Create/AgendaFolderCreateModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAgendaFolderCreateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderCreateModalProps.md)\> Defined 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) AgendaFolderCreateModal Modal component for creating a new agenda folder within an event. Calculates the next folder sequence based on existing folders and submits the creation request via GraphQL. Displays validation and mutation feedback using NotificationToast and refreshes agenda folder data on successful creation. ## Param Controls modal visibility ## Param Callback to close the modal ## Param ID of the event the folder belongs to ## Param Existing agenda folder data for sequence calculation ## Param i18n translation function ## Param Refetches agenda folder data after creation ## Returns JSX.Element | null ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaFolder/Delete/AgendaFolderDeleteModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAgendaFolderDeleteModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderDeleteModalProps.md)\> Defined 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) AgendaFolderDeleteModal Confirmation modal for deleting an agenda folder. Uses `DeleteModal` to provide consistent delete confirmation UI. ## Param Controls modal visibility ## Param Callback to close the modal ## Param ID of the agenda folder to delete ## Param Refetches agenda folder data after deletion ## Param i18n translation function ## Returns JSX.Element ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaFolder/DragAndDrop/AgendaDragAndDrop/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`folders`): `Element` Defined 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) AgendaDragAndDrop Renders draggable agenda folders and items with support for reordering. Handles folder-level and item-level drag-and-drop with optimistic UI updates and backend sequence synchronization. ## Parameters ### folders [`InterfaceAgendaDragAndDropProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaDragAndDropProps.md) List of agenda folders with their items ## Returns `Element` JSX.Element ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaFolder/Update/AgendaFolderUpdateModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAgendaFolderUpdateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderUpdateModalProps.md)\> Defined 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) AgendaFolderUpdateModal Edit modal for updating an existing agenda folder. Uses the shared `EditModal` for consistent update behavior. ## Param Controls modal visibility ## Param Callback to close the modal ## Param Current agenda folder form state ## Param Setter for agenda folder form state ## Param ID of the agenda folder being updated ## Param Refetches agenda folder data after update ## Param i18n translation function ## Returns JSX.Element ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaItems/Create/AgendaItemsCreateModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAgendaItemsCreateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsCreateModalProps.md)\> Defined 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) AgendaItemsCreateModal Create modal for adding a new agenda item. Built on `CreateModal` for consistent create UX and loading handling. ## Param Controls modal visibility ## Param Callback to close the modal ## Param ID of the event ## Param Available agenda item categories ## Param Available agenda folders ## Param Refetches agenda folder data after creation ## Param i18n translation function ## Returns JSX.Element ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaItems/Delete/AgendaItemsDeleteModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAgendaItemsDeleteModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsDeleteModalProps.md)\> Defined 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) AgendaItemsDeleteModal Confirmation modal for deleting an agenda item. Uses the shared `DeleteModal` for standardized delete behavior. ## Param Controls modal visibility ## Param Callback to close the modal ## Param ID of the agenda item to delete ## Param Refetches agenda folder data after deletion ## Param i18n translation function ## Returns JSX.Element ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaItems/Preview/AgendaItemsPreviewModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAgendaItemsPreviewModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsPreviewModalProps.md)\> Defined 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) AgendaItemsPreviewModal Read-only preview modal for agenda item details rendered in `ViewModal`. ## Param Controls modal visibility ## Param Callback to close the preview modal ## Param Agenda item data to display ## Param i18n translation function ## Returns JSX.Element ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AgendaItems/Update/AgendaItemsUpdateModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAgendaItemsUpdateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsUpdateModalProps.md)\> Defined 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) AgendaItemsUpdateModal Edit modal for updating an existing agenda item. Uses `EditModal` to handle submission, loading, and keyboard actions. ## Param Controls modal visibility ## Param Callback to close the modal ## Param ID of the agenda item being updated ## Param Current agenda item form state ## Param Setter for agenda item form state ## Param Available agenda item categories ## Param Available agenda folders ## Param Refetches agenda folder data after update ## Param i18n translation function ## Returns JSX.Element ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/ApplyToSelector/ApplyToSelector/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceApplyToSelectorProps`](../../../../../types/AdminPortal/ApplyToSelector/interface/interfaces/InterfaceApplyToSelectorProps.md)\> Defined in: [src/components/AdminPortal/ApplyToSelector/ApplyToSelector.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/ApplyToSelector/ApplyToSelector.tsx#L18) A radio group selector for choosing action item scope. Allows users to apply an action item to an entire series or a single instance. ## Param Component props from InterfaceApplyToSelectorProps ## Returns Radio group component for scope selection ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/AssignmentTypeSelector/AssignmentTypeSelector/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAssignmentTypeSelectorProps`](../../../../../types/AdminPortal/AssignmentTypeSelector/interface/interfaces/InterfaceAssignmentTypeSelectorProps.md)\> Defined in: [src/components/AdminPortal/AssignmentTypeSelector/AssignmentTypeSelector.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AssignmentTypeSelector/AssignmentTypeSelector.tsx#L17) Chip-based toggle selector for choosing assignment type (volunteer or volunteer group). ## Param Component props from InterfaceAssignmentTypeSelectorProps ## Returns Chip toggle component for assignment type selection ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/ContriStats/ContriStats/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/AdminPortal/ContriStats/ContriStats.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/ContriStats/ContriStats.tsx#L32) ## Parameters ### \_\_namedParameters [`InterfaceContriStatsProps`](../../../../../types/AdminPortal/Contribution/interface/interfaces/InterfaceContriStatsProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined 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) ## Parameters ### props #### eventId `string` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_EMPTY_DATE_STRINGS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_EMPTY\_DATE\_STRINGS > `const` **MOCKS\_EMPTY\_DATE\_STRINGS**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.allDay > **allDay**: `boolean` = `false` #### result.data.event.baseEvent > **baseEvent**: `any` = `null` #### result.data.event.createdAt > **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'` #### result.data.event.creator > **creator**: `object` #### result.data.event.creator.emailAddress > **emailAddress**: `string` = `'john.doe@example.com'` #### result.data.event.creator.id > **id**: `string` = `'creator1'` #### result.data.event.creator.name > **name**: `string` = `'John Doe'` #### result.data.event.description > **description**: `string` = `'Test Description'` #### result.data.event.endAt > **endAt**: `string` = `''` #### result.data.event.id > **id**: `string` = `'event123'` #### result.data.event.isInviteOnly > **isInviteOnly**: `boolean` = `false` #### result.data.event.isPublic > **isPublic**: `boolean` = `true` #### result.data.event.isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` = `false` #### result.data.event.isRegisterable > **isRegisterable**: `boolean` = `true` #### result.data.event.location > **location**: `string` = `'India'` #### result.data.event.name > **name**: `string` = `'Test Event'` #### result.data.event.organization > **organization**: `object` #### result.data.event.organization.id > **id**: `string` = `'org1'` #### result.data.event.organization.name > **name**: `string` = `'Test Org'` #### result.data.event.recurrenceRule > **recurrenceRule**: `any` = `null` #### result.data.event.startAt > **startAt**: `string` = `''` #### result.data.event.updatedAt > **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'` #### result.data.event.updater > **updater**: `object` #### result.data.event.updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### result.data.event.updater.id > **id**: `string` = `'updater1'` #### result.data.event.updater.name > **name**: `string` = `'Updater Person'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_INVALID_DATETIME.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_INVALID\_DATETIME > `const` **MOCKS\_INVALID\_DATETIME**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.allDay > **allDay**: `boolean` = `false` #### result.data.event.baseEvent > **baseEvent**: `any` = `null` #### result.data.event.createdAt > **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'` #### result.data.event.creator > **creator**: `object` #### result.data.event.creator.emailAddress > **emailAddress**: `string` = `'john.doe@example.com'` #### result.data.event.creator.id > **id**: `string` = `'creator1'` #### result.data.event.creator.name > **name**: `string` = `'John Doe'` #### result.data.event.description > **description**: `string` = `'Test Description'` #### result.data.event.endAt > **endAt**: `string` #### result.data.event.id > **id**: `string` = `'event123'` #### result.data.event.isInviteOnly > **isInviteOnly**: `boolean` = `false` #### result.data.event.isPublic > **isPublic**: `boolean` = `true` #### result.data.event.isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` = `false` #### result.data.event.isRegisterable > **isRegisterable**: `boolean` = `true` #### result.data.event.location > **location**: `string` = `'India'` #### result.data.event.name > **name**: `string` = `'Test Event'` #### result.data.event.organization > **organization**: `object` #### result.data.event.organization.id > **id**: `string` = `'org1'` #### result.data.event.organization.name > **name**: `string` = `'Test Org'` #### result.data.event.recurrenceRule > **recurrenceRule**: `any` = `null` #### result.data.event.startAt > **startAt**: `string` #### result.data.event.updatedAt > **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'` #### result.data.event.updater > **updater**: `object` #### result.data.event.updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### result.data.event.updater.id > **id**: `string` = `'updater1'` #### result.data.event.updater.name > **name**: `string` = `'Updater Person'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_MISSING_DATA.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_MISSING\_DATA > `const` **MOCKS\_MISSING\_DATA**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `any` = `null` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_NO_EVENT.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_NO\_EVENT > `const` **MOCKS\_NO\_EVENT**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `any` = `null` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_NO_LOCATION.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_NO\_LOCATION > `const` **MOCKS\_NO\_LOCATION**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.allDay > **allDay**: `boolean` = `false` #### result.data.event.baseEvent > **baseEvent**: `any` = `null` #### result.data.event.createdAt > **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'` #### result.data.event.creator > **creator**: `object` #### result.data.event.creator.emailAddress > **emailAddress**: `string` = `'john.doe@example.com'` #### result.data.event.creator.id > **id**: `string` = `'creator1'` #### result.data.event.creator.name > **name**: `string` = `'John Doe'` #### result.data.event.description > **description**: `string` = `''` #### result.data.event.endAt > **endAt**: `string` #### result.data.event.id > **id**: `string` = `'event123'` #### result.data.event.isInviteOnly > **isInviteOnly**: `boolean` = `false` #### result.data.event.isPublic > **isPublic**: `boolean` = `true` #### result.data.event.isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` = `false` #### result.data.event.isRegisterable > **isRegisterable**: `boolean` = `true` #### result.data.event.location > **location**: `any` = `null` #### result.data.event.name > **name**: `string` = `'Test Event'` #### result.data.event.organization > **organization**: `object` #### result.data.event.organization.id > **id**: `string` = `'org1'` #### result.data.event.organization.name > **name**: `string` = `'Test Org'` #### result.data.event.recurrenceRule > **recurrenceRule**: `any` = `null` #### result.data.event.startAt > **startAt**: `string` #### result.data.event.updatedAt > **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'` #### result.data.event.updater > **updater**: `object` #### result.data.event.updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### result.data.event.updater.id > **id**: `string` = `'updater1'` #### result.data.event.updater.name > **name**: `string` = `'Updater Person'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_UNDEFINED_INVITE_ONLY.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_UNDEFINED\_INVITE\_ONLY > `const` **MOCKS\_UNDEFINED\_INVITE\_ONLY**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.allDay > **allDay**: `boolean` = `false` #### result.data.event.baseEvent > **baseEvent**: `any` = `null` #### result.data.event.createdAt > **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'` #### result.data.event.creator > **creator**: `object` #### result.data.event.creator.emailAddress > **emailAddress**: `string` = `'john.doe@example.com'` #### result.data.event.creator.id > **id**: `string` = `'creator1'` #### result.data.event.creator.name > **name**: `string` = `'John Doe'` #### result.data.event.description > **description**: `string` = `'Test Description'` #### result.data.event.endAt > **endAt**: `string` #### result.data.event.id > **id**: `string` = `'event123'` #### result.data.event.isInviteOnly > **isInviteOnly**: `any` = `undefined` #### result.data.event.isPublic > **isPublic**: `boolean` = `true` #### result.data.event.isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` = `false` #### result.data.event.isRegisterable > **isRegisterable**: `boolean` = `true` #### result.data.event.location > **location**: `string` = `'India'` #### result.data.event.name > **name**: `string` = `'Test Event'` #### result.data.event.organization > **organization**: `object` #### result.data.event.organization.id > **id**: `string` = `'org1'` #### result.data.event.organization.name > **name**: `string` = `'Test Org'` #### result.data.event.recurrenceRule > **recurrenceRule**: `any` = `null` #### result.data.event.startAt > **startAt**: `string` #### result.data.event.updatedAt > **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'` #### result.data.event.updater > **updater**: `object` #### result.data.event.updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### result.data.event.updater.id > **id**: `string` = `'updater1'` #### result.data.event.updater.name > **name**: `string` = `'Updater Person'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITHOUT_TIME.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_WITHOUT\_TIME > `const` **MOCKS\_WITHOUT\_TIME**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.allDay > **allDay**: `boolean` = `true` #### result.data.event.baseEvent > **baseEvent**: `any` = `null` #### result.data.event.createdAt > **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'` #### result.data.event.creator > **creator**: `object` #### result.data.event.creator.emailAddress > **emailAddress**: `string` = `'john.doe@example.com'` #### result.data.event.creator.id > **id**: `string` = `'creator1'` #### result.data.event.creator.name > **name**: `string` = `'John Doe'` #### result.data.event.description > **description**: `string` = `'Test Description'` #### result.data.event.endAt > **endAt**: `string` #### result.data.event.id > **id**: `string` = `'event123'` #### result.data.event.isInviteOnly > **isInviteOnly**: `boolean` = `false` #### result.data.event.isPublic > **isPublic**: `boolean` = `true` #### result.data.event.isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` = `false` #### result.data.event.isRegisterable > **isRegisterable**: `boolean` = `true` #### result.data.event.location > **location**: `string` = `'India'` #### result.data.event.name > **name**: `string` = `'Test Event'` #### result.data.event.organization > **organization**: `object` #### result.data.event.organization.id > **id**: `string` = `'org1'` #### result.data.event.organization.name > **name**: `string` = `'Test Org'` #### result.data.event.recurrenceRule > **recurrenceRule**: `any` = `null` #### result.data.event.startAt > **startAt**: `string` #### result.data.event.updatedAt > **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'` #### result.data.event.updater > **updater**: `object` #### result.data.event.updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### result.data.event.updater.id > **id**: `string` = `'updater1'` #### result.data.event.updater.name > **name**: `string` = `'Updater Person'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITH_TIME.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_WITH\_TIME > `const` **MOCKS\_WITH\_TIME**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.allDay > **allDay**: `boolean` = `false` #### result.data.event.baseEvent > **baseEvent**: `any` = `null` #### result.data.event.createdAt > **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'` #### result.data.event.creator > **creator**: `object` #### result.data.event.creator.emailAddress > **emailAddress**: `string` = `'john.doe@example.com'` #### result.data.event.creator.id > **id**: `string` = `'creator1'` #### result.data.event.creator.name > **name**: `string` = `'John Doe'` #### result.data.event.description > **description**: `string` = `'Test Description'` #### result.data.event.endAt > **endAt**: `string` #### result.data.event.id > **id**: `string` = `'event123'` #### result.data.event.isInviteOnly > **isInviteOnly**: `boolean` = `false` #### result.data.event.isPublic > **isPublic**: `boolean` = `true` #### result.data.event.isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` = `false` #### result.data.event.isRegisterable > **isRegisterable**: `boolean` = `true` #### result.data.event.location > **location**: `string` = `'India'` #### result.data.event.name > **name**: `string` = `'Test Event'` #### result.data.event.organization > **organization**: `object` #### result.data.event.organization.id > **id**: `string` = `'org1'` #### result.data.event.organization.name > **name**: `string` = `'Test Org'` #### result.data.event.recurrenceRule > **recurrenceRule**: `any` = `null` #### result.data.event.startAt > **startAt**: `string` #### result.data.event.updatedAt > **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'` #### result.data.event.updater > **updater**: `object` #### result.data.event.updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### result.data.event.updater.id > **id**: `string` = `'updater1'` #### result.data.event.updater.name > **name**: `string` = `'Updater Person'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventActionItems/EventActionItems/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<`InterfaceEventActionItemsProps`\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAgenda/EventAgenda/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined 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) ## Parameters ### props #### eventId `string` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/Attendance/EventAttendance/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined 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) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/AttendanceList/AttendedEventList/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<`Partial`\<[`InterfaceEvent`](../../../../../../../types/Event/interface/type-aliases/InterfaceEvent.md)\>\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks/variables/MOCKDETAIL.md ================================================ [Admin Docs](/) *** # Variable: MOCKDETAIL > `const` **MOCKDETAIL**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_DETAILS` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` = `MOCKEVENT` #### result.data.event.allDay > **allDay**: `boolean` = `false` #### result.data.event.createdAt > **createdAt**: `string` = `'2030-04-01T00:00:00.000Z'` #### result.data.event.creator > **creator**: `object` #### result.data.event.creator.emailAddress > **emailAddress**: `string` = `'creator@example.com'` #### result.data.event.creator.id > **id**: `string` = `'creator123'` #### result.data.event.creator.name > **name**: `string` = `'Creator Name'` #### result.data.event.description > **description**: `string` = `'This is a test event description'` #### result.data.event.endAt > **endAt**: `string` = `'2030-05-02T17:00:00.000Z'` #### result.data.event.id > **id**: `string` = `'event123'` #### result.data.event.isPublic > **isPublic**: `boolean` = `true` #### result.data.event.isRegisterable > **isRegisterable**: `boolean` = `true` #### result.data.event.location > **location**: `string` = `'Test Location'` #### result.data.event.name > **name**: `string` = `'Test Event'` #### result.data.event.organization > **organization**: `object` #### result.data.event.organization.id > **id**: `string` = `'org456'` #### result.data.event.organization.name > **name**: `string` = `'Test Organization'` #### result.data.event.recurrenceRule > **recurrenceRule**: `object` #### result.data.event.recurrenceRule.id > **id**: `string` = `'recurringEvent123'` #### result.data.event.startAt > **startAt**: `string` = `'2030-05-01T09:00:00.000Z'` #### result.data.event.updatedAt > **updatedAt**: `string` = `'2030-04-01T00:00:00.000Z'` #### result.data.event.updater > **updater**: `object` #### result.data.event.updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### result.data.event.updater.id > **id**: `string` = `'updater123'` #### result.data.event.updater.name > **name**: `string` = `'Updater Name'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks/variables/MOCKEVENT.md ================================================ [Admin Docs](/) *** # Variable: MOCKEVENT > `const` **MOCKEVENT**: `object` Defined 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) ## Type Declaration ### allDay > **allDay**: `boolean` = `false` ### createdAt > **createdAt**: `string` = `'2030-04-01T00:00:00.000Z'` ### creator > **creator**: `object` #### creator.emailAddress > **emailAddress**: `string` = `'creator@example.com'` #### creator.id > **id**: `string` = `'creator123'` #### creator.name > **name**: `string` = `'Creator Name'` ### description > **description**: `string` = `'This is a test event description'` ### endAt > **endAt**: `string` = `'2030-05-02T17:00:00.000Z'` ### id > **id**: `string` = `'event123'` ### isPublic > **isPublic**: `boolean` = `true` ### isRegisterable > **isRegisterable**: `boolean` = `true` ### location > **location**: `string` = `'Test Location'` ### name > **name**: `string` = `'Test Event'` ### organization > **organization**: `object` #### organization.id > **id**: `string` = `'org456'` #### organization.name > **name**: `string` = `'Test Organization'` ### recurrenceRule > **recurrenceRule**: `object` #### recurrenceRule.id > **id**: `string` = `'recurringEvent123'` ### startAt > **startAt**: `string` = `'2030-05-01T09:00:00.000Z'` ### updatedAt > **updatedAt**: `string` = `'2030-04-01T00:00:00.000Z'` ### updater > **updater**: `object` #### updater.emailAddress > **emailAddress**: `string` = `'updater@example.com'` #### updater.id > **id**: `string` = `'updater123'` #### updater.name > **name**: `string` = `'Updater Name'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `const` **MOCKS**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_ATTENDEES` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.attendees > **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`[]; \}; \})[] ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/Statistics/EventStatistics/variables/AttendanceStatisticsModal.md ================================================ [Admin Docs](/) *** # Variable: AttendanceStatisticsModal > `const` **AttendanceStatisticsModal**: `React.FC`\<[`InterfaceAttendanceStatisticsModalProps`](../../../../../../../types/Event/interface/type-aliases/InterfaceAttendanceStatisticsModalProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/EventRegistrants/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined 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) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/COMBINED_MOCKS.md ================================================ [Admin Docs](/) *** # Variable: COMBINED\_MOCKS > `const` **COMBINED\_MOCKS**: `MockedResponse`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EMPTY_EVENT_CHECKINS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: EMPTY\_EVENT\_CHECKINS\_MOCK > `const` **EMPTY\_EVENT\_CHECKINS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EMPTY_REGISTRANTS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: EMPTY\_REGISTRANTS\_MOCK > `const` **EMPTY\_REGISTRANTS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EMPTY_STATE_MOCKS.md ================================================ [Admin Docs](/) *** # Variable: EMPTY\_STATE\_MOCKS > `const` **EMPTY\_STATE\_MOCKS**: `MockedResponse`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/ERROR_DELETION_MOCKS.md ================================================ [Admin Docs](/) *** # Variable: ERROR\_DELETION\_MOCKS > `const` **ERROR\_DELETION\_MOCKS**: `MockedResponse`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EVENT_CHECKINS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_CHECKINS\_MOCK > `const` **EVENT\_CHECKINS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EVENT_DETAILS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: EVENT\_DETAILS\_MOCK > `const` **EVENT\_DETAILS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/MISSING_DATE_MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MISSING\_DATE\_MOCKS > `const` **MISSING\_DATE\_MOCKS**: `MockedResponse`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/MISSING_NAME_MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MISSING\_NAME\_MOCKS > `const` **MISSING\_NAME\_MOCKS**: `MockedResponse`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/RECURRING_EVENT_DETAILS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: RECURRING\_EVENT\_DETAILS\_MOCK > `const` **RECURRING\_EVENT\_DETAILS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/RECURRING_EVENT_MOCKS.md ================================================ [Admin Docs](/) *** # Variable: RECURRING\_EVENT\_MOCKS > `const` **RECURRING\_EVENT\_MOCKS**: `MockedResponse`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/RECURRING_EVENT_REGISTRANTS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: RECURRING\_EVENT\_REGISTRANTS\_MOCK > `const` **RECURRING\_EVENT\_REGISTRANTS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_ERROR_USER_MOCK.md ================================================ [Admin Docs](/) *** # Variable: REGISTRANTS\_ERROR\_USER\_MOCK > `const` **REGISTRANTS\_ERROR\_USER\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MISSING_DATE_MOCK.md ================================================ [Admin Docs](/) *** # Variable: REGISTRANTS\_MISSING\_DATE\_MOCK > `const` **REGISTRANTS\_MISSING\_DATE\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MISSING_NAME_MOCK.md ================================================ [Admin Docs](/) *** # Variable: REGISTRANTS\_MISSING\_NAME\_MOCK > `const` **REGISTRANTS\_MISSING\_NAME\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: REGISTRANTS\_MOCK > `const` **REGISTRANTS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REMOVE_ATTENDEE_ERROR_MOCK.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_ATTENDEE\_ERROR\_MOCK > `const` **REMOVE\_ATTENDEE\_ERROR\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REMOVE_ATTENDEE_SUCCESS_MOCK.md ================================================ [Admin Docs](/) *** # Variable: REMOVE\_ATTENDEE\_SUCCESS\_MOCK > `const` **REMOVE\_ATTENDEE\_SUCCESS\_MOCK**: `MockedResponse` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md ================================================ [Admin Docs](/) *** # Function: EventRegistrantsWrapper() > **EventRegistrantsWrapper**(`__namedParameters`): `Element` Defined in: [src/components/AdminPortal/EventRegistrantsModal/EventRegistrantsWrapper.tsx:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventRegistrantsModal/EventRegistrantsWrapper.tsx#L37) ## Parameters ### \_\_namedParameters [`InterfaceEventRegistrantsWrapperProps`](../../../../../types/AdminPortal/EventRegistrantsWrapper/interface/interfaces/InterfaceEventRegistrantsWrapperProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/Modal/AddOnSpot/AddOnSpotAttendee/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceAddOnSpotAttendeeProps`](../../../../../../../types/AdminPortal/EventRegistrantsModal/AddOnSpot/interfaces/InterfaceAddOnSpotAttendeeProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/Modal/EventRegistrantsModal/functions/EventRegistrantsModal.md ================================================ [Admin Docs](/) *** # Function: EventRegistrantsModal() > **EventRegistrantsModal**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`InterfaceEventRegistrantsModalProps`](../../../../../../types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceEventRegistrantsModalProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/Modal/InviteByEmail/InviteByEmailModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceInviteByEmailModalProps`](../../../../../../../types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface/interfaces/InterfaceInviteByEmailModalProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/LeftDrawer/LeftDrawer/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `ReactElement` Defined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L36) ## Parameters ### \_\_namedParameters [`ILeftDrawerProps`](../interfaces/ILeftDrawerProps.md) ## Returns `ReactElement` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/LeftDrawer/LeftDrawer/interfaces/ILeftDrawerProps.md ================================================ [Admin Docs](/) *** # Interface: ILeftDrawerProps Defined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L31) ## Properties ### hideDrawer > **hideDrawer**: `boolean` Defined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L32) *** ### setHideDrawer > **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L33) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgContriCards/OrgContriCards/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/AdminPortal/OrgContriCards/OrgContriCards.tsx:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgContriCards/OrgContriCards.tsx#L37) ## Parameters ### props [`InterfaceOrgContriCardsProps`](../../../../../types/AdminPortal/Contribution/interface/interfaces/InterfaceOrgContriCardsProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgPeopleListCard/OrgPeopleListCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/AdminPortal/OrgPeopleListCard/OrgPeopleListCard.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgPeopleListCard/OrgPeopleListCard.tsx#L45) ## Parameters ### props [`InterfaceOrgPeopleListCardProps`](../../../../../types/AdminPortal/Organization/interface/interfaces/InterfaceOrgPeopleListCardProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal/interfaces/IActionItemCategoryModal.md ================================================ [Admin Docs](/) *** # Interface: IActionItemCategoryModal Defined 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) ## Properties ### category > **category**: [`IActionItemCategoryInfo`](../../../../../../../types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryInfo.md) Defined 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) *** ### hide() > **hide**: () => `void` Defined 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) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined 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) *** ### mode > **mode**: `"create"` \| `"edit"` Defined 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) *** ### orgId > **orgId**: `string` Defined 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) *** ### refetchCategories() > **refetchCategories**: () => `void` Defined 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) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `FC`\<[`IActionItemCategoryModal`](../interfaces/IActionItemCategoryModal.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal/interfaces/ICategoryViewModalProps.md ================================================ [Admin Docs](/) *** # Interface: ICategoryViewModalProps Defined 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) ## Properties ### category > **category**: [`IActionItemCategoryInfo`](../../../../../../../types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryInfo.md) Defined 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) *** ### hide() > **hide**: () => `void` Defined 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) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `FC`\<[`ICategoryViewModalProps`](../interfaces/ICategoryViewModalProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategories/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `FC`\<`IActionItemCategoryProps`\> Defined 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) Represents the component for managing organization action item categories. This component allows creating, updating, enabling, and disabling action item categories. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `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`; \}; \}; \})[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_EMPTY.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_EMPTY > `const` **MOCKS\_EMPTY**: `object`[] Defined 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) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `ACTION_ITEM_CATEGORY_LIST` #### request.variables > **variables**: `object` #### request.variables.input > **input**: `object` #### request.variables.input.organizationId > **organizationId**: `string` = `'orgId'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.actionCategoriesByOrganization > **actionCategoriesByOrganization**: `any`[] = `[]` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_ERROR.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_ERROR > `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`; \}; \}; \}; \})[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/DeleteOrg/DeleteOrg/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined 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) A component for deleting an organization. It displays a card with a delete button. When the delete button is clicked, a modal appears asking for confirmation. Depending on the type of organization (sample or regular), it performs the delete operation and shows appropriate success or error messages. ## Returns `Element` JSX.Element - The rendered component with delete functionality. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/GeneralSettings/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `FC`\<`InterfaceGeneralSettingsProps`\> Defined 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) A component for displaying general settings for an organization. ## Param The properties passed to the component. ## Returns The `GeneralSettings` component. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdate/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined 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) Component for updating organization details. This component allows users to update the organization's name, description, address, visibility settings, and upload an image. It uses GraphQL mutations and queries to fetch and update data. ## Parameters ### props [`InterfaceOrgUpdateProps`](../../../../../../../types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceOrgUpdateProps.md) Component props containing the organization ID. ## Returns `Element` The rendered component. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/FIXED_UTC_TIMESTAMP.md ================================================ [Admin Docs](/) *** # Variable: FIXED\_UTC\_TIMESTAMP > `const` **FIXED\_UTC\_TIMESTAMP**: `"2025-01-01T10:00:00.000Z"` = `'2025-01-01T10:00:00.000Z'` Defined 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) Fixed UTC timestamp for deterministic tests. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `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`; \}; \}; \}; \})[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_QUERY_ERROR.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_QUERY\_ERROR > `const` **MOCKS\_QUERY\_ERROR**: `object`[] Defined 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) ## Type Declaration ### error > **error**: `Error` ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `GET_ORGANIZATION_BASIC_DATA` #### request.variables > **variables**: `object` #### request.variables.id > **id**: `string` = `'1'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_QUERY_ERROR_FETCH.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_QUERY\_ERROR\_FETCH > `const` **MOCKS\_QUERY\_ERROR\_FETCH**: `object`[] Defined 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) Query error with alternate message for "displays error message when query fails" test. ## Type Declaration ### error > **error**: `Error` ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `GET_ORGANIZATION_BASIC_DATA` #### request.variables > **variables**: `object` #### request.variables.id > **id**: `string` = `'1'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_UPDATE_ERROR.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_UPDATE\_ERROR > `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`; \})[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockOrgData.md ================================================ [Admin Docs](/) *** # Variable: mockOrgData > `const` **mockOrgData**: `object` Defined 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) ## Type Declaration ### organization > **organization**: `object` #### organization.\_\_typename > **\_\_typename**: `string` = `'Organization'` #### organization.addressLine1 > **addressLine1**: `string` = `'123 Test St'` #### organization.addressLine2 > **addressLine2**: `string` = `'Suite 100'` #### organization.avatarURL > **avatarURL**: `any` = `null` #### organization.city > **city**: `string` = `'Test City'` #### organization.countryCode > **countryCode**: `string` = `'US'` #### organization.createdAt > **createdAt**: `string` = `FIXED_UTC_TIMESTAMP` #### organization.description > **description**: `string` = `'Test Description'` #### organization.id > **id**: `string` = `'1'` #### organization.isUserRegistrationRequired > **isUserRegistrationRequired**: `boolean` = `false` #### organization.name > **name**: `string` = `'Test Org'` #### organization.postalCode > **postalCode**: `string` = `'12345'` #### organization.state > **state**: `string` = `'Test State'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockOrgDataWithEmptyFields.md ================================================ [Admin Docs](/) *** # Variable: mockOrgDataWithEmptyFields > `const` **mockOrgDataWithEmptyFields**: `object` Defined 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) Variant with empty address fields for mutation payload tests. ## Type Declaration ### organization > **organization**: `object` #### organization.\_\_typename > **\_\_typename**: `string` = `'Organization'` #### organization.addressLine1 > **addressLine1**: `string` = `'123 Test St'` #### organization.addressLine2 > **addressLine2**: `string` = `''` #### organization.avatarURL > **avatarURL**: `any` = `null` #### organization.city > **city**: `string` = `''` #### organization.countryCode > **countryCode**: `string` = `'US'` #### organization.createdAt > **createdAt**: `string` = `FIXED_UTC_TIMESTAMP` #### organization.description > **description**: `string` = `'Test Description'` #### organization.id > **id**: `string` = `'1'` #### organization.isUserRegistrationRequired > **isUserRegistrationRequired**: `boolean` = `false` #### organization.name > **name**: `string` = `'Test Org'` #### organization.postalCode > **postalCode**: `string` = `''` #### organization.state > **state**: `string` = `'Test State'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockOrgDataWithNullUserReg.md ================================================ [Admin Docs](/) *** # Variable: mockOrgDataWithNullUserReg > `const` **mockOrgDataWithNullUserReg**: `object` Defined 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) Variant with null isUserRegistrationRequired for switch default tests. ## Type Declaration ### organization > **organization**: `object` #### organization.\_\_typename > **\_\_typename**: `string` = `'Organization'` #### organization.addressLine1 > **addressLine1**: `string` = `'123 Test St'` #### organization.addressLine2 > **addressLine2**: `string` = `'Suite 100'` #### organization.avatarURL > **avatarURL**: `any` = `null` #### organization.city > **city**: `string` = `'Test City'` #### organization.countryCode > **countryCode**: `string` = `'US'` #### organization.createdAt > **createdAt**: `string` = `FIXED_UTC_TIMESTAMP` #### organization.description > **description**: `string` = `'Test Description'` #### organization.id > **id**: `string` = `'1'` #### organization.isUserRegistrationRequired > **isUserRegistrationRequired**: `any` = `null` #### organization.name > **name**: `string` = `'Test Org'` #### organization.postalCode > **postalCode**: `string` = `'12345'` #### organization.state > **state**: `string` = `'Test State'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockUpdateOrgResponse.md ================================================ [Admin Docs](/) *** # Variable: mockUpdateOrgResponse > `const` **mockUpdateOrgResponse**: `object` Defined 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) Shared updateOrganization mutation response for test mocks; derives from mockOrgData.organization with mutation-specific fields. ## Type Declaration ### \_\_typename > **\_\_typename**: `"Organization"` ### addressLine1 > **addressLine1**: `string` = `'123 Test St'` ### addressLine2 > **addressLine2**: `string` = `'Suite 100'` ### avatarMimeType > **avatarMimeType**: `any` = `null` ### avatarURL > **avatarURL**: `any` = `null` ### city > **city**: `string` = `'Test City'` ### countryCode > **countryCode**: `string` = `'US'` ### createdAt > **createdAt**: `string` = `FIXED_UTC_TIMESTAMP` ### description > **description**: `string` = `'Test Description'` ### id > **id**: `string` = `'1'` ### isUserRegistrationRequired > **isUserRegistrationRequired**: `boolean` = `false` ### name > **name**: `string` = `'Test Org'` ### postalCode > **postalCode**: `string` = `'12345'` ### state > **state**: `string` = `'Test State'` ### updatedAt > **updatedAt**: `string` = `FIXED_UTC_TIMESTAMP` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/CardItem/CardItem/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined 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) ## Parameters ### props [`InterfaceCardItem`](../../../../../../types/AdminPortal/OrganizationDashCards/CardItem/interface/interfaces/InterfaceCardItem.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/CardItem/Loader/CardItemLoading/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined 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) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/DashboardCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/AdminPortal/OrganizationDashCards/DashboardCard.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationDashCards/DashboardCard.tsx#L34) ## Parameters ### props #### count? `number` #### icon `ReactNode` #### title `string` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/Loader/DashboardCardLoading/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined 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) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrganizationScreen/OrganizationScreen/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx#L44) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/OrganizationScreen/OrganizationScreen/variables/translationKeyMap.md ================================================ [Admin Docs](/) *** # Variable: translationKeyMap > `const` **translationKeyMap**: [`InterfaceMapType`](../../../../../utils/interfaces/interfaces/InterfaceMapType.md) Defined in: [src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx#L171) Mapping object to get translation keys based on route ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/SecuredRoute/SecuredRoute/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/AdminPortal/SecuredRoute/SecuredRoute.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/SecuredRoute/SecuredRoute.tsx#L40) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/SuperAdminScreen/SuperAdminScreen/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `ReactElement` Defined in: [src/components/AdminPortal/SuperAdminScreen/SuperAdminScreen.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/SuperAdminScreen/SuperAdminScreen.tsx#L31) ## Returns `ReactElement` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/TagActions/Node/TagNode/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<`InterfaceTagNodeProps`\> Defined 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) Renders the Tags which can be expanded to list subtags. ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/TagActions/Node/TagNodeMocks/variables/MOCKS1.md ================================================ [Admin Docs](/) *** # Variable: MOCKS1 > `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`; \}; \}; \}; \}; \}; \})[] Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/TagActions/Node/TagNodeMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY1.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_ERROR\_SUBTAGS\_QUERY1 > `const` **MOCKS\_ERROR\_SUBTAGS\_QUERY1**: `object`[] Defined 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) ## Type Declaration ### error > **error**: `Error` ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `USER_TAG_SUB_TAGS` #### request.variables > **variables**: `object` #### request.variables.first > **first**: `number` = `10` #### request.variables.id > **id**: `string` = `'1'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/TagActions/TagActions/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceTagActionsProps`](../../../../../types/AdminPortal/TagActions/interface/interfaces/InterfaceTagActionsProps.md)\> Defined in: [src/components/AdminPortal/TagActions/TagActions.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActions.tsx#L60) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/TagActions/TagActionsMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `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`; \}; \}; \}; \})[] Defined in: [src/components/AdminPortal/TagActions/TagActionsMocks.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActionsMocks.ts#L116) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/TagActions/TagActionsMocks/variables/MOCKS_ERROR_ASSIGN_OR_REMOVAL_TAGS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_ERROR\_ASSIGN\_OR\_REMOVAL\_TAGS > `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`; \})[] Defined in: [src/components/AdminPortal/TagActions/TagActionsMocks.ts:406](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActionsMocks.ts#L406) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/TagActions/TagActionsMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY.md ================================================ [Admin Docs](/) *** # Variable: MOCKS\_ERROR\_SUBTAGS\_QUERY > `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`; \})[] Defined in: [src/components/AdminPortal/TagActions/TagActionsMocks.ts:359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActionsMocks.ts#L359) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/UpdateSession/UpdateSession/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceUpdateSessionProps`](../../../../../types/AdminPortal/UpdateSession/interface/interfaces/InterfaceUpdateSessionProps.md)\> Defined in: [src/components/AdminPortal/UpdateSession/UpdateSession.tsx:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/UpdateSession/UpdateSession.tsx#L48) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/UserTableRow/UserTableRow/variables/UserTableRow.md ================================================ [Admin Docs](/) *** # Variable: UserTableRow > `const` **UserTableRow**: `React.FC`\<[`InterfaceUserTableRowProps`](../../../../../types/AdminPortal/UserTableRow/interface/interfaces/InterfaceUserTableRowProps.md)\> Defined in: [src/components/AdminPortal/UserTableRow/UserTableRow.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/UserTableRow/UserTableRow.tsx#L50) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Venues/Modal/VenueModal/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`InterfaceVenueModalProps`](../interfaces/InterfaceVenueModalProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Venues/Modal/VenueModal/interfaces/InterfaceVenueModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVenueModalProps Defined 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) ## Properties ### edit > **edit**: `boolean` Defined 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) *** ### onHide() > **onHide**: () => `void` Defined 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) #### Returns `void` *** ### orgId > **orgId**: `string` Defined 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) *** ### refetchVenues() > **refetchVenues**: () => `void` Defined 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) #### Returns `void` *** ### show > **show**: `boolean` Defined 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) *** ### venueData? > `optional` **venueData**: [`InterfaceQueryVenueListItem`](../../../../../../utils/interfaces/interfaces/InterfaceQueryVenueListItem.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Venues/VenueCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/AdminPortal/Venues/VenueCard.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCard.tsx#L46) ## Parameters ### \_\_namedParameters `InterfaceVenueCardProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Venues/VenueCardMocks/variables/MOCK_VENUE_ITEM.md ================================================ [Admin Docs](/) *** # Variable: MOCK\_VENUE\_ITEM > `const` **MOCK\_VENUE\_ITEM**: `object` Defined in: [src/components/AdminPortal/Venues/VenueCardMocks.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCardMocks.ts#L1) ## Type Declaration ### node > **node**: `object` #### node.capacity > **capacity**: `number` = `500` #### node.description > **description**: `string` = `'A spacious venue for large events.'` #### node.id > **id**: `string` = `'1'` #### node.image > **image**: `any` = `null` #### node.name > **name**: `string` = `'Grand Hall'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Venues/VenueCardMocks/variables/MOCK_VENUE_ITEM_LONG_TEXT.md ================================================ [Admin Docs](/) *** # Variable: MOCK\_VENUE\_ITEM\_LONG\_TEXT > `const` **MOCK\_VENUE\_ITEM\_LONG\_TEXT**: `object` Defined in: [src/components/AdminPortal/Venues/VenueCardMocks.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCardMocks.ts#L26) ## Type Declaration ### node > **node**: `object` #### node.capacity > **capacity**: `number` = `300` #### node.description > **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.'` #### node.id > **id**: `string` = `'4'` #### node.image > **image**: `any` = `null` #### node.name > **name**: `string` = `'This is a very long venue name that should definitely be truncated in the display'` ================================================ FILE: docs/docs/auto-docs/components/AdminPortal/Venues/VenueCardMocks/variables/MOCK_VENUE_ITEM_WITH_IMAGE.md ================================================ [Admin Docs](/) *** # Variable: MOCK\_VENUE\_ITEM\_WITH\_IMAGE > `const` **MOCK\_VENUE\_ITEM\_WITH\_IMAGE**: `object` Defined in: [src/components/AdminPortal/Venues/VenueCardMocks.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCardMocks.ts#L11) ## Type Declaration ### node > **node**: `object` #### node.attachments > **attachments**: `object`[] #### node.capacity > **capacity**: `number` = `200` #### node.description > **description**: `string` = `'A modern conference room with all amenities.'` #### node.id > **id**: `string` = `'2'` #### node.name > **name**: `string` = `'Conference Room'` ================================================ FILE: docs/docs/auto-docs/components/Auth/LoginForm/LoginForm/variables/LoginForm.md ================================================ [Admin Docs](/) *** # Variable: LoginForm > `const` **LoginForm**: `React.FC`\<[`InterfaceLoginFormProps`](../../../../../types/Auth/LoginForm/interface/interfaces/InterfaceLoginFormProps.md)\> Defined in: [src/components/Auth/LoginForm/LoginForm.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/LoginForm/LoginForm.tsx#L40) Reusable login form component that composes EmailField and PasswordField. ## Remarks This component handles the login form UI and submission logic, delegating authentication to the SIGNIN_QUERY GraphQL query. It supports both admin and user login modes via the isAdmin prop. ## Param Whether the login form is rendered for an admin user ## Param Callback invoked with the full sign-in result (user + tokens) ## Param Callback invoked when the login request fails ## Param Optional test ID used for querying the component in tests ## Returns A JSX element rendering the login form ## Example ```tsx console.log('Logged in:', token)} onError={(error) => console.error('Login failed:', error)} /> ``` ================================================ FILE: docs/docs/auto-docs/components/Auth/OAuthButton/OAuthButton/type-aliases/OAuthMode.md ================================================ [Admin Docs](/) *** # Type Alias: OAuthMode > **OAuthMode** = `"login"` \| `"register"` \| `"link"` Defined in: [src/components/Auth/OAuthButton/OAuthButton.tsx:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OAuthButton/OAuthButton.tsx#L10) Defines the authentication mode for OAuth operations. ================================================ FILE: docs/docs/auto-docs/components/Auth/OAuthButton/OAuthButton/type-aliases/OAuthSize.md ================================================ [Admin Docs](/) *** # Type Alias: OAuthSize > **OAuthSize** = `"sm"` \| `"md"` \| `"lg"` Defined in: [src/components/Auth/OAuthButton/OAuthButton.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OAuthButton/OAuthButton.tsx#L15) Defines the size variants for the OAuth button. ================================================ FILE: docs/docs/auto-docs/components/Auth/OAuthButton/OAuthButton/variables/OAuthButton.md ================================================ [Admin Docs](/) *** # Variable: OAuthButton > `const` **OAuthButton**: `React.FC`\<`Props`\> Defined in: [src/components/Auth/OAuthButton/OAuthButton.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OAuthButton/OAuthButton.tsx#L51) A customizable OAuth authentication button component that supports multiple providers. ## Param The component props ## Returns A styled OAuth button with provider-specific branding ## Example ```tsx ``` ================================================ FILE: docs/docs/auto-docs/components/Auth/OrgSelector/OrgSelector/variables/OrgSelector.md ================================================ [Admin Docs](/) *** # Variable: OrgSelector > `const` **OrgSelector**: `React.FC`\<[`InterfaceOrgSelectorProps`](../../../../../types/Auth/OrgSelector/interface/interfaces/InterfaceOrgSelectorProps.md)\> Defined in: [src/components/Auth/OrgSelector/OrgSelector.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OrgSelector/OrgSelector.tsx#L26) Reusable organization selector component with search/autocomplete and accessibility support. ## Remarks This component provides a searchable dropdown for selecting an organization from a list. It supports search/autocomplete, error display, required field indication, and proper ARIA attributes for accessibility. ## Example ```tsx ``` ================================================ FILE: docs/docs/auto-docs/components/Auth/PasswordStrengthIndicator/PasswordStrengthIndicator/variables/PasswordStrengthIndicator.md ================================================ [Admin Docs](/) *** # Variable: PasswordStrengthIndicator > `const` **PasswordStrengthIndicator**: `React.FC`\<[`InterfacePasswordStrengthIndicatorProps`](../../../../../types/Auth/PasswordStrengthIndicator/interface/interfaces/InterfacePasswordStrengthIndicatorProps.md)\> Defined in: [src/components/Auth/PasswordStrengthIndicator/PasswordStrengthIndicator.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/PasswordStrengthIndicator/PasswordStrengthIndicator.tsx#L17) PasswordStrengthIndicator displays a visual checklist of password requirements. ## Remarks Shows real-time feedback for password complexity requirements including minimum length, lowercase, uppercase, numeric, and special characters. ## Param Component props ## Returns Password strength indicator or null if not visible ================================================ FILE: docs/docs/auto-docs/components/Auth/PasswordStrengthIndicator/RequirementRow/variables/RequirementRow.md ================================================ [Admin Docs](/) *** # Variable: RequirementRow > `const` **RequirementRow**: `React.FC`\<`InterfaceRequirementRowProps`\> Defined in: [src/components/Auth/PasswordStrengthIndicator/RequirementRow.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/PasswordStrengthIndicator/RequirementRow.tsx#L19) Row component to display a single password requirement with status indicator. ## Param Component props ## Returns A div with colored text and checkmark/X indicator ================================================ FILE: docs/docs/auto-docs/components/Auth/RegistrationForm/RegistrationForm/functions/RegistrationForm.md ================================================ [Admin Docs](/) *** # Function: RegistrationForm() > **RegistrationForm**(`__namedParameters`): `Element` Defined in: [src/components/Auth/RegistrationForm/RegistrationForm.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/RegistrationForm/RegistrationForm.tsx#L27) RegistrationForm component for user registration with validation and reCAPTCHA support ## Parameters ### \_\_namedParameters [`IRegistrationFormProps`](../../../../../types/Auth/RegistrationForm/interface/interfaces/IRegistrationFormProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/Auth/theme/oauthBrand/functions/brandForProvider.md ================================================ [Admin Docs](/) *** # Function: brandForProvider() > **brandForProvider**(`provider`): `InterfaceProviderBrand` Defined in: [src/components/Auth/theme/oauthBrand.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/theme/oauthBrand.tsx#L49) Retrieves the branding configuration for a specific OAuth provider. ## Parameters ### provider [`OAuthProviderKey`](../../../../../types/Auth/auth/type-aliases/OAuthProviderKey.md) The provider key (e.g., 'GOOGLE', 'GITHUB') ## Returns `InterfaceProviderBrand` The branding configuration for the provider, or Google branding as fallback ## Example ```tsx const googleBrand = brandForProvider('GOOGLE'); console.log(googleBrand.displayName); // 'Google' ``` ================================================ FILE: docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx#L32) ## Parameters ### props [`InterfaceDropDownProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L50) ## Parameters ### \_\_namedParameters [`InterfaceCollapsibleDropdown`](../../../../types/DropDown/interface/interfaces/InterfaceCollapsibleDropdown.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/CursorPaginationManager/CursorPaginationManager/functions/CursorPaginationManager.md ================================================ [Admin Docs](/) *** # Function: CursorPaginationManager() > **CursorPaginationManager**\<`TData`, `TNode`, `TVariables`\>(`props`): `ReactElement` Defined in: [src/components/CursorPaginationManager/CursorPaginationManager.tsx:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CursorPaginationManager/CursorPaginationManager.tsx#L128) CursorPaginationManager - A reusable component for cursor-based pagination Manages cursor-based pagination state and integrates with Apollo Client. Extracts data from nested GraphQL responses and provides "Load More" functionality. ## Type Parameters ### TData `TData` The complete GraphQL query response type ### TNode `TNode` The type of individual items ### TVariables `TVariables` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> The GraphQL query variables type ## Parameters ### props [`InterfaceCursorPaginationManagerProps`](../../../../types/CursorPagination/interface/interfaces/InterfaceCursorPaginationManagerProps.md)\<`TData`, `TNode`, `TVariables`\> ## Returns `ReactElement` ## Example ```tsx import { CursorPaginationManager } from 'components/CursorPaginationManager/CursorPaginationManager'; import { gql } from '@apollo/client'; const GET_USERS_QUERY = gql` query GetUsers($first: Int!, $after: String) { users(first: $first, after: $after) { edges { cursor node { id name email } } pageInfo { hasNextPage hasPreviousPage startCursor endCursor } } } `; function UsersList() { return ( (

{user.name}

{user.email}

)} /> ); } ``` ## Remarks **Integration Requirements:** - GraphQL query MUST follow Relay cursor pagination spec (edges, node, pageInfo) - Query MUST accept `first: Int!` and `after: String` variables - pageInfo MUST include: hasNextPage, hasPreviousPage, startCursor, endCursor - Use `dataPath` prop to specify where connection data is in response (e.g., "users" or "organization.members") **Features:** - Automatic loading, empty, and error states using shared components - "Load More" button with cursor-based pagination - Manual refetch via `refetchTrigger` prop - Custom loading/empty states via props - Data change callbacks via `onDataChange` ================================================ FILE: docs/docs/auto-docs/components/EventCalender/EventCalenderMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `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`; \}; \}; \}; \})[] Defined in: [src/components/EventCalender/EventCalenderMocks.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/EventCalenderMocks.ts#L77) ================================================ FILE: docs/docs/auto-docs/components/EventCalender/EventCalenderMocks/variables/eventData.md ================================================ [Admin Docs](/) *** # Variable: eventData > `const` **eventData**: `object`[] Defined in: [src/components/EventCalender/EventCalenderMocks.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/EventCalenderMocks.ts#L10) ## Type Declaration ### allDay > **allDay**: `boolean` = `false` ### attendees > **attendees**: `any`[] = `[]` ### creator > **creator**: `object` #### creator.id > **id**: `string` = `'1'` #### creator.name > **name**: `string` = `'Creator 1'` ### description > **description**: `string` = `'This is event 1'` ### endAt > **endAt**: `string` ### endTime > **endTime**: `string` = `'12:00'` ### id > **id**: `string` = `'1'` ### isInviteOnly > **isInviteOnly**: `boolean` = `false` ### isPublic > **isPublic**: `boolean` = `true` ### isRegisterable > **isRegisterable**: `boolean` = `true` ### location > **location**: `string` = `'New York'` ### name > **name**: `string` = `'Event 1'` ### startAt > **startAt**: `string` ### startTime > **startTime**: `string` = `'10:00'` ================================================ FILE: docs/docs/auto-docs/components/EventCalender/Header/EventHeader/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/EventCalender/Header/EventHeader.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/Header/EventHeader.tsx#L40) ## Parameters ### \_\_namedParameters [`IEventHeaderProps`](../../../../../types/Event/interface/interfaces/IEventHeaderProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/EventCalender/Monthly/EventCalender/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceCalendarProps`](../../../../../types/Event/interface/type-aliases/InterfaceCalendarProps.md) & `object`\> Defined in: [src/components/EventCalender/Monthly/EventCalender.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/Monthly/EventCalender.tsx#L56) ================================================ FILE: docs/docs/auto-docs/components/EventCalender/Yearly/YearlyEventCalender/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceCalendarProps`](../../../../../types/Event/interface/type-aliases/InterfaceCalendarProps.md)\> Defined in: [src/components/EventCalender/Yearly/YearlyEventCalender.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/Yearly/YearlyEventCalender.tsx#L49) ================================================ FILE: docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreen/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/EventDashboardScreen/EventDashboardScreen.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventDashboardScreen/EventDashboardScreen.tsx#L43) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreenMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `const` **MOCKS**: `object`[] Defined in: [src/components/EventDashboardScreen/EventDashboardScreenMocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventDashboardScreen/EventDashboardScreenMocks.ts#L3) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `ORGANIZATIONS_LIST` #### request.variables > **variables**: `object` #### request.variables.id > **id**: `string` = `'123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.organizations > **organizations**: `object`[] ================================================ FILE: docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/diverseRatingsProps.md ================================================ [Admin Docs](/) *** # Variable: diverseRatingsProps > `const` **diverseRatingsProps**: `object` Defined in: [src/components/EventStats/EventStatsMocks.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L113) ## Type Declaration ### data > **data**: `object` #### data.event > **event**: `object` #### data.event.\_id > **\_id**: `string` = `'123'` #### data.event.averageFeedbackScore > **averageFeedbackScore**: `number` = `2.4` #### data.event.feedback > **feedback**: `object`[] ================================================ FILE: docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/emptyProps.md ================================================ [Admin Docs](/) *** # Variable: emptyProps > `const` **emptyProps**: `object` Defined in: [src/components/EventStats/EventStatsMocks.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L103) ## Type Declaration ### data > **data**: `object` #### data.event > **event**: `object` #### data.event.\_id > **\_id**: `string` = `'123'` #### data.event.averageFeedbackScore > **averageFeedbackScore**: `number` = `0` #### data.event.feedback > **feedback**: `any`[] = `[]` ================================================ FILE: docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/mockData.md ================================================ [Admin Docs](/) *** # Variable: mockData > `const` **mockData**: `object`[] Defined in: [src/components/EventStats/EventStatsMocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L3) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `EVENT_FEEDBACKS` #### request.variables > **variables**: `object` #### request.variables.id > **id**: `string` = `'eventStats123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.event > **event**: `object` #### result.data.event.\_id > **\_id**: `string` = `'eventStats123'` #### result.data.event.averageFeedbackScore > **averageFeedbackScore**: `number` = `5` #### result.data.event.feedback > **feedback**: `object`[] ================================================ FILE: docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/nonEmptyProps.md ================================================ [Admin Docs](/) *** # Variable: nonEmptyProps > `const` **nonEmptyProps**: `object` Defined in: [src/components/EventStats/EventStatsMocks.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L71) ## Type Declaration ### data > **data**: `object` #### data.event > **event**: `object` #### data.event.\_id > **\_id**: `string` = `'123'` #### data.event.averageFeedbackScore > **averageFeedbackScore**: `number` = `5` #### data.event.feedback > **feedback**: `object`[] ================================================ FILE: docs/docs/auto-docs/components/EventStats/Statistics/AverageRating/AverageRating/functions/AverageRating.md ================================================ [Admin Docs](/) *** # Function: AverageRating() > **AverageRating**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`IStatsModal`](../../../../../../types/Event/interface/interfaces/IStatsModal.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/EventStats/Statistics/EventStats/functions/EventStats.md ================================================ [Admin Docs](/) *** # Function: EventStats() > **EventStats**(`__namedParameters`): `Element` Defined in: [src/components/EventStats/Statistics/EventStats.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/EventStats.tsx#L50) ## Parameters ### \_\_namedParameters `ModalPropType` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/EventStats/Statistics/Feedback/Feedback/functions/FeedbackStats.md ================================================ [Admin Docs](/) *** # Function: FeedbackStats() > **FeedbackStats**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`IStatsModal`](../../../../../../types/Event/interface/interfaces/IStatsModal.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/EventStats/Statistics/Review/Review/functions/ReviewStats.md ================================================ [Admin Docs](/) *** # Function: ReviewStats() > **ReviewStats**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`IStatsModal`](../../../../../../types/Event/interface/interfaces/IStatsModal.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/HolidayCards/HolidayCard.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/HolidayCards/HolidayCard.tsx#L25) ## Parameters ### props `InterfaceHolidayList` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/IconComponent/IconComponent.tsx:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L66) ## Parameters ### props [`IIconComponent`](../interfaces/IIconComponent.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/IIconComponent.md ================================================ [Admin Docs](/) *** # Interface: IIconComponent Defined in: [src/components/IconComponent/IconComponent.tsx:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L59) ## Properties ### fill? > `optional` **fill**: `string` Defined in: [src/components/IconComponent/IconComponent.tsx:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L61) *** ### height? > `optional` **height**: `string` Defined in: [src/components/IconComponent/IconComponent.tsx:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L62) *** ### name > **name**: `string` Defined in: [src/components/IconComponent/IconComponent.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L60) *** ### width? > `optional` **width**: `string` Defined in: [src/components/IconComponent/IconComponent.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L63) ================================================ FILE: docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`orgId`): `ReactElement` Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L66) LeftDrawerOrg component for displaying organization details and options. ## Parameters ### orgId [`ILeftDrawerProps`](../interfaces/ILeftDrawerProps.md) ID of the current organization. ## Returns `ReactElement` JSX element for the left navigation drawer with organization details. ================================================ FILE: docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/ILeftDrawerProps.md ================================================ [Admin Docs](/) *** # Interface: ILeftDrawerProps Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L50) ## Properties ### hideDrawer > **hideDrawer**: `boolean` Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L53) *** ### orgId > **orgId**: `string` Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L51) *** ### setHideDrawer > **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L54) *** ### targets > **targets**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md)[] Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L52) ================================================ FILE: docs/docs/auto-docs/components/NotificationIcon/NotificationIcon/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/NotificationIcon/NotificationIcon.tsx:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/NotificationIcon/NotificationIcon.tsx#L36) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/Pagination/Navigator/Pagination/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/Pagination/Navigator/Pagination.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Pagination/Navigator/Pagination.tsx#L49) ## Parameters ### props `InterfaceTablePaginationActionsProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/ProfileCard/ProfileCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/ProfileCard/ProfileCard.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ProfileCard/ProfileCard.tsx#L52) ## Parameters ### \_\_namedParameters [`InterfaceProfileCardProps`](../../../../types/shared-components/ProfileCard/interface/interfaces/InterfaceProfileCardProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/ProfileDropdown/ProfileDropdown/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/ProfileDropdown/ProfileDropdown.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ProfileDropdown/ProfileDropdown.tsx#L50) ## Parameters ### \_\_namedParameters [`InterfaceProfileDropdownProps`](../../../../types/shared-components/ProfileDropdown/interface/interfaces/InterfaceProfileDropdownProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/SignOut/SignOut/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/SignOut/SignOut.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/SignOut/SignOut.tsx#L51) ## Parameters ### \_\_namedParameters `ISignOutProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserDetails/UserEvents/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`PeopleTabUserEventsProps`](../../../../types/AdminPortal/UserDetails/UserEvent/type/type-aliases/PeopleTabUserEventsProps.md)\> Defined in: [src/components/UserDetails/UserEvents.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserDetails/UserEvents.tsx#L51) ================================================ FILE: docs/docs/auto-docs/components/UserDetails/UserOrganizations/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceUserOrganizationsProps`](../../../../types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceUserOrganizationsProps.md)\> Defined in: [src/components/UserDetails/UserOrganizations.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserDetails/UserOrganizations.tsx#L54) ================================================ FILE: docs/docs/auto-docs/components/UserDetails/UserTags/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserDetails/UserTags.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserDetails/UserTags.tsx#L52) ## Parameters ### \_\_namedParameters [`InterfaceUserTagsProps`](../../../../types/AdminPortal/UserDetails/UserTags/type/type-aliases/InterfaceUserTagsProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/ChatHeader/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserPortal/ChatRoom/ChatHeader.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/ChatHeader.tsx#L30) ## Parameters ### \_\_namedParameters [`InterfaceChatHeaderProps`](../../types/interfaces/InterfaceChatHeaderProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/ChatRoom/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/components/UserPortal/ChatRoom/ChatRoom.tsx:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/ChatRoom.tsx#L55) ## Parameters ### props `IChatRoomProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/EmptyChatState/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserPortal/ChatRoom/EmptyChatState.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/EmptyChatState.tsx#L17) ## Parameters ### \_\_namedParameters [`InterfaceEmptyChatStateProps`](../../../../../types/UserPortal/EmptyChatState/interface/interfaces/InterfaceEmptyChatStateProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/MessageImage/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `MemoExoticComponent`\<(`__namedParameters`) => `Element`\> Defined in: [src/components/UserPortal/ChatRoom/MessageImage.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/MessageImage.tsx#L38) ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/MessageInput/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserPortal/ChatRoom/MessageInput.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/MessageInput.tsx#L60) ## Parameters ### \_\_namedParameters `IMessageInputProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/MessageItem/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserPortal/ChatRoom/MessageItem.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/MessageItem.tsx#L56) ## Parameters ### \_\_namedParameters `IMessageItemProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/types/interfaces/INewChat.md ================================================ [Admin Docs](/) *** # Interface: INewChat Defined in: [src/components/UserPortal/ChatRoom/types.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L26) Chat Types This file defines TypeScript interfaces for the chat room functionality. It includes type definitions for chat entities, members, messages, and pagination. ## Remarks - INewChat: Main interface representing a chat entity. - Supports both direct messages and group chats. - Includes pagination information for messages. ## Example ```ts const chat: INewChat = { id: 'chat123', name: 'Group Chat', isGroup: true, createdAt: '2024-01-01T00:00:00Z', updatedAt: '2024-01-01T00:00:00Z', members: { edges: [...] }, messages: { edges: [...], pageInfo: {...} } }; ``` ## Properties ### avatarMimeType? > `optional` **avatarMimeType**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L30) *** ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L31) *** ### createdAt > **createdAt**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L33) *** ### creator? > `optional` **creator**: `object` Defined in: [src/components/UserPortal/ChatRoom/types.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L40) #### avatarMimeType? > `optional` **avatarMimeType**: `string` #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### description? > `optional` **description**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L29) *** ### id > **id**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L27) *** ### isGroup > **isGroup**: `boolean` Defined in: [src/components/UserPortal/ChatRoom/types.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L32) *** ### members > **members**: `object` Defined in: [src/components/UserPortal/ChatRoom/types.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L52) #### edges > **edges**: `object`[] *** ### messages > **messages**: `object` Defined in: [src/components/UserPortal/ChatRoom/types.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L66) #### edges > **edges**: `object`[] #### pageInfo > **pageInfo**: `object` ##### pageInfo.endCursor > **endCursor**: `string` ##### pageInfo.hasNextPage > **hasNextPage**: `boolean` ##### pageInfo.hasPreviousPage > **hasPreviousPage**: `boolean` ##### pageInfo.startCursor > **startCursor**: `string` *** ### name > **name**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L28) *** ### organization? > `optional` **organization**: `object` Defined in: [src/components/UserPortal/ChatRoom/types.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L35) #### countryCode? > `optional` **countryCode**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### updatedAt > **updatedAt**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L34) *** ### updater? > `optional` **updater**: `object` Defined in: [src/components/UserPortal/ChatRoom/types.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L46) #### avatarMimeType? > `optional` **avatarMimeType**: `string` #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ChatRoom/types/interfaces/InterfaceChatHeaderProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceChatHeaderProps Defined in: [src/components/UserPortal/ChatRoom/types.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L100) ## Properties ### chatImage > **chatImage**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L101) *** ### chatSubtitle > **chatSubtitle**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L103) *** ### chatTitle > **chatTitle**: `string` Defined in: [src/components/UserPortal/ChatRoom/types.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L102) *** ### isGroup? > `optional` **isGroup**: `boolean` Defined in: [src/components/UserPortal/ChatRoom/types.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L104) *** ### onGroupClick()? > `optional` **onGroupClick**: () => `void` Defined in: [src/components/UserPortal/ChatRoom/types.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L105) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/CommentCard/CommentCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`id`): `Element` Defined in: [src/components/UserPortal/CommentCard/CommentCard.tsx:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/CommentCard/CommentCard.tsx#L72) CommentCard Component This component represents a card displaying a comment with the ability to like or dislike it. It shows the comment creator's details, the comment text, and the like/dislike counts. ## Parameters ### id [`InterfaceCommentCardProps`](../../../../../types/UserPortal/CommentCard/interface/interfaces/InterfaceCommentCardProps.md) The unique identifier of the comment. ## Returns `Element` JSX element representing the comment card. ================================================ FILE: docs/docs/auto-docs/components/UserPortal/ContactCard/ContactCard/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceContactCardProps`](../../../../../types/UserPortal/Chat/interface/interfaces/InterfaceContactCardProps.md)\> Defined in: [src/components/UserPortal/ContactCard/ContactCard.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ContactCard/ContactCard.tsx#L46) ================================================ FILE: docs/docs/auto-docs/components/UserPortal/CreateDirectChat/CreateDirectChat/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx#L137) ## Parameters ### \_\_namedParameters [`InterfaceCreateDirectChatProps`](../../../../../types/UserPortal/CreateDirectChat/interface/interfaces/InterfaceCreateDirectChatProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/CreateGroupChat/CreateGroupChat/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserPortal/CreateGroupChat/CreateGroupChat.tsx:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/CreateGroupChat/CreateGroupChat.tsx#L82) ## Parameters ### \_\_namedParameters `InterfaceCreateGroupChatProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/DonationCard/DonationCard/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceDonationCardProps`](../../../../../types/UserPortal/Donation/interface/interfaces/InterfaceDonationCardProps.md)\> Defined in: [src/components/UserPortal/DonationCard/DonationCard.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/DonationCard/DonationCard.tsx#L33) ================================================ FILE: docs/docs/auto-docs/components/UserPortal/EventCard/EventCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`id`): `Element` Defined in: [src/components/UserPortal/EventCard/EventCard.tsx:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/EventCard/EventCard.tsx#L72) EventCard Component This component renders a card displaying details of an event, including its name, description, location, start and end times, and the creator's name. It also provides functionality for users to register for the event. ## Parameters ### id [`InterfaceEventCardProps`](../../../../../types/UserPortal/EventCard/interface/interfaces/InterfaceEventCardProps.md) Event identifier. ## Returns `Element` JSX.Element - A styled card displaying event details and a registration button. Dependencies - `@mui/icons-material` for icons. - `dayjs` for date and time formatting. - `shared-components/Button` for button UI. - `@apollo/client` for GraphQL mutations. - `NotificationToast` for notifications. - `utils/useLocalstorage` for local storage handling. ## Remarks - The component uses the `useTranslation` hook for internationalization. - It retrieves the user ID from local storage to determine if the user is already registered for the event. - The `useMutation` hook from Apollo Client is used to handle event registration. - The `NotificationToast` utility is used to display success or error messages. Component ## Example ```tsx ``` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetails/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetails.tsx:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetails.tsx#L85) ## Parameters ### \_\_namedParameters [`InterfaceGroupChatDetailsProps`](../../../../../types/UserPortal/Chat/interface/interfaces/InterfaceGroupChatDetailsProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/delayedMocks.md ================================================ [Admin Docs](/) *** # Variable: delayedMocks > `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`; \}; \}; \})[] Defined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:627](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L627) Delayed mocks to simulate network latency for loading states testing ================================================ FILE: docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/failingMocks.md ================================================ [Admin Docs](/) *** # Variable: failingMocks > `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`; \}; \}; \}; \}; \}; \})[] Defined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:534](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L534) ================================================ FILE: docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/filledMockChat.md ================================================ [Admin Docs](/) *** # Variable: filledMockChat > `const` **filledMockChat**: [`Chat`](../../../../../types/UserPortal/Chat/interface/type-aliases/Chat.md) Defined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L197) ================================================ FILE: docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/incompleteMockChat.md ================================================ [Admin Docs](/) *** # Variable: incompleteMockChat > `const` **incompleteMockChat**: [`Chat`](../../../../../types/UserPortal/Chat/interface/type-aliases/Chat.md) Defined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L204) ================================================ FILE: docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/mocks.md ================================================ [Admin Docs](/) *** # Variable: mocks > `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`; \}; \}; \})[] Defined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L212) ================================================ FILE: docs/docs/auto-docs/components/UserPortal/OrganizationSidebar/OrganizationSidebar/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/UserPortal/OrganizationSidebar/OrganizationSidebar.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/OrganizationSidebar/OrganizationSidebar.tsx#L45) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser.tsx:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser.tsx#L42) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/UserNavbar/UserNavbar/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/components/UserPortal/UserNavbar/UserNavbar.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/UserNavbar/UserNavbar.tsx#L63) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/components/UserPortal/UserPortalCard/UserPortalCard/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceUserPortalCardProps`](../../../../../types/UserPortal/UserPortalCard/interface/interfaces/InterfaceUserPortalCardProps.md)\> Defined in: [src/components/UserPortal/UserPortalCard/UserPortalCard.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/UserPortalCard/UserPortalCard.tsx#L34) UserPortalCard Reusable 3-section layout wrapper for User Portal cards. Structure: [ imageSlot ] [ content (children) ] [ actionsSlot ] Responsibilities: - Centralizes spacing and alignment logic - Supports density variants (compact / standard / expanded) - Remains content-agnostic and styling-agnostic Accessibility: - role="group" - aria-label provided by consumer (i18n required) ## Example ```tsx } actionsSlot={ } > ``` ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/BasicUsage.md ================================================ [Admin Docs](/) *** # Variable: BasicUsage > `const` **BasicUsage**: `Story` Defined 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) Basic usage of ViewModal displaying entity details ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/LoadingState.md ================================================ [Admin Docs](/) *** # Variable: LoadingState > `const` **LoadingState**: `Story` Defined 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) ViewModal in loading state while fetching data ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/OrganizationDetails.md ================================================ [Admin Docs](/) *** # Variable: OrganizationDetails > `const` **OrganizationDetails**: `Story` Defined 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) ViewModal displaying organization details ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/UserProfile.md ================================================ [Admin Docs](/) *** # Variable: UserProfile > `const` **UserProfile**: `Story` Defined 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) ViewModal displaying user profile information ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/WithCustomActions.md ================================================ [Admin Docs](/) *** # Variable: WithCustomActions > `const` **WithCustomActions**: `Story` Defined 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) ViewModal with custom action buttons ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `Meta`\<*typeof* [`ViewModal`](../../ViewModal/variables/ViewModal.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/hooks/useFormModal/functions/useFormModal.md ================================================ [Admin Docs](/) *** # Function: useFormModal() > **useFormModal**\<`T`\>(`initialData`): [`InterfaceUseFormModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseFormModalReturn.md)\<`T`\> Defined 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) Custom hook combining modal state with form data handling. Extends useModalState with form data management, useful for edit modals where you need to open the modal with pre-populated data. ## Type Parameters ### T `T` ## Parameters ### initialData `T` = `null` Initial form data (defaults to null) ## Returns [`InterfaceUseFormModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseFormModalReturn.md)\<`T`\> Object containing modal state, form data, and control functions ## Example ```tsx const { isOpen, close, formData, openWithData, reset, isSubmitting, setIsSubmitting } = useFormModal(); const handleEdit = (campaign: Campaign) => { openWithData(campaign); }; const handleSubmit = async (e: FormEvent) => { e.preventDefault(); setIsSubmitting(true); await updateCampaign(formData); setIsSubmitting(false); reset(); }; return ( ); ``` ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/hooks/useModalState/functions/useModalState.md ================================================ [Admin Docs](/) *** # Function: useModalState() > **useModalState**(`initialState`): [`InterfaceUseModalStateReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseModalStateReturn.md) Defined 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) Custom hook for managing modal open/close state. Provides a simple API for controlling modal visibility with open, close, and toggle functions. ## Parameters ### initialState `boolean` = `false` Initial open state (defaults to false) ## Returns [`InterfaceUseModalStateReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseModalStateReturn.md) Object containing isOpen state and control functions ## Example ```tsx const { isOpen, open, close } = useModalState(); return ( <> ); ``` ================================================ FILE: docs/docs/auto-docs/shared-components/CRUDModalTemplate/hooks/useMutationModal/functions/useMutationModal.md ================================================ [Admin Docs](/) *** # Function: useMutationModal() > **useMutationModal**\<`TData`, `TResult`\>(`mutationFn`, `options?`): [`InterfaceUseMutationModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseMutationModalReturn.md)\<`TData`, `TResult`\> Defined 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) Custom hook for modals that execute mutations (GraphQL or API calls). Extends useFormModal with mutation execution, error handling, and automatic state management during async operations. ## Type Parameters ### TData `TData` ### TResult `TResult` = `unknown` ## Parameters ### mutationFn (`data`) => `Promise`\<`TResult`\> Async function to execute (e.g., GraphQL mutation) ### options? Optional callbacks for success and error handling #### allowEmptyData? `boolean` #### onError? (`error`) => `void` #### onSuccess? (`result`) => `void` ## Returns [`InterfaceUseMutationModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseMutationModalReturn.md)\<`TData`, `TResult`\> Object containing modal state, form data, mutation execution, and error state ## Example ```tsx const [updateCampaign] = useMutation(UPDATE_CAMPAIGN); const { isOpen, formData, openWithData, reset, execute, isSubmitting, error, clearError } = useMutationModal( async (data) => { const result = await updateCampaign({ variables: { input: data } }); return result.data; }, { onSuccess: () => { toast.success('Campaign updated!'); reset(); }, onError: (err) => { toast.error(err.message); } } ); return ( { e.preventDefault(); execute(); }} loading={isSubmitting} error={error?.message} title="Edit Campaign" > ); ``` ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInMutationSuccess.md ================================================ [Admin Docs](/) *** # Variable: checkInMutationSuccess > `const` **checkInMutationSuccess**: `object`[] Defined in: [src/shared-components/CheckIn/CheckInMocks.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L64) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `MARK_CHECKIN` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` #### request.variables.userId > **userId**: `string` = `'user123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.checkIn > **checkIn**: `object` #### result.data.checkIn.checkinTime > **checkinTime**: `string` #### result.data.checkIn.checkoutTime > **checkoutTime**: `any` = `null` #### result.data.checkIn.feedbackSubmitted > **feedbackSubmitted**: `boolean` = `false` #### result.data.checkIn.id > **id**: `string` = `'123'` #### result.data.checkIn.isCheckedIn > **isCheckedIn**: `boolean` = `true` #### result.data.checkIn.isCheckedOut > **isCheckedOut**: `boolean` = `false` #### result.data.checkIn.user > **user**: `object` #### result.data.checkIn.user.id > **id**: `string` = `'user123'` ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInMutationSuccessRecurring.md ================================================ [Admin Docs](/) *** # Variable: checkInMutationSuccessRecurring > `const` **checkInMutationSuccessRecurring**: `object`[] Defined in: [src/shared-components/CheckIn/CheckInMocks.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L104) ## Type Declaration ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `MARK_CHECKIN` #### request.variables > **variables**: `object` #### request.variables.recurringEventInstanceId > **recurringEventInstanceId**: `string` = `'recurring123'` #### request.variables.userId > **userId**: `string` = `'user123'` ### result > **result**: `object` #### result.data > **data**: `object` #### result.data.checkIn > **checkIn**: `object` #### result.data.checkIn.checkinTime > **checkinTime**: `string` #### result.data.checkIn.checkoutTime > **checkoutTime**: `any` = `null` #### result.data.checkIn.feedbackSubmitted > **feedbackSubmitted**: `boolean` = `false` #### result.data.checkIn.id > **id**: `string` = `'123'` #### result.data.checkIn.isCheckedIn > **isCheckedIn**: `boolean` = `true` #### result.data.checkIn.isCheckedOut > **isCheckedOut**: `boolean` = `false` #### result.data.checkIn.user > **user**: `object` #### result.data.checkIn.user.id > **id**: `string` = `'user123'` ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInMutationUnsuccess.md ================================================ [Admin Docs](/) *** # Variable: checkInMutationUnsuccess > `const` **checkInMutationUnsuccess**: `object`[] Defined in: [src/shared-components/CheckIn/CheckInMocks.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L91) ## Type Declaration ### error > **error**: `Error` ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `MARK_CHECKIN` #### request.variables > **variables**: `object` #### request.variables.eventId > **eventId**: `string` = `'event123'` #### request.variables.userId > **userId**: `string` = `'user123'` ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInQueryMock.md ================================================ [Admin Docs](/) *** # Variable: checkInQueryMock > `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); \}; \})[] Defined in: [src/shared-components/CheckIn/CheckInMocks.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L38) ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md ================================================ [Admin Docs](/) *** # Function: CheckInWrapper() > **CheckInWrapper**(`__namedParameters`): `Element` Defined in: [src/shared-components/CheckIn/CheckInWrapper.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInWrapper.tsx#L32) ## Parameters ### \_\_namedParameters [`InterfaceCheckInWrapperProps`](../../../../types/shared-components/CheckInWrapper/interface/interfaces/InterfaceCheckInWrapperProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/Modal/CheckInModal/functions/CheckInModal.md ================================================ [Admin Docs](/) *** # Function: CheckInModal() > **CheckInModal**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`InterfaceModalProp`](../../../../../types/shared-components/CheckIn/interface/interfaces/InterfaceModalProp.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/Modal/Row/TableRow/functions/TableRow.md ================================================ [Admin Docs](/) *** # Function: TableRow() > **TableRow**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters #### data [`InterfaceTableCheckIn`](../../../../../../types/shared-components/CheckIn/interface/interfaces/InterfaceTableCheckIn.md) #### onCheckInUpdate? () => `void` #### refetch () => `void` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/CheckIn/tagTemplate/variables/tagTemplate.md ================================================ [Admin Docs](/) *** # Variable: tagTemplate > `const` **tagTemplate**: `Template` Defined in: [src/shared-components/CheckIn/tagTemplate.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/tagTemplate.ts#L4) ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridErrorOverlay/functions/DataGridErrorOverlay.md ================================================ [Admin Docs](/) *** # Function: DataGridErrorOverlay() > **DataGridErrorOverlay**(`props`): `Element` Defined in: [src/shared-components/DataGridWrapper/DataGridErrorOverlay.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridErrorOverlay.tsx#L27) Error overlay component for DataGrid ## Parameters ### props `InterfaceDataGridErrorOverlayProps` Component props ## Returns `Element` A centered error message overlay with an error icon ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridLoadingOverlay/functions/DataGridLoadingOverlay.md ================================================ [Admin Docs](/) *** # Function: DataGridLoadingOverlay() > **DataGridLoadingOverlay**(): `Element` Defined in: [src/shared-components/DataGridWrapper/DataGridLoadingOverlay.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridLoadingOverlay.tsx#L17) Wrapper component to bridge GridLoadingOverlayProps and LoadingState. This is used as the loadingOverlay slot in DataGrid to display a loading indicator. ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper/functions/DataGridWrapper.md ================================================ [Admin Docs](/) *** # Function: DataGridWrapper() > **DataGridWrapper**\<`T`\>(`props`): `Element` Defined in: [src/shared-components/DataGridWrapper/DataGridWrapper.tsx:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.tsx#L121) A generic wrapper around MUI DataGrid with built-in search, sorting, and pagination. ## Type Parameters ### T `T` *extends* `object` ## Parameters ### props [`InterfaceDataGridWrapperProps`](../../../../types/DataGridWrapper/interface/interfaces/InterfaceDataGridWrapperProps.md)\<`T`\> Component props defined by InterfaceDataGridWrapperProps ## Returns `Element` A data grid with optional toolbar controls (search, sort) and enhanced features ## Example ```tsx // Basic usage with search and pagination // With custom empty state // Backward compatible with legacy emptyStateMessage ``` ## Remarks - The `emptyStateProps` prop provides full customization of the empty state (icon, description, action button). - If both `emptyStateProps` and `emptyStateMessage` are provided, `emptyStateProps` takes precedence. - Error states always take precedence over empty states. - Accessibility: The component preserves a11y attributes (role="status", aria-live, aria-label) when using either `emptyStateProps` or `emptyStateMessage`. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper/functions/convertTokenColumns.md ================================================ [Admin Docs](/) *** # Function: convertTokenColumns() > **convertTokenColumns**(`columns`): `GridColDef`[] Defined in: [src/shared-components/DataGridWrapper/DataGridWrapper.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.tsx#L46) Converts token-aware column definitions to MUI-compatible GridColDef. Transforms spacing token names (e.g., 'space-15') to pixel values (e.g., 150). Use this function when passing columns to raw DataGrid instead of DataGridWrapper. ## Parameters ### columns [`TokenAwareGridColDef`](../../../../types/DataGridWrapper/interface/type-aliases/TokenAwareGridColDef.md)[] Array of TokenAwareGridColDef with token names for width properties ## Returns `GridColDef`[] Array of GridColDef with numeric pixel values ## Example ```tsx const columns: TokenAwareGridColDef[] = [ { field: 'name', minWidth: 'space-15' }, ]; ``` ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/BasicUsage.md ================================================ [Admin Docs](/) *** # Variable: BasicUsage > `const` **BasicUsage**: `Story` Defined 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) Basic usage of DataGridWrapper with minimal configuration. Just provide rows and columns to display a simple data table. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/CompleteExample.md ================================================ [Admin Docs](/) *** # Variable: CompleteExample > `const` **CompleteExample**: `Story` Defined 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) Complete example with all features enabled. Demonstrates search, sorting, pagination, and action column together. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/EmptyState.md ================================================ [Admin Docs](/) *** # Variable: EmptyState > `const` **EmptyState**: `Story` Defined 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) DataGridWrapper with empty state. Displays a message when no data is available. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/ErrorState.md ================================================ [Admin Docs](/) *** # Variable: ErrorState > `const` **ErrorState**: `Story` Defined 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) DataGridWrapper with error state. Shows an error message when data fetching fails. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/LoadingState.md ================================================ [Admin Docs](/) *** # Variable: LoadingState > `const` **LoadingState**: `Story` Defined 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) DataGridWrapper in loading state. Displays a loading overlay while data is being fetched. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/SearchWithNoResults.md ================================================ [Admin Docs](/) *** # Variable: SearchWithNoResults > `const` **SearchWithNoResults**: `Story` Defined 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) DataGridWrapper with custom empty state and search. Shows how empty state interacts with search functionality. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithActionColumn.md ================================================ [Admin Docs](/) *** # Variable: WithActionColumn > `const` **WithActionColumn**: `Story` Defined 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) DataGridWrapper with custom action column. Add interactive buttons for each row. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithPagination.md ================================================ [Admin Docs](/) *** # Variable: WithPagination > `const` **WithPagination**: `Story` Defined 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) DataGridWrapper with pagination enabled. Useful for displaying large datasets with configurable page sizes. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithRowClick.md ================================================ [Admin Docs](/) *** # Variable: WithRowClick > `const` **WithRowClick**: `Story` Defined 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) DataGridWrapper with row click handler. Responds to row clicks for navigation or modal opening. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithSearch.md ================================================ [Admin Docs](/) *** # Variable: WithSearch > `const` **WithSearch**: `Story` Defined 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) DataGridWrapper with integrated search functionality. Search across multiple fields with a built-in search bar. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithSorting.md ================================================ [Admin Docs](/) *** # Variable: WithSorting > `const` **WithSorting**: `Story` Defined 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) DataGridWrapper with sorting dropdown. Pre-configured sorting options for common use cases. ================================================ FILE: docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `Meta`\<*typeof* [`DataGridWrapper`](../../DataGridWrapper/functions/DataGridWrapper.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/BulkActionsBar/functions/BulkActionsBar.md ================================================ [Admin Docs](/) *** # Function: BulkActionsBar() > **BulkActionsBar**(`count`): `Element` Defined in: [src/shared-components/DataTable/BulkActionsBar.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/BulkActionsBar.tsx#L18) BulkActionsBar displays a toolbar when rows are selected. Shows the selected count, action buttons, and a clear button. ## Parameters ### count [`InterfaceBulkActionsBarProps`](../../../../types/shared-components/BulkActionsBar/interface/interfaces/InterfaceBulkActionsBarProps.md) The number of selected rows. ## Returns `Element` The rendered toolbar or null if no rows are selected. ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/DataTable/functions/DataTable.md ================================================ [Admin Docs](/) *** # Function: DataTable() > **DataTable**\<`T`\>(`props`): `Element` Defined in: [src/shared-components/DataTable/DataTable.tsx:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTable.tsx#L75) ## Type Parameters ### T `T` ## Parameters ### props [`InterfaceDataTableProps`](../../../../types/shared-components/DataTable/props/type-aliases/InterfaceDataTableProps.md)\<`T`\> ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/DataTable/functions/defaultCompare.md ================================================ [Admin Docs](/) *** # Function: defaultCompare() > **defaultCompare**(`a`, `b`): `number` Defined in: [src/shared-components/DataTable/DataTable.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTable.tsx#L52) **`Internal`** Compare values with nulls last, numbers/dates/booleans handled explicitly. Exported for testing purposes. ## Parameters ### a `unknown` ### b `unknown` ## Returns `number` ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/DataTableSkeleton/functions/DataTableSkeleton.md ================================================ [Admin Docs](/) *** # Function: DataTableSkeleton() > **DataTableSkeleton**\<`T`\>(`props`): `Element` Defined in: [src/shared-components/DataTable/DataTableSkeleton.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTableSkeleton.tsx#L32) DataTableSkeleton component that displays a loading skeleton matching the table layout. Renders a responsive table structure with skeleton cells for each column and row, including optional selection checkbox and actions columns. The skeleton respects the column definitions to ensure consistent layout during data loading. ## Type Parameters ### T `T` ## Parameters ### props [`InterfaceDataTableSkeletonProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceDataTableSkeletonProps.md)\<`T`\> The component props (`InterfaceDataTableSkeletonProps`): - ariaLabel: Optional accessible label - columns: Column definitions determining structure - effectiveSelectable: Whether to show selection checkbox - hasRowActions: Whether to show actions column - skeletonRows: Number of skeleton rows to display - tableClassNames: CSS class names for the table ## Returns `Element` The rendered skeleton table component ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/DataTableTable/functions/DataTableTable.md ================================================ [Admin Docs](/) *** # Function: DataTableTable() > **DataTableTable**\<`T`\>(`props`): `Element` Defined in: [src/shared-components/DataTable/DataTableTable.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTableTable.tsx#L60) DataTableTable component for rendering the core table structure. Renders the HTML table with headers, rows, selection checkboxes, sorting indicators, and action cells. Handles user interactions for sorting, row selection, and displays loading states during pagination. Includes sorting UI, selection controls, and action cells. ## Type Parameters ### T `T` ## Parameters ### props [`InterfaceDataTableTableProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceDataTableTableProps.md)\<`T`\> The component props (`InterfaceDataTableTableProps`): Table structure (columns, sortedRows, ariaLabel, tableClassNames) Sorting (activeSortBy, activeSortDir, handleHeaderClick) Selection (effectiveSelectable, currentSelection, toggleRowSelection, headerCheckboxRef, selectAllOnPage, someSelectedOnPage, allSelectedOnPage) Rendering (renderRow, getKey, startIndex) Actions (hasRowActions, effectiveRowActions) Loading (loadingMore, skeletonRows, ariaBusy) Utilities (tCommon) ## Returns `Element` The rendered table JSX element with headers, rows, and optional loading indicators ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/LoadingMoreRows/functions/LoadingMoreRows.md ================================================ [Admin Docs](/) *** # Function: LoadingMoreRows() > **LoadingMoreRows**\<`T`\>(`props`): `Element` Defined in: [src/shared-components/DataTable/LoadingMoreRows.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/LoadingMoreRows.tsx#L29) LoadingMoreRows component that displays skeleton rows appended to a table. Renders placeholder rows with skeleton cells to indicate data is being loaded, matching the table structure with optional selection checkboxes and actions columns. Useful for infinite scroll or "load more" pagination patterns. ## Type Parameters ### T `T` ## Parameters ### props [`InterfaceLoadingMoreRowsProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceLoadingMoreRowsProps.md)\<`T`\> The component props (`InterfaceLoadingMoreRowsProps`): - columns: Column definitions determining structure - effectiveSelectable: Whether to show selection checkbox column - hasRowActions: Whether to show actions column - skeletonRows: Number of skeleton rows to display ## Returns `Element` A fragment containing skeleton table rows ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/Pagination/functions/PaginationControls.md ================================================ [Admin Docs](/) *** # Function: PaginationControls() > **PaginationControls**(`page`): `Element` Defined in: [src/shared-components/DataTable/Pagination.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/Pagination.tsx#L24) PaginationControls component for navigating through paginated data. Type Safety: IPaginationControlsProps enforces number types for pageSize and totalItems. TypeScript prevents string/unknown types at compile-time, so runtime Number.isFinite() checks are defensive fallbacks only (should never receive strings from properly-typed callers). AUDIT RESULT: All call sites verified (DataTable.tsx only caller): - pageSize: defaults to 10 (numeric), derived from props with number type - totalItems: comes from (totalItems ?? data.length), both numeric - No URL/form-based string-to-number coercion needed (type safety enforced) ## Parameters ### page [`InterfacePaginationControlsProps`](../../../../types/shared-components/DataTable/pagination/interfaces/InterfacePaginationControlsProps.md) Current page number (1-indexed) ## Returns `Element` Pagination navigation controls ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/SearchBar/functions/SearchBar.md ================================================ [Admin Docs](/) *** # Function: SearchBar() > **SearchBar**(`props`): `Element` Defined in: [src/shared-components/DataTable/SearchBar.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/SearchBar.tsx#L12) A controlled search input with optional clear button. ## Parameters ### props [`InterfaceSearchBarProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceSearchBarProps.md) Component props containing value, onChange, placeholder, and aria-label ## Returns `Element` A search input element with optional clear button ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/TableLoader/variables/TableLoader.md ================================================ [Admin Docs](/) *** # Variable: TableLoader() > `const` **TableLoader**: \<`T`\>(`props`) => `ReactElement` Defined in: [src/shared-components/DataTable/TableLoader.tsx:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/TableLoader.tsx#L69) ## Type Parameters ### T `T` ## Parameters ### props [`InterfaceTableLoaderProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceTableLoaderProps.md)\<`T`\> ## Returns `ReactElement` ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/cells/ActionsCell/functions/ActionsCell.md ================================================ [Admin Docs](/) *** # Function: ActionsCell() > **ActionsCell**\<`T`\>(`props`): `Element` Defined 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) ActionsCell renders a row of action buttons for a single table row. ## Type Parameters ### T `T` The type of the row data ## Parameters ### props [`InterfaceActionsCellProps`](../../../../../types/shared-components/ActionsCell/interface/interfaces/InterfaceActionsCellProps.md)\<`T`\> Props containing row data and action definitions ## Returns `Element` The rendered actions cell element ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/hooks/useDataTableFiltering/functions/useDataTableFiltering.md ================================================ [Admin Docs](/) *** # Function: useDataTableFiltering() > **useDataTableFiltering**\<`T`\>(`options`): `object` Defined 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) Hook to manage DataTable filtering and search logic. Provides controlled and uncontrolled modes for both global search and per-column filtering. Handles client-side filtering when server flags are not set. ## Type Parameters ### T `T` The row data type used in the DataTable ## Parameters ### options [`IUseDataTableFilteringOptions`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseDataTableFilteringOptions.md)\<`T`\> Configuration options for filtering behavior including: - `data` - Array of row data to filter - `columns` - Column definitions with filter/search metadata - `initialGlobalSearch` - Initial search value for uncontrolled mode - `globalSearch` - Controlled global search value - `onGlobalSearchChange` - Callback for controlled search updates - `columnFilters` - Column filter values by column ID - `onColumnFiltersChange` - Callback when column filters change - `serverSearch` - If true, skip client-side global search filtering - `serverFilter` - If true, skip client-side column filtering - `paginationMode` - Pagination mode affecting page reset behavior - `onPageReset` - Callback to reset page when filters change ## Returns `object` Object containing: - `query` - Current global search string - `updateGlobalSearch` - Function to update the search query - `filteredRows` - Array of rows after applying filters - `filters` - Current column filter values ### filteredRows > **filteredRows**: `T`[] ### filters > **filters**: `Record`\<`string`, `unknown`\> ### query > **query**: `string` ### updateGlobalSearch() > **updateGlobalSearch**: (`next`) => `void` #### Parameters ##### next `string` #### Returns `void` ## Example ```tsx const { query, updateGlobalSearch, filteredRows } = useDataTableFiltering({ data: users, columns: userColumns, initialGlobalSearch: '', }); ``` ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/hooks/useDataTableSelection/functions/useDataTableSelection.md ================================================ [Admin Docs](/) *** # Function: useDataTableSelection() > **useDataTableSelection**\<`T`\>(`options`): `object` Defined 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) Hook to manage DataTable selection and bulk action logic. Supports controlled and uncontrolled modes for row selection. Normalizes selection to current page keys on page changes. ## Type Parameters ### T `T` The row data type ## Parameters ### options [`IUseDataTableSelectionOptions`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseDataTableSelectionOptions.md)\<`T`\> Configuration options for selection behavior ## Returns `object` Object containing selection state and mutation helpers ### allSelectedOnPage > **allSelectedOnPage**: `boolean` ### clearSelection() > **clearSelection**: () => `void` #### Returns `void` ### currentSelection > **currentSelection**: `Set`\<[`Key`](../../../../../types/shared-components/DataTable/types/type-aliases/Key.md)\> ### runBulkAction() > **runBulkAction**: (`action`) => `void` #### Parameters ##### action [`IBulkAction`](../../../../../types/shared-components/DataTable/hooks/interfaces/IBulkAction.md)\<`T`\> #### Returns `void` ### selectAllOnPage() > **selectAllOnPage**: (`checked`) => `void` #### Parameters ##### checked `boolean` #### Returns `void` ### selectedCountOnPage > **selectedCountOnPage**: `number` ### someSelectedOnPage > **someSelectedOnPage**: `boolean` ### toggleRowSelection() > **toggleRowSelection**: (`key`) => `void` #### Parameters ##### key [`Key`](../../../../../types/shared-components/DataTable/types/type-aliases/Key.md) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/hooks/useSimpleTableData/functions/useSimpleTableData.md ================================================ [Admin Docs](/) *** # Function: useSimpleTableData() > **useSimpleTableData**\<`TRow`, `TData`\>(`result`, `options`): [`IUseSimpleTableDataResult`](../interfaces/IUseSimpleTableDataResult.md)\<`TRow`, `TData`\> Defined 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) Hook for integrating simple array-based GraphQL queries with DataTable. Use this for queries that return arrays directly, not connection format. For connection-based queries (with edges/pageInfo), use useTableData instead. ## Type Parameters ### TRow `TRow` = `unknown` ### TData `TData` = `unknown` ## Parameters ### result `QueryResult`\<`TData`\> ### options [`IUseSimpleTableDataOptions`](../interfaces/IUseSimpleTableDataOptions.md)\<`TRow`, `TData`\> ## Returns [`IUseSimpleTableDataResult`](../interfaces/IUseSimpleTableDataResult.md)\<`TRow`, `TData`\> ## Example ```tsx const queryResult = useQuery(MEMBERSHIP_REQUEST_PG, { variables: { input: { id: orgId }, first: 10 } }); // Path function MUST be memoized with useCallback const extractRequests = useCallback( (data: InterfaceMembershipRequestsQueryData) => data?.organization?.membershipRequests ?? [], [] ); const { rows, loading, error, refetch } = useSimpleTableData< InterfaceRequestsListItem, InterfaceMembershipRequestsQueryData >(queryResult, { path: extractRequests }); ``` ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/hooks/useSimpleTableData/interfaces/IUseSimpleTableDataOptions.md ================================================ [Admin Docs](/) *** # Interface: IUseSimpleTableDataOptions\ Defined 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) Options for useSimpleTableData hook ## Type Parameters ### TRow `TRow` ### TData `TData` ## Properties ### path() > **path**: (`data`) => `TRow`[] Defined 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) Path function to extract array data from GraphQL response. IMPORTANT: Must be memoized with useCallback for stable reference. #### Parameters ##### data `TData` #### Returns `TRow`[] ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/hooks/useSimpleTableData/interfaces/IUseSimpleTableDataResult.md ================================================ [Admin Docs](/) *** # Interface: IUseSimpleTableDataResult\ Defined 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) Result returned by useSimpleTableData hook ## Type Parameters ### TRow `TRow` ### TData `TData` ## Properties ### error > **error**: `ApolloError` Defined 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) Error from the query, if any. Preserves ApolloError properties (graphQLErrors, networkError, etc.) *** ### loading > **loading**: `boolean` Defined 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) Loading state from the query *** ### refetch() > **refetch**: (`variables?`) => `Promise`\<`ApolloQueryResult`\<`TData`\>\> Defined 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) Function to refetch the query. Returns a Promise that resolves with Apollo query result. Matches Apollo's refetch signature: can accept variables and returns Promise. #### Parameters ##### variables? `Partial`\<`TVariables`\> #### Returns `Promise`\<`ApolloQueryResult`\<`TData`\>\> *** ### rows > **rows**: `TRow`[] Defined 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) Extracted rows from the query data ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/hooks/useTableData/functions/useTableData.md ================================================ [Admin Docs](/) *** # Function: useTableData() > **useTableData**\<`TNode`, `TRow`, `TData`\>(`result`, `options`): [`IUseTableDataResult`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseTableDataResult.md)\<`TRow`, `TData`\> Defined 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) Extract GraphQL connection data into table rows with optional node transform; filters null nodes. ## Type Parameters ### TNode `TNode` = `unknown` ### TRow `TRow` = `TNode` ### TData `TData` = `unknown` ## Parameters ### result `QueryResult`\<`TData`\> ### options [`IUseTableDataOptions`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseTableDataOptions.md)\<`TNode`, `TRow`, `TData`\> ## Returns [`IUseTableDataResult`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseTableDataResult.md)\<`TRow`, `TData`\> ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/utils/functions/getCellValue.md ================================================ [Admin Docs](/) *** # Function: getCellValue() > **getCellValue**\<`T`, `TValue`\>(`row`, `accessor`): `TValue` Defined in: [src/shared-components/DataTable/utils.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L41) Helper to get raw cell value from a row using the accessor. ## Type Parameters ### T `T` The row data type ### TValue `TValue` = `unknown` The expected return value type ## Parameters ### row `T` The row data object ### accessor [`Accessor`](../../../../types/shared-components/DataTable/types/type-aliases/Accessor.md)\<`T`, `TValue`\> Column accessor (property key or function) ## Returns `TValue` The cell value ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/utils/functions/renderCellValue.md ================================================ [Admin Docs](/) *** # Function: renderCellValue() > **renderCellValue**(`value`): `string` \| `number` Defined in: [src/shared-components/DataTable/utils.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L22) Renders a cell value for display. ## Parameters ### value `unknown` Raw cell value. ## Returns `string` \| `number` Display-safe string or primitive. ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/utils/functions/renderHeader.md ================================================ [Admin Docs](/) *** # Function: renderHeader() > **renderHeader**(`header`): `ReactNode` Defined in: [src/shared-components/DataTable/utils.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L12) Renders the header of a column. ## Parameters ### header [`HeaderRender`](../../../../types/shared-components/DataTable/types/type-aliases/HeaderRender.md) Header value or render function. ## Returns `ReactNode` The rendered header content. ================================================ FILE: docs/docs/auto-docs/shared-components/DataTable/utils/functions/toSearchableString.md ================================================ [Admin Docs](/) *** # Function: toSearchableString() > **toSearchableString**(`v`): `string` Defined in: [src/shared-components/DataTable/utils.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L56) Helper for text search interactions. ## Parameters ### v `unknown` Value to stringify for search. ## Returns `string` Searchable string. ================================================ FILE: docs/docs/auto-docs/shared-components/DatePicker/DatePicker/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceDatePickerProps`](../../../../types/shared-components/DatePicker/interface/interfaces/InterfaceDatePickerProps.md)\> Defined in: [src/shared-components/DatePicker/DatePicker.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DatePicker/DatePicker.tsx#L25) ================================================ FILE: docs/docs/auto-docs/shared-components/DateRangePicker/DateRangePicker/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/shared-components/DateRangePicker/DateRangePicker.tsx:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DateRangePicker/DateRangePicker.tsx#L74) ## Parameters ### \_\_namedParameters [`InterfaceDateRangePickerProps`](../../../../types/shared-components/DateRangePicker/interface/interfaces/InterfaceDateRangePickerProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/baseProps.md ================================================ [Admin Docs](/) *** # Variable: baseProps > `const` **baseProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/basicOptions.md ================================================ [Admin Docs](/) *** # Variable: basicOptions > `const` **basicOptions**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/customLabelProps.md ================================================ [Admin Docs](/) *** # Variable: customLabelProps > `const` **customLabelProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/disabledDropdownProps.md ================================================ [Admin Docs](/) *** # Variable: disabledDropdownProps > `const` **disabledDropdownProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/disabledOptionProps.md ================================================ [Admin Docs](/) *** # Variable: disabledOptionProps > `const` **disabledOptionProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/dropUpProps.md ================================================ [Admin Docs](/) *** # Variable: dropUpProps > `const` **dropUpProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/mockOnSelect.md ================================================ [Admin Docs](/) *** # Variable: mockOnSelect > `const` **mockOnSelect**: `Mock`\<`Procedure`\> Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/noSelectionProps.md ================================================ [Admin Docs](/) *** # Variable: noSelectionProps > `const` **noSelectionProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/noTestIdProps.md ================================================ [Admin Docs](/) *** # Variable: noTestIdProps > `const` **noTestIdProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/optionsWithDisabled.md ================================================ [Admin Docs](/) *** # Variable: optionsWithDisabled > `const` **optionsWithDisabled**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/optionsWithNonStringLabel.md ================================================ [Admin Docs](/) *** # Variable: optionsWithNonStringLabel > `const` **optionsWithNonStringLabel**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/searchableMinimalProps.md ================================================ [Admin Docs](/) *** # Variable: searchableMinimalProps > `const` **searchableMinimalProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/searchableOptionsForCoverage.md ================================================ [Admin Docs](/) *** # Variable: searchableOptionsForCoverage > `const` **searchableOptionsForCoverage**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/styledProps.md ================================================ [Admin Docs](/) *** # Variable: styledProps > `const` **styledProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/variantProps.md ================================================ [Admin Docs](/) *** # Variable: variantProps > `const` **variantProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/withIconProps.md ================================================ [Admin Docs](/) *** # Variable: withIconProps > `const` **withIconProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/withIconSearchProps.md ================================================ [Admin Docs](/) *** # Variable: withIconSearchProps > `const` **withIconSearchProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/withNonStringLabelProps.md ================================================ [Admin Docs](/) *** # Variable: withNonStringLabelProps > `const` **withNonStringLabelProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/SearchToggle/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `ForwardRefExoticComponent`\<[`InterfaceSearchToggleProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceSearchToggleProps.md) & `RefAttributes`\<`HTMLDivElement`\>\> Defined in: [src/shared-components/DropDownButton/SearchToggle.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/SearchToggle.tsx#L12) Custom Toggle for Search functionality. Renders an input field that acts as a dropdown toggle. ## Param The props for the SearchToggle component. ## Param The ref forwarded to the div element. ================================================ FILE: docs/docs/auto-docs/shared-components/DropDownButton/variables/DropDownButton.md ================================================ [Admin Docs](/) *** # Variable: DropDownButton > `const` **DropDownButton**: `React.FC`\<[`InterfaceDropDownButtonProps`](../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\> Defined in: [src/shared-components/DropDownButton/DropDownButton.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.tsx#L56) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyState/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\> Defined in: [src/shared-components/EmptyState/EmptyState.tsx:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyState.tsx#L73) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateBaseForActionMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateBaseForActionMock > `const` **emptyStateBaseForActionMock**: `Omit`\<[`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md), `"action"`\> Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L23) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateBaseMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateBaseMock > `const` **emptyStateBaseMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md) Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L4) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithAllPropsMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateWithAllPropsMock > `const` **emptyStateWithAllPropsMock**: `Omit`\<[`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md), `"action"`\> Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L30) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithCustomCSSMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateWithCustomCSSMock > `const` **emptyStateWithCustomCSSMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md) Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L41) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithCustomDataTestIdMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateWithCustomDataTestIdMock > `const` **emptyStateWithCustomDataTestIdMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md) Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L46) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithCustomIconMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateWithCustomIconMock > `const` **emptyStateWithCustomIconMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md) Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L18) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithDescriptionMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateWithDescriptionMock > `const` **emptyStateWithDescriptionMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md) Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L8) ================================================ FILE: docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithIconMock.md ================================================ [Admin Docs](/) *** # Variable: emptyStateWithIconMock > `const` **emptyStateWithIconMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md) Defined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L13) ================================================ FILE: docs/docs/auto-docs/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper/classes/ErrorBoundaryWrapper.md ================================================ [Admin Docs](/) *** # Class: ErrorBoundaryWrapper Defined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L58) ## Extends - `Component`\<[`InterfaceErrorBoundaryWrapperProps`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperProps.md), [`InterfaceErrorBoundaryWrapperState`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md)\> ## Constructors ### Constructor > **new ErrorBoundaryWrapper**(`props`): `ErrorBoundaryWrapper` Defined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L63) #### Parameters ##### props [`InterfaceErrorBoundaryWrapperProps`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperProps.md) #### Returns `ErrorBoundaryWrapper` #### Overrides `React.Component< InterfaceErrorBoundaryWrapperProps, InterfaceErrorBoundaryWrapperState >.constructor` ## Methods ### componentDidCatch() > **componentDidCatch**(`error`, `errorInfo`): `void` Defined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L90) Log error details after an error has been caught This lifecycle method is called during the commit phase (to log/ report) #### Parameters ##### error `Error` ##### errorInfo `ErrorInfo` #### Returns `void` #### Overrides `React.Component.componentDidCatch` *** ### handleReset() > **handleReset**(): `void` Defined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L117) Reset error boundary state to recover from error #### Returns `void` *** ### render() > **render**(): `ReactNode` Defined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L136) #### Returns `ReactNode` #### Overrides `React.Component.render` *** ### getDerivedStateFromError() > `static` **getDerivedStateFromError**(`error`): `Partial`\<[`InterfaceErrorBoundaryWrapperState`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md)\> Defined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L76) Update state when an error is caught This lifecycle method is called during the render phase (to change UI) #### Parameters ##### error `Error` #### Returns `Partial`\<[`InterfaceErrorBoundaryWrapperState`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md)\> ================================================ FILE: docs/docs/auto-docs/shared-components/ErrorPanel/ErrorPanel/interfaces/InterfaceErrorPanelProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceErrorPanelProps Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L53) ## Properties ### ariaLive? > `optional` **ariaLive**: `"off"` \| `"polite"` \| `"assertive"` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L87) ARIA live region setting (only used when role is not 'alert', defaults to 'assertive') *** ### className? > `optional` **className**: `string` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L77) Additional CSS class name for the container *** ### error > **error**: `Error` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L62) The error object containing additional error details *** ### message > **message**: `ReactNode` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L57) The main error message to display (can be a string or React node) *** ### onRetry() > **onRetry**: () => `void` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L67) Callback function to retry the failed operation #### Returns `void` *** ### retryAriaLabel? > `optional` **retryAriaLabel**: `string` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L92) ARIA label for the retry button (only set if different from button text) *** ### role? > `optional` **role**: `"status"` \| `"alert"` \| `"log"` \| `"marquee"` \| `"timer"` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L82) ARIA role for accessibility (role="alert" implies aria-live="assertive", defaults to 'alert') *** ### showErrorDetails? > `optional` **showErrorDetails**: `boolean` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L98) Whether to show raw error details (for development/debugging) When false, displays a sanitized/truncated message instead (defaults to false) *** ### testId? > `optional` **testId**: `string` Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L72) Test ID for the error message container (defaults to 'errorMsg') ================================================ FILE: docs/docs/auto-docs/shared-components/ErrorPanel/ErrorPanel/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceErrorPanelProps`](../interfaces/InterfaceErrorPanelProps.md)\> Defined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L105) ErrorPanel component that displays error information with a retry button. Sanitizes sensitive information from error messages and logs full errors to console. ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/EventForm/functions/formatRecurrenceForPayload.md ================================================ [Admin Docs](/) *** # Function: formatRecurrenceForPayload() > **formatRecurrenceForPayload**(`recurrenceRule`, `startDate`): `Omit`\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `"endDate"`\> & `object` Defined in: [src/shared-components/EventForm/EventForm.tsx:556](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/EventForm.tsx#L556) Formats a recurrence rule for API submission. ## Parameters ### recurrenceRule [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) The recurrence rule to format ### startDate `Date` The event start date ## Returns `Omit`\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `"endDate"`\> & `object` The formatted recurrence string or null ## Throws Error if the recurrence rule is invalid ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/EventForm/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`IEventFormProps`](../../../../types/EventForm/interface/interfaces/IEventFormProps.md)\> Defined in: [src/shared-components/EventForm/EventForm.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/EventForm.tsx#L41) ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/RecurrenceDropdown/RecurrenceDropdown/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceRecurrenceDropdownProps`](../../../../../types/shared-components/RecurrenceDropdown/interface/interfaces/InterfaceRecurrenceDropdownProps.md)\> Defined 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) Renders a dropdown for selecting recurrence patterns. ## Param Component props from InterfaceRecurrenceDropdownProps ## Returns JSX.Element - The recurrence dropdown component ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/VisibilitySelector/VisibilitySelector/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceVisibilitySelectorProps`](../../../../../types/shared-components/VisibilitySelector/interface/interfaces/InterfaceVisibilitySelectorProps.md)\> Defined 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) Renders a radio button group for selecting event visibility. ## Param Component props ## Returns The visibility selector JSX ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/utils/recurrenceOptions/functions/buildRecurrenceOptions.md ================================================ [Admin Docs](/) *** # Function: buildRecurrenceOptions() > **buildRecurrenceOptions**(`startDate`, `t`): [`InterfaceRecurrenceOption`](../interfaces/InterfaceRecurrenceOption.md)[] Defined 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) Builds an array of recurrence options based on the event start date. ## Parameters ### startDate `Date` The event start date ### t (`key`, `options?`) => `string` Translation function for option labels ## Returns [`InterfaceRecurrenceOption`](../interfaces/InterfaceRecurrenceOption.md)[] Array of recurrence options for the dropdown ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/utils/recurrenceOptions/interfaces/InterfaceRecurrenceOption.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurrenceOption Defined 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) Represents a recurrence option in the dropdown. ## Properties ### label > **label**: `string` Defined 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) *** ### value > **value**: `"custom"` \| [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/utils/timeUtils/functions/timeToDayJs.md ================================================ [Admin Docs](/) *** # Function: timeToDayJs() > **timeToDayJs**(`time`): `Dayjs` Defined 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) Converts a time string (HH:mm:ss) to a dayjs object. ## Parameters ### time `string` Time string in HH:mm:ss format ## Returns `Dayjs` A dayjs object with the specified time set on today's date ## Example ```ts timeToDayJs('14:30:00') // Returns dayjs object for 2:30 PM today ``` ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/utils/visibilityUtils/functions/getVisibilityType.md ================================================ [Admin Docs](/) *** # Function: getVisibilityType() > **getVisibilityType**(`isPublic?`, `isInviteOnly?`): [`EventVisibility`](../type-aliases/EventVisibility.md) Defined 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) Determines the visibility type based on boolean flags. ## Parameters ### isPublic? `boolean` Whether the event is public ### isInviteOnly? `boolean` Whether the event is invite-only ## Returns [`EventVisibility`](../type-aliases/EventVisibility.md) The corresponding EventVisibility value ================================================ FILE: docs/docs/auto-docs/shared-components/EventForm/utils/visibilityUtils/type-aliases/EventVisibility.md ================================================ [Admin Docs](/) *** # Type Alias: EventVisibility > **EventVisibility** = `"PUBLIC"` \| `"ORGANIZATION"` \| `"INVITE_ONLY"` Defined 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) Represents the visibility level of an event. - PUBLIC: Visible to everyone - ORGANIZATION: Visible to organization members only - INVITE_ONLY: Visible only to invited attendees ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/EventListCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/shared-components/EventListCard/EventListCard.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/EventListCard.tsx#L40) Props for the EventListCard component. ## Parameters ### props [`IEventListCard`](../../../../types/Event/interface/interfaces/IEventListCard.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/EventListCardProps.mock/variables/props.md ================================================ [Admin Docs](/) *** # Variable: props > `const` **props**: `IEventListCardProps`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/Modal/Delete/EventListCardDeleteModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceDeleteEventModalProps`](../../../../../../types/Event/interface/type-aliases/InterfaceDeleteEventModalProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/Modal/EventListCardMocks/variables/ERROR_MOCKS.md ================================================ [Admin Docs](/) *** # Variable: ERROR\_MOCKS > `const` **ERROR\_MOCKS**: `object`[] Defined 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) ## Type Declaration ### error > **error**: `Error` ### request > **request**: `object` #### request.query > **query**: `DocumentNode` = `DELETE_STANDALONE_EVENT_MUTATION` #### request.variables > **variables**: `object` #### request.variables.input > **input**: `object` #### request.variables.input.id > **id**: `string` = `'1'` ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/Modal/EventListCardMocks/variables/MOCKS.md ================================================ [Admin Docs](/) *** # Variable: MOCKS > `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`; \}; \}; \})[] Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/Modal/EventListCardModals/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`InterfaceEventListCardModalsProps`](../../../../../types/shared-components/EventListCard/interface/interfaces/InterfaceEventListCardModalsProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/Modal/Preview/EventListCardPreviewModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfacePreviewEventModalProps`](../../../../../../types/Event/interface/type-aliases/InterfacePreviewEventModalProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/shared-components/EventListCard/Modal/updateLogic/functions/useUpdateEventHandler.md ================================================ [Admin Docs](/) *** # Function: useUpdateEventHandler() > **useUpdateEventHandler**(): `object` Defined 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) Creates the update handler for EventListCard modal edits, managing mutations for standalone and recurring events. ## Returns `object` An object containing the update logic: - updateEventHandler: `(args: IUpdateEventHandlerProps) => Promise` - Asynchronous function that handles the event update process, including validation and mutation execution. ### updateEventHandler() > **updateEventHandler**: (`__namedParameters`) => `Promise`\<`void`\> #### Parameters ##### \_\_namedParameters [`InterfaceUpdateEventHandlerProps`](../../../../../types/shared-components/EventListCard/interface/interfaces/InterfaceUpdateEventHandlerProps.md) #### Returns `Promise`\<`void`\> ================================================ FILE: docs/docs/auto-docs/shared-components/FormFieldGroup/FormCheckField/variables/FormCheckField.md ================================================ [Admin Docs](/) *** # Variable: FormCheckField > `const` **FormCheckField**: `React.FC`\<[`InterfaceFormCheckFieldProps`](../../../../types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormCheckFieldProps.md)\> Defined in: [src/shared-components/FormFieldGroup/FormCheckField.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormCheckField.tsx#L13) Renders a checkbox, radio, or switch input field within a FormFieldGroup for consistent styling and validation. Use this component to wrap Form.Check and Form.Switch elements. ## Param The properties for the FormCheckField component. ## Returns A form check React element. ================================================ FILE: docs/docs/auto-docs/shared-components/FormFieldGroup/FormFieldGroup/variables/FormFieldGroup.md ================================================ [Admin Docs](/) *** # Variable: FormFieldGroup > `const` **FormFieldGroup**: `React.FC`\<[`InterfaceFormFieldGroupProps`](../../../../types/FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md) & `object`\> Defined in: [src/shared-components/FormFieldGroup/FormFieldGroup.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormFieldGroup.tsx#L12) Renders a grouped form field with label, help text, error, and children elements. ## Param The properties for the FormFieldGroup component. ## Returns A form group React element. ================================================ FILE: docs/docs/auto-docs/shared-components/FormFieldGroup/FormSelectField/variables/FormSelectField.md ================================================ [Admin Docs](/) *** # Variable: FormSelectField > `const` **FormSelectField**: `React.FC`\<[`InterfaceFormSelectFieldProps`](../../../../types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormSelectFieldProps.md)\> Defined in: [src/shared-components/FormFieldGroup/FormSelectField.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormSelectField.tsx#L20) Renders a select input field within a FormFieldGroup for consistent styling and validation. `@param` name - Field name/id. `@param` label - Field label text. `@param` required - Whether the field is required. `@param` helpText - Helper text below the field. `@param` error - Validation error message. `@param` touched - Whether the field has been touched. `@param` value - Current selected value. `@param` onChange - Value change handler. `@param` children - Option elements. ## Returns A select field React element. ================================================ FILE: docs/docs/auto-docs/shared-components/FormFieldGroup/FormTextField/variables/FormTextField.md ================================================ [Admin Docs](/) *** # Variable: FormTextField > `const` **FormTextField**: `React.FC`\<[`IFormTextFieldProps`](../../../../types/FormFieldGroup/interface/interfaces/IFormTextFieldProps.md)\> Defined in: [src/shared-components/FormFieldGroup/FormTextField.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormTextField.tsx#L12) Renders a text input field within a FormFieldGroup for consistent styling and validation. ## Param The properties for the FormTextField component. ## Returns A text field React element. ================================================ FILE: docs/docs/auto-docs/shared-components/InfiniteScrollLoader/InfiniteScrollLoader/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/shared-components/InfiniteScrollLoader/InfiniteScrollLoader.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/InfiniteScrollLoader/InfiniteScrollLoader.tsx#L29) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/LoadingState/LoadingState/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/shared-components/LoadingState/LoadingState.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/LoadingState/LoadingState.tsx#L38) ## Parameters ### \_\_namedParameters [`InterfaceLoadingStateProps`](../../../../types/shared-components/LoadingState/interface/type-aliases/InterfaceLoadingStateProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/Navbar/Navbar/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/shared-components/Navbar/Navbar.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Navbar/Navbar.tsx#L56) ## Parameters ### \_\_namedParameters [`InterfacePageHeaderProps`](../../../../types/shared-components/Navbar/interface/interfaces/InterfacePageHeaderProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/NotificationToast/NotificationToast/functions/NotificationToastContainer.md ================================================ [Admin Docs](/) *** # Function: NotificationToastContainer() > **NotificationToastContainer**(`props`): `ReactElement` Defined in: [src/shared-components/NotificationToast/NotificationToast.tsx:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/NotificationToast/NotificationToast.tsx#L148) NotificationToastContainer Wrapper for `ToastContainer` with project defaults. Consumers can override any prop via `props`. ## Parameters ### props `ToastContainerProps` = `{}` Optional ToastContainerProps to override DEFAULT_CONTAINER_PROPS ## Returns `ReactElement` React.ReactElement rendering ToastContainer with merged props ================================================ FILE: docs/docs/auto-docs/shared-components/NotificationToast/NotificationToast/variables/NotificationToast.md ================================================ [Admin Docs](/) *** # Variable: NotificationToast > `const` **NotificationToast**: [`InterfaceNotificationToastHelpers`](../../../../types/shared-components/NotificationToast/interface/interfaces/InterfaceNotificationToastHelpers.md) Defined in: [src/shared-components/NotificationToast/NotificationToast.tsx:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/NotificationToast/NotificationToast.tsx#L126) NotificationToast A small wrapper around `react-toastify` that standardizes toast defaults and supports translating messages with an explicit i18n namespace. ## Examples ```ts NotificationToast.success('Saved'); ``` ```ts NotificationToast.error({ key: 'unknownError', namespace: 'errors' }); ``` ```ts NotificationToast.dismiss(); // Dismiss all active toasts ``` ================================================ FILE: docs/docs/auto-docs/shared-components/OrganizationCard/OrganizationCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/shared-components/OrganizationCard/OrganizationCard.tsx:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/OrganizationCard/OrganizationCard.tsx#L64) ## Parameters ### \_\_namedParameters [`InterfaceOrganizationCardPropsPG`](../interfaces/InterfaceOrganizationCardPropsPG.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/OrganizationCard/OrganizationCard/interfaces/InterfaceOrganizationCardPropsPG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationCardPropsPG Defined in: [src/shared-components/OrganizationCard/OrganizationCard.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/OrganizationCard/OrganizationCard.tsx#L60) ## Properties ### data > **data**: [`InterfaceOrganizationCardProps`](../../../../types/OrganizationCard/interface/interfaces/InterfaceOrganizationCardProps.md) Defined in: [src/shared-components/OrganizationCard/OrganizationCard.tsx:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/OrganizationCard/OrganizationCard.tsx#L61) ================================================ FILE: docs/docs/auto-docs/shared-components/PaginationList/PaginationList/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/shared-components/PaginationList/PaginationList.tsx:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PaginationList/PaginationList.tsx#L39) ## Parameters ### \_\_namedParameters [`InterfacePaginationListProps`](../../../../types/shared-components/PaginationList/interface/interfaces/InterfacePaginationListProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/PeopleTabNavbar/PeopleTabNavbar/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/shared-components/PeopleTabNavbar/PeopleTabNavbar.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabNavbar/PeopleTabNavbar.tsx#L53) ## Parameters ### \_\_namedParameters [`InterfacePeopleTabNavbarProps`](../../../../types/shared-components/PeopleTabNavbar/interface/interfaces/InterfacePeopleTabNavbarProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/PeopleTabNavbarButton/PeopleTabNavbarButton/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfacePeopleTabNavbar`](../../../../types/PeopleTab/interface/interfaces/InterfacePeopleTabNavbar.md)\> Defined in: [src/shared-components/PeopleTabNavbarButton/PeopleTabNavbarButton.tsx:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabNavbarButton/PeopleTabNavbarButton.tsx#L35) ================================================ FILE: docs/docs/auto-docs/shared-components/PeopleTabUserEvents/PeopleTabUserEvents/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfacePeopletabUserEventsProps`](../../../../types/PeopleTab/interface/interfaces/InterfacePeopletabUserEventsProps.md)\> Defined in: [src/shared-components/PeopleTabUserEvents/PeopleTabUserEvents.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabUserEvents/PeopleTabUserEvents.tsx#L46) ================================================ FILE: docs/docs/auto-docs/shared-components/PeopleTabUserOrganization/PeopleTabUserOrganizations/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfacePeopleTabUserOrganizationProps`](../../../../types/PeopleTab/interface/interfaces/InterfacePeopleTabUserOrganizationProps.md)\> Defined in: [src/shared-components/PeopleTabUserOrganization/PeopleTabUserOrganizations.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabUserOrganization/PeopleTabUserOrganizations.tsx#L43) ================================================ FILE: docs/docs/auto-docs/shared-components/PostViewModal/PostViewModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfacePostViewModalProps`](../../../../types/shared-components/PostViewModal/interface/interfaces/InterfacePostViewModalProps.md)\> Defined in: [src/shared-components/PostViewModal/PostViewModal.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PostViewModal/PostViewModal.tsx#L51) ================================================ FILE: docs/docs/auto-docs/shared-components/ProfileAvatarDisplay/ProfileAvatarDisplay/functions/ProfileAvatarDisplay.md ================================================ [Admin Docs](/) *** # Function: ProfileAvatarDisplay() > **ProfileAvatarDisplay**(`imageUrl`): `Element` Defined in: [src/shared-components/ProfileAvatarDisplay/ProfileAvatarDisplay.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ProfileAvatarDisplay/ProfileAvatarDisplay.tsx#L41) ProfileAvatarDisplay component renders a profile avatar based on the provided properties. It handles image loading errors and falls back to an initial-based avatar. ## Parameters ### imageUrl [`InterfaceProfileAvatarDisplayProps`](../../../../types/shared-components/ProfileAvatarDisplay/interface/interfaces/InterfaceProfileAvatarDisplayProps.md) The URL of the avatar image. ## Returns `Element` JSX.Element - The ProfileAvatarDisplay component. ## Example ``` ``` ================================================ FILE: docs/docs/auto-docs/shared-components/Recurrence/CustomRecurrenceModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceCustomRecurrenceModalProps`](../../../../types/Recurrence/interface/interfaces/InterfaceCustomRecurrenceModalProps.md)\> Defined in: [src/shared-components/Recurrence/CustomRecurrenceModal.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/CustomRecurrenceModal.tsx#L30) CustomRecurrenceModal Component A shared modal component for configuring custom recurrence rules for events. This component is used by both Admin and User portals via the shared EventForm. ================================================ FILE: docs/docs/auto-docs/shared-components/Recurrence/RecurrenceEndOptionsSection/variables/RecurrenceEndOptionsSection.md ================================================ [Admin Docs](/) *** # Variable: RecurrenceEndOptionsSection > `const` **RecurrenceEndOptionsSection**: `React.FC`\<[`InterfaceRecurrenceEndOptionsSectionProps`](../../../../types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceEndOptionsSectionProps.md)\> Defined in: [src/shared-components/Recurrence/RecurrenceEndOptionsSection.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceEndOptionsSection.tsx#L21) Recurrence end options section (never, on date, after count) ================================================ FILE: docs/docs/auto-docs/shared-components/Recurrence/RecurrenceFrequencySection/variables/RecurrenceFrequencySection.md ================================================ [Admin Docs](/) *** # Variable: RecurrenceFrequencySection > `const` **RecurrenceFrequencySection**: `React.FC`\<[`InterfaceRecurrenceFrequencySectionProps`](../../../../types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceFrequencySectionProps.md)\> Defined in: [src/shared-components/Recurrence/RecurrenceFrequencySection.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceFrequencySection.tsx#L11) Frequency and interval selection section ================================================ FILE: docs/docs/auto-docs/shared-components/Recurrence/RecurrenceMonthlySection/variables/RecurrenceMonthlySection.md ================================================ [Admin Docs](/) *** # Variable: RecurrenceMonthlySection > `const` **RecurrenceMonthlySection**: `React.FC`\<[`InterfaceRecurrenceMonthlySectionProps`](../../../../types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceMonthlySectionProps.md)\> Defined in: [src/shared-components/Recurrence/RecurrenceMonthlySection.tsx:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceMonthlySection.tsx#L10) Monthly recurrence options section ================================================ FILE: docs/docs/auto-docs/shared-components/Recurrence/RecurrenceWeeklySection/variables/RecurrenceWeeklySection.md ================================================ [Admin Docs](/) *** # Variable: RecurrenceWeeklySection > `const` **RecurrenceWeeklySection**: `React.FC`\<`InterfaceRecurrenceWeeklySectionProps`\> Defined in: [src/shared-components/Recurrence/RecurrenceWeeklySection.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceWeeklySection.tsx#L24) Weekly recurrence day selection section ================================================ FILE: docs/docs/auto-docs/shared-components/Recurrence/RecurrenceYearlySection/variables/RecurrenceYearlySection.md ================================================ [Admin Docs](/) *** # Variable: RecurrenceYearlySection > `const` **RecurrenceYearlySection**: `React.FC`\<`InterfaceRecurrenceYearlySectionProps`\> Defined in: [src/shared-components/Recurrence/RecurrenceYearlySection.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceYearlySection.tsx#L13) Yearly recurrence options section ================================================ FILE: docs/docs/auto-docs/shared-components/ReportingTable/ReportingTable/functions/adjustColumnsForCompactMode.md ================================================ [Admin Docs](/) *** # Function: adjustColumnsForCompactMode() > **adjustColumnsForCompactMode**(`columns`, `compactMode`): [`ReportingTableColumn`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableColumn.md)[] Defined in: [src/shared-components/ReportingTable/ReportingTable.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ReportingTable/ReportingTable.tsx#L23) Adjusts column widths for compact display mode. In compact mode: - First column gets flex: 0.5 and minWidth: space-10 (typically for row numbers) - Second column gets flex capped at 1.5 (typically for names) - Remaining columns are unchanged ## Parameters ### columns [`ReportingTableColumn`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableColumn.md)[] Original column definitions ### compactMode `boolean` Whether to apply compact adjustments ## Returns [`ReportingTableColumn`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableColumn.md)[] Adjusted column definitions ================================================ FILE: docs/docs/auto-docs/shared-components/ReportingTable/ReportingTable/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`ReportingTableProps`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableProps.md)\> Defined in: [src/shared-components/ReportingTable/ReportingTable.tsx:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ReportingTable/ReportingTable.tsx#L87) A flexible reporting table component that wraps MUI DataGrid with optional infinite scroll. ## Remarks This component provides a consistent table interface across the application with support for: - Standard DataGrid rendering for static data - Infinite scroll wrapper for paginated/lazy-loaded data - Customizable grid and scroll container properties - Compact column mode for tables with many columns (7+) ## Param Array of data rows to display in the table ## Param Column definitions following ReportingTableColumn structure ## Param Optional additional props passed directly to MUI DataGrid ## Param When provided, enables infinite scroll with dataLength, next, and hasMore ## Param Optional styling and behavior props for the InfiniteScroll container ## Returns A DataGrid wrapped in InfiniteScroll if infiniteProps is provided, otherwise a standalone DataGrid ## Example ```tsx // Basic usage without infinite scroll // With infinite scroll ``` ================================================ FILE: docs/docs/auto-docs/shared-components/SearchBar/SearchBar/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `ForwardRefExoticComponent`\<[`InterfaceSearchBarProps`](../../../../types/SearchBar/interface/interfaces/InterfaceSearchBarProps.md) & `RefAttributes`\<[`InterfaceSearchBarRef`](../../../../types/SearchBar/interface/interfaces/InterfaceSearchBarRef.md)\>\> Defined in: [src/shared-components/SearchBar/SearchBar.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SearchBar/SearchBar.tsx#L31) Shared SearchBar component that centralizes all search UI across the app. ## Remarks - Supports both controlled and uncontrolled usage. - Emits change, search, and clear callbacks for flexible data handling. - Offers multiple visual variants and sizes to match the Figma design tokens. ================================================ FILE: docs/docs/auto-docs/shared-components/SearchFilterBar/SearchFilterBar/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceSearchFilterBarProps`](../../../../types/shared-components/SearchFilterBar/interface/type-aliases/InterfaceSearchFilterBarProps.md)\> Defined in: [src/shared-components/SearchFilterBar/SearchFilterBar.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SearchFilterBar/SearchFilterBar.tsx#L20) SearchFilterBar component provides a unified search and filter interface. Supports search functionality with optional sorting and filtering dropdowns. Manages internal state for instant visual feedback while debouncing parent updates. Includes internal i18n support for accessibility and customizable translations. ## Param Component props based on discriminated union (simple or advanced variant) ## Returns The rendered SearchFilterBar component ================================================ FILE: docs/docs/auto-docs/shared-components/SidebarBase/SidebarBase/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `ReactElement` Defined in: [src/shared-components/SidebarBase/SidebarBase.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarBase/SidebarBase.tsx#L19) SidebarBase Component This is the foundational component for all sidebars in both Admin and User portals. It provides common functionality including toggle behavior, branding, and layout structure. ## Parameters ### props [`ISidebarBaseProps`](../../../../types/SidebarBase/interface/interfaces/ISidebarBaseProps.md) The props for the component ## Returns `ReactElement` The rendered SidebarBase component ================================================ FILE: docs/docs/auto-docs/shared-components/SidebarNavItem/SidebarNavItem/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `ReactElement` Defined in: [src/shared-components/SidebarNavItem/SidebarNavItem.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarNavItem/SidebarNavItem.tsx#L43) ## Parameters ### \_\_namedParameters [`ISidebarNavItemProps`](../../../../types/SidebarNavItem/interface/interfaces/ISidebarNavItemProps.md) ## Returns `ReactElement` ================================================ FILE: docs/docs/auto-docs/shared-components/SidebarOrgSection/SidebarOrgSection/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `ReactElement`\<`unknown`, `string` \| `JSXElementConstructor`\<`any`\>\> Defined in: [src/shared-components/SidebarOrgSection/SidebarOrgSection.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarOrgSection/SidebarOrgSection.tsx#L38) ## Parameters ### \_\_namedParameters [`ISidebarOrgSectionProps`](../../../../types/shared-components/SidebarOrgSection/interface/interfaces/ISidebarOrgSectionProps.md) ## Returns `ReactElement`\<`unknown`, `string` \| `JSXElementConstructor`\<`any`\>\> ================================================ FILE: docs/docs/auto-docs/shared-components/SidebarPluginSection/SidebarPluginSection/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `ReactElement`\<`unknown`, `string` \| `JSXElementConstructor`\<`any`\>\> Defined in: [src/shared-components/SidebarPluginSection/SidebarPluginSection.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarPluginSection/SidebarPluginSection.tsx#L29) ## Parameters ### \_\_namedParameters [`ISidebarPluginSectionProps`](../../../../types/SidebarPluginSection/interface/interfaces/ISidebarPluginSectionProps.md) ## Returns `ReactElement`\<`unknown`, `string` \| `JSXElementConstructor`\<`any`\>\> ================================================ FILE: docs/docs/auto-docs/shared-components/SortingButton/SortingButton/namespaces/default/variables/propTypes.md ================================================ [Admin Docs](/) *** # Variable: propTypes > **propTypes**: `any` Defined in: [src/shared-components/SortingButton/SortingButton.tsx:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SortingButton/SortingButton.tsx#L76) ================================================ FILE: docs/docs/auto-docs/shared-components/SortingButton/SortingButton/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceSortingButtonProps`](../../../../types/shared-components/SortingButton/interface/interfaces/InterfaceSortingButtonProps.md)\> Defined in: [src/shared-components/SortingButton/SortingButton.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SortingButton/SortingButton.tsx#L18) SortingButton component renders a Dropdown with sorting options. It allows users to select a sorting option and triggers a callback on selection. Includes accessibility support for screen readers. ## Param The properties for the SortingButton component. ## Returns The rendered SortingButton component. ================================================ FILE: docs/docs/auto-docs/shared-components/StatusBadge/StatusBadge/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceStatusBadgeProps`](../../../../types/shared-components/StatusBadge/interface/interfaces/InterfaceStatusBadgeProps.md)\> Defined in: [src/shared-components/StatusBadge/StatusBadge.tsx:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/StatusBadge/StatusBadge.tsx#L69) StatusBadge component for displaying status information with consistent styling. This component wraps MUI Chip and provides: - Domain-to-semantic variant mapping (e.g., 'completed' implies 'success') - Three size variants: sm (20px), md (24px), lg (32px) - Internationalization support with fallback keys (statusBadge.variant) - Accessibility features (role="status", aria-label) - Optional icon and label customization ## Param Component properties ## Returns A styled badge component with semantic coloring ## Example ```tsx // Basic usage // With size and icon } /> // With custom label ``` ================================================ FILE: docs/docs/auto-docs/shared-components/TableLoader/TableLoader/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`props`): `Element` Defined in: [src/shared-components/TableLoader/TableLoader.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/TableLoader/TableLoader.tsx#L30) ## Parameters ### props [`InterfaceTableLoaderProps`](../../../../types/shared-components/TableLoader/interface/interfaces/InterfaceTableLoaderProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/TimePicker/TimePicker/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceTimePickerProps`](../../../../types/shared-components/TimePicker/interface/interfaces/InterfaceTimePickerProps.md)\> Defined in: [src/shared-components/TimePicker/TimePicker.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/TimePicker/TimePicker.tsx#L30) TimePicker wrapper component that integrates MUI TimePicker with react-bootstrap styling. This component provides a standardized time picker interface that maintains consistency across the application by using react-bootstrap Form.Control for styling. ## Param The component props. ## Example ```tsx ``` ================================================ FILE: docs/docs/auto-docs/shared-components/TruncatedText/TruncatedText/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceTruncatedTextProps`](../../../../types/shared-components/TruncatedText/interface/interfaces/InterfaceTruncatedTextProps.md)\> Defined in: [src/shared-components/TruncatedText/TruncatedText.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/TruncatedText/TruncatedText.tsx#L25) ================================================ FILE: docs/docs/auto-docs/shared-components/VolunteerGroupViewModal/VolunteerGroupViewModal/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfaceVolunteerGroupViewModalProps`](../../../../types/shared-components/VolunteerGroupViewModal/interface/interfaces/InterfaceVolunteerGroupViewModalProps.md)\> Defined in: [src/shared-components/VolunteerGroupViewModal/VolunteerGroupViewModal.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/VolunteerGroupViewModal/VolunteerGroupViewModal.tsx#L54) ================================================ FILE: docs/docs/auto-docs/shared-components/pinnedPosts/pinnedPostCard/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfacePinnedPostCardProps`](../../../../types/Post/interface/interfaces/InterfacePinnedPostCardProps.md)\> Defined in: [src/shared-components/pinnedPosts/pinnedPostCard.tsx:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/pinnedPosts/pinnedPostCard.tsx#L66) ================================================ FILE: docs/docs/auto-docs/shared-components/pinnedPosts/pinnedPostsLayout/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`InterfacePinnedPostsLayoutProps`](../../../../types/Post/interface/interfaces/InterfacePinnedPostsLayoutProps.md)\> Defined in: [src/shared-components/pinnedPosts/pinnedPostsLayout.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/pinnedPosts/pinnedPostsLayout.tsx#L41) ================================================ FILE: docs/docs/auto-docs/shared-components/postCard/PostCard/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/shared-components/postCard/PostCard.tsx:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/postCard/PostCard.tsx#L61) ## Parameters ### \_\_namedParameters [`InterfacePostCard`](../../../../utils/interfaces/interfaces/InterfacePostCard.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/posts/createPostModal/createPostModal/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined 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) ## Parameters ### \_\_namedParameters [`ICreatePostModalProps`](../../../../../types/Post/interface/interfaces/ICreatePostModalProps.md) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/posts/helperFunctions/functions/formatPostForCard.md ================================================ [Admin Docs](/) *** # Function: formatPostForCard() > **formatPostForCard**(`post`, `t`, `refetch`): `Omit`\<[`InterfacePostCard`](../../../../utils/interfaces/interfaces/InterfacePostCard.md), `"image"` \| `"video"`\> Defined in: [src/shared-components/posts/helperFunctions.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/posts/helperFunctions.ts#L25) Formats a post object to match the PostCard component's expected interface. This function transforms a raw post object from the GraphQL API into the format required by the PostCard component, handling missing values with appropriate fallbacks and formatting dates safely. ## Parameters ### post [`InterfacePost`](../../../../types/Post/interface/interfaces/InterfacePost.md) The raw post object from the API ### t (`key`) => `string` Translation function for internationalized text ### refetch () => `Promise`\<`unknown`\> Function to refetch posts data, typically from Apollo Client ## Returns `Omit`\<[`InterfacePostCard`](../../../../utils/interfaces/interfaces/InterfacePostCard.md), `"image"` \| `"video"`\> An object formatted to match the InterfacePostCard interface ## Example ```tsx const formattedPost = formatPostForCard(rawPost, t, refetch); ``` ================================================ FILE: docs/docs/auto-docs/shared-components/posts/posts/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/shared-components/posts/posts.tsx:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/posts/posts.tsx#L74) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/shared-components/useDebounce/useDebounce/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**\<`T`\>(`callback`, `delay`): `object` Defined in: [src/shared-components/useDebounce/useDebounce.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/useDebounce/useDebounce.tsx#L21) ## Type Parameters ### T `T` *extends* (...`args`) => `void` ## Parameters ### callback `T` ### delay `number` ## Returns `object` ### cancel() > **cancel**: () => `void` #### Returns `void` ### debouncedCallback() > **debouncedCallback**: (...`args`) => `void` #### Parameters ##### args ...`Parameters`\<`T`\> #### Returns `void` ================================================ FILE: docs/docs/auto-docs/state/action-creators/functions/updateTargets.md ================================================ [Admin Docs](/) *** # Function: updateTargets() > **updateTargets**(`orgId`): (`dispatch`) => `void` Defined in: [src/state/action-creators/index.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/action-creators/index.ts#L3) ## Parameters ### orgId `string` ## Returns > (`dispatch`): `void` ### Parameters #### dispatch `Dispatch` ### Returns `void` ================================================ FILE: docs/docs/auto-docs/state/helpers/Action/interfaces/InterfaceAction.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAction\ Defined in: [src/state/helpers/Action.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/helpers/Action.ts#L1) ## Type Parameters ### T `T` = `unknown` ## Properties ### payload > **payload**: `T` Defined in: [src/state/helpers/Action.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/helpers/Action.ts#L3) *** ### type > **type**: `string` Defined in: [src/state/helpers/Action.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/helpers/Action.ts#L2) ================================================ FILE: docs/docs/auto-docs/state/hooks/variables/useAppDispatch.md ================================================ [Admin Docs](/) *** # Variable: useAppDispatch > `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`\>\>\> Defined in: [src/state/hooks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/hooks.ts#L5) ================================================ FILE: docs/docs/auto-docs/state/reducers/routesReducer/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`state`, `action`): `object` Defined in: [src/state/reducers/routesReducer.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L16) ## Parameters ### state #### components [`ComponentType`](../type-aliases/ComponentType.md)[] #### targets [`TargetsType`](../type-aliases/TargetsType.md)[] = `...` ### action [`InterfaceAction`](../../../helpers/Action/interfaces/InterfaceAction.md) ## Returns `object` ### components > **components**: [`ComponentType`](../type-aliases/ComponentType.md)[] ### targets > **targets**: [`TargetsType`](../type-aliases/TargetsType.md)[] ================================================ FILE: docs/docs/auto-docs/state/reducers/routesReducer/functions/generateRoutes.md ================================================ [Admin Docs](/) *** # Function: generateRoutes() > **generateRoutes**(`comps`, `currentOrg?`): [`TargetsType`](../type-aliases/TargetsType.md)[] Defined in: [src/state/reducers/routesReducer.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L69) ## Parameters ### comps [`ComponentType`](../type-aliases/ComponentType.md)[] ### currentOrg? `string` ## Returns [`TargetsType`](../type-aliases/TargetsType.md)[] ================================================ FILE: docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/ComponentType.md ================================================ [Admin Docs](/) *** # Type Alias: ComponentType > **ComponentType** = `object` Defined in: [src/state/reducers/routesReducer.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L34) ## Properties ### comp\_id > **comp\_id**: `string` \| `null` Defined in: [src/state/reducers/routesReducer.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L36) *** ### component > **component**: `string` \| `null` Defined in: [src/state/reducers/routesReducer.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L37) *** ### name > **name**: `string` Defined in: [src/state/reducers/routesReducer.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L35) *** ### subTargets? > `optional` **subTargets**: `object`[] Defined in: [src/state/reducers/routesReducer.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L38) #### comp\_id > **comp\_id**: `string` #### component > **component**: `string` #### icon? > `optional` **icon**: `string` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/SubTargetType.md ================================================ [Admin Docs](/) *** # Type Alias: SubTargetType > **SubTargetType** = `object` Defined in: [src/state/reducers/routesReducer.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L9) ## Properties ### comp\_id? > `optional` **comp\_id**: `string` Defined in: [src/state/reducers/routesReducer.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L13) *** ### icon? > `optional` **icon**: `string` Defined in: [src/state/reducers/routesReducer.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L12) *** ### name? > `optional` **name**: `string` Defined in: [src/state/reducers/routesReducer.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L10) *** ### url > **url**: `string` Defined in: [src/state/reducers/routesReducer.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L11) ================================================ FILE: docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/TargetsType.md ================================================ [Admin Docs](/) *** # Type Alias: TargetsType > **TargetsType** = `object` Defined in: [src/state/reducers/routesReducer.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L3) ## Properties ### name > **name**: `string` Defined in: [src/state/reducers/routesReducer.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L4) *** ### subTargets? > `optional` **subTargets**: [`SubTargetType`](SubTargetType.md)[] Defined in: [src/state/reducers/routesReducer.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L6) *** ### url? > `optional` **url**: `string` Defined in: [src/state/reducers/routesReducer.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L5) ================================================ FILE: docs/docs/auto-docs/state/reducers/type-aliases/RootState.md ================================================ [Admin Docs](/) *** # Type Alias: RootState > **RootState** = `ReturnType`\<*typeof* [`reducers`](../variables/reducers.md)\> Defined in: [src/state/reducers/index.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/index.ts#L10) ================================================ FILE: docs/docs/auto-docs/state/reducers/userRoutesReducer/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`state`, `action`): `object` Defined in: [src/state/reducers/userRoutesReducer.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L17) ## Parameters ### state #### components [`ComponentType`](../type-aliases/ComponentType.md)[] #### targets [`TargetsType`](../type-aliases/TargetsType.md)[] = `...` ### action [`InterfaceAction`](../../../helpers/Action/interfaces/InterfaceAction.md) ## Returns `object` ### components > **components**: [`ComponentType`](../type-aliases/ComponentType.md)[] ### targets > **targets**: [`TargetsType`](../type-aliases/TargetsType.md)[] ================================================ FILE: docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/ComponentType.md ================================================ [Admin Docs](/) *** # Type Alias: ComponentType > **ComponentType** = `object` Defined in: [src/state/reducers/userRoutesReducer.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L33) ## Properties ### comp\_id > **comp\_id**: `string` \| `null` Defined in: [src/state/reducers/userRoutesReducer.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L35) *** ### component > **component**: `string` \| `null` Defined in: [src/state/reducers/userRoutesReducer.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L36) *** ### name > **name**: `string` Defined in: [src/state/reducers/userRoutesReducer.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L34) *** ### subTargets? > `optional` **subTargets**: `object`[] Defined in: [src/state/reducers/userRoutesReducer.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L37) #### comp\_id > **comp\_id**: `string` #### component > **component**: `string` #### icon? > `optional` **icon**: `string` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/SubTargetType.md ================================================ [Admin Docs](/) *** # Type Alias: SubTargetType > **SubTargetType** = `object` Defined in: [src/state/reducers/userRoutesReducer.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L10) ## Properties ### comp\_id? > `optional` **comp\_id**: `string` Defined in: [src/state/reducers/userRoutesReducer.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L14) *** ### icon? > `optional` **icon**: `string` Defined in: [src/state/reducers/userRoutesReducer.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L13) *** ### name? > `optional` **name**: `string` Defined in: [src/state/reducers/userRoutesReducer.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L11) *** ### url > **url**: `string` Defined in: [src/state/reducers/userRoutesReducer.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L12) ================================================ FILE: docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/TargetsType.md ================================================ [Admin Docs](/) *** # Type Alias: TargetsType > **TargetsType** = `object` Defined in: [src/state/reducers/userRoutesReducer.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L4) ## Properties ### name > **name**: `string` Defined in: [src/state/reducers/userRoutesReducer.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L5) *** ### subTargets? > `optional` **subTargets**: [`SubTargetType`](SubTargetType.md)[] Defined in: [src/state/reducers/userRoutesReducer.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L7) *** ### url? > `optional` **url**: `string` Defined in: [src/state/reducers/userRoutesReducer.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L6) ================================================ FILE: docs/docs/auto-docs/state/reducers/variables/reducers.md ================================================ [Admin Docs](/) *** # Variable: reducers > `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`; \}\>\> Defined in: [src/state/reducers/index.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/index.ts#L5) ================================================ FILE: docs/docs/auto-docs/state/store/type-aliases/AppDispatch.md ================================================ [Admin Docs](/) *** # Type Alias: AppDispatch > **AppDispatch** = *typeof* `store.dispatch` Defined in: [src/state/store.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/store.ts#L8) ================================================ FILE: docs/docs/auto-docs/state/store/variables/store.md ================================================ [Admin Docs](/) *** # Variable: store > `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`\]\>\> Defined in: [src/state/store.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/store.ts#L4) ================================================ FILE: docs/docs/auto-docs/test-utils/AsyncComponent/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/test-utils/AsyncComponent.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/AsyncComponent.tsx#L12) ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/test-utils/ComplexLoader/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/test-utils/ComplexLoader.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/ComplexLoader.tsx#L11) ComplexLoader test utility component. Simulates a skeleton style loader with multiple shimmer elements to verify layout and rendering behavior. ## Returns `Element` JSX.Element ================================================ FILE: docs/docs/auto-docs/test-utils/CustomDashboardLoader/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/test-utils/CustomDashboardLoader.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/CustomDashboardLoader.tsx#L11) CustomDashboardLoader test utility component. Renders multiple placeholder items to emulate a dashboard loading state for testing LoadingState custom loaders. ## Returns `Element` JSX.Element ================================================ FILE: docs/docs/auto-docs/test-utils/CustomLoader/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `Element` Defined in: [src/test-utils/CustomLoader.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/CustomLoader.tsx#L11) CustomLoader test utility component. Provides a minimal loader element used for testing the LoadingState custom variant rendering behavior. ## Returns `Element` JSX.Element ================================================ FILE: docs/docs/auto-docs/test-utils/I18nextProviderMock/functions/I18nextProvider.md ================================================ [Admin Docs](/) *** # Function: I18nextProvider() > **I18nextProvider**(`__namedParameters`): `Element` Defined in: [src/test-utils/I18nextProviderMock.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/I18nextProviderMock.tsx#L14) ## Parameters ### \_\_namedParameters #### children `ReactNode` #### i18n `i18n` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/test-utils/MockBrowserRouter/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(`__namedParameters`): `Element` Defined in: [src/test-utils/MockBrowserRouter.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/MockBrowserRouter.tsx#L12) ## Parameters ### \_\_namedParameters #### children `ReactNode` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/test-utils/TestErrorBoundary/classes/TestErrorBoundary.md ================================================ [Admin Docs](/) *** # Class: TestErrorBoundary Defined in: [src/test-utils/TestErrorBoundary.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L22) ## Extends - `Component`\<`TestInterfaceErrorBoundaryProps`, `TestInterfaceErrorBoundaryState`\> ## Constructors ### Constructor > **new TestErrorBoundary**(`props`): `TestErrorBoundary` Defined in: [src/test-utils/TestErrorBoundary.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L26) #### Parameters ##### props `TestInterfaceErrorBoundaryProps` #### Returns `TestErrorBoundary` #### Overrides `React.Component< TestInterfaceErrorBoundaryProps, TestInterfaceErrorBoundaryState >.constructor` ## Methods ### render() > **render**(): `ReactNode` Defined in: [src/test-utils/TestErrorBoundary.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L43) #### Returns `ReactNode` #### Overrides `React.Component.render` *** ### getDerivedStateFromError() > `static` **getDerivedStateFromError**(`error`): `TestInterfaceErrorBoundaryState` Defined in: [src/test-utils/TestErrorBoundary.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L34) #### Parameters ##### error `Error` #### Returns `TestInterfaceErrorBoundaryState` ================================================ FILE: docs/docs/auto-docs/test-utils/TestWrapper/functions/TestWrapper.md ================================================ [Admin Docs](/) *** # Function: TestWrapper() > **TestWrapper**(`__namedParameters`): `Element` Defined in: [src/test-utils/TestWrapper.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestWrapper.tsx#L51) ## Parameters ### \_\_namedParameters `InterfaceTestWrapperProps` ## Returns `Element` ================================================ FILE: docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/cleanupTempDirs.md ================================================ [Admin Docs](/) *** # Function: cleanupTempDirs() > **cleanupTempDirs**(): `void` Defined 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) ## Returns `void` ================================================ FILE: docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/makeTempDir.md ================================================ [Admin Docs](/) *** # Function: makeTempDir() > **makeTempDir**(): `string` Defined 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) ## Returns `string` ================================================ FILE: docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/runScript.md ================================================ [Admin Docs](/) *** # Function: runScript() > **runScript**(`targets`, `options`): `SpawnSyncReturns`\<`string`\> Defined 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) ## Parameters ### targets `any` ### options ## Returns `SpawnSyncReturns`\<`string`\> ================================================ FILE: docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/writeTempFile.md ================================================ [Admin Docs](/) *** # Function: writeTempFile() > **writeTempFile**(`dir`, `relPath`, `content`): `string` Defined 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) ## Parameters ### dir `any` ### relPath `any` ### content `any` ## Returns `string` ================================================ FILE: docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/variables/fixturesDir.md ================================================ [Admin Docs](/) *** # Variable: fixturesDir > `const` **fixturesDir**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/variables/scriptPath.md ================================================ [Admin Docs](/) *** # Variable: scriptPath > `const` **scriptPath**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/localStorageMock/functions/createLocalStorageMock.md ================================================ [Admin Docs](/) *** # Function: createLocalStorageMock() > **createLocalStorageMock**(): `Storage` Defined in: [src/test-utils/localStorageMock.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/localStorageMock.ts#L12) Creates an in-memory localStorage mock for test isolation Prevents tests from interfering with each other or real browser storage ## Returns `Storage` Storage - Mock implementation of the Storage interface ## Example ```ts const mockStorage = createLocalStorageMock(); mockStorage.setItem('key', 'value'); expect(mockStorage.getItem('key')).toBe('value'); mockStorage.clear(); ``` ================================================ FILE: docs/docs/auto-docs/test-utils/localStorageMock/functions/setupLocalStorageMock.md ================================================ [Admin Docs](/) *** # Function: setupLocalStorageMock() > **setupLocalStorageMock**(): `Storage` Defined in: [src/test-utils/localStorageMock.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/localStorageMock.ts#L54) Setup localStorage mock for tests Configures window.localStorage with a mock implementation for test isolation ## Returns `Storage` Storage - The configured localStorage mock instance ## Example ```ts // In your test file's setup: const localStorageMock = setupLocalStorageMock(); afterEach(() => { localStorageMock.clear(); }); // Then in your tests: window.localStorage.setItem('token', 'abc123'); expect(window.localStorage.getItem('token')).toBe('abc123'); ``` ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/Dropdown/variables/Dropdown.md ================================================ [Admin Docs](/) *** # Variable: Dropdown > `const` **Dropdown**: [`InterfaceDropdown`](../../types/interfaces/InterfaceDropdown.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownBase/type-aliases/DivProps.md ================================================ [Admin Docs](/) *** # Type Alias: DivProps > **DivProps** = `React.PropsWithChildren`\<`React.HTMLAttributes`\<`HTMLDivElement`\>\> Defined 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) Base container for the mocked Dropdown. Acts as the root wrapper and simply renders its children inside a div. Kept minimal because it's only used in tests. ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownBase/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`DivProps`](../type-aliases/DivProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownItem/type-aliases/BtnProps.md ================================================ [Admin Docs](/) *** # Type Alias: BtnProps > **BtnProps** = `React.PropsWithChildren`\<`React.ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `object`\> Defined 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) Mock Dropdown.Item - renders a button representing an item inside a Dropdown.Menu. For tests we simply forward onClick and any provided props. ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownItem/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`BtnProps`](../type-aliases/BtnProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownMenu/type-aliases/DivProps.md ================================================ [Admin Docs](/) *** # Type Alias: DivProps > **DivProps** = `React.PropsWithChildren`\<`React.HTMLAttributes`\<`HTMLDivElement`\>\> Defined 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) Mock Dropdown.Menu - simple container used to wrap dropdown items within tests. Keeps behavior minimal and predictable. ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownMenu/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`DivProps`](../type-aliases/DivProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownToggle/type-aliases/BtnProps.md ================================================ [Admin Docs](/) *** # Type Alias: BtnProps > **BtnProps** = `React.PropsWithChildren`\<`React.ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `object`\> Defined 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) Mock Dropdown.Toggle - renders a button and forwards onClick and any props. Provides a `data-testid` default of `dropdown` unless overridden. Used by tests that expect a clickable toggle element. ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownToggle/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `React.FC`\<[`BtnProps`](../type-aliases/BtnProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/types/interfaces/InterfaceDropdown.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDropdown() Defined 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) ## Extends - `FC`\<[`DivProps`](../type-aliases/DivProps.md)\> > **InterfaceDropdown**(`props`): `ReactNode` \| `Promise`\<`ReactNode`\> Defined 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) ## Parameters ### props [`DivProps`](../type-aliases/DivProps.md) ## Returns `ReactNode` \| `Promise`\<`ReactNode`\> ## Properties ### Item > **Item**: `FC`\<[`BtnProps`](../type-aliases/BtnProps.md)\> Defined 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) *** ### Menu > **Menu**: `FC`\<[`DivProps`](../type-aliases/DivProps.md)\> Defined 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) *** ### Toggle > **Toggle**: `FC`\<[`BtnProps`](../type-aliases/BtnProps.md)\> Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/types/type-aliases/BtnProps.md ================================================ [Admin Docs](/) *** # Type Alias: BtnProps > **BtnProps** = `React.PropsWithChildren`\<`React.ButtonHTMLAttributes`\<`HTMLButtonElement`\> & `object`\> Defined 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) ================================================ FILE: docs/docs/auto-docs/test-utils/mocks/react-bootstrap/types/type-aliases/DivProps.md ================================================ [Admin Docs](/) *** # Type Alias: DivProps > **DivProps** = `React.PropsWithChildren`\<`React.HTMLAttributes`\<`HTMLDivElement`\>\> Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/interface/interfaces/InterfaceAddOnEntryProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAddOnEntryProps Defined in: [src/types/AdminPortal/Advertisement/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L32) ## Properties ### attachments? > `optional` **attachments**: [`AdvertisementAttachment`](../../type/type-aliases/AdvertisementAttachment.md)[] Defined in: [src/types/AdminPortal/Advertisement/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L40) *** ### endAt? > `optional` **endAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L39) *** ### existingAttachments? > `optional` **existingAttachments**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L35) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L33) *** ### name? > `optional` **name**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L34) *** ### organizationId? > `optional` **organizationId**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L37) *** ### setAfter > **setAfter**: `Dispatch`\<`SetStateAction`\<`string`\>\> Defined in: [src/types/AdminPortal/Advertisement/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L41) *** ### startAt? > `optional` **startAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L38) *** ### type? > `optional` **type**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L36) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/interface/interfaces/InterfaceAddOnRegisterProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAddOnRegisterProps Defined in: [src/types/AdminPortal/Advertisement/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L3) ## Properties ### createdBy? > `optional` **createdBy**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L10) *** ### descriptionEdit? > `optional` **descriptionEdit**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L8) *** ### endAtEdit? > `optional` **endAtEdit**: `Date` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L11) *** ### formStatus? > `optional` **formStatus**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L4) *** ### id? > `optional` **id**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L9) *** ### idEdit? > `optional` **idEdit**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L5) *** ### nameEdit? > `optional` **nameEdit**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L6) *** ### setAfterActive > **setAfterActive**: `Dispatch`\<`SetStateAction`\<`string`\>\> Defined in: [src/types/AdminPortal/Advertisement/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L13) *** ### setAfterCompleted > **setAfterCompleted**: `Dispatch`\<`SetStateAction`\<`string`\>\> Defined in: [src/types/AdminPortal/Advertisement/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L16) *** ### startAtEdit? > `optional` **startAtEdit**: `Date` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L12) *** ### typeEdit? > `optional` **typeEdit**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L7) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/interface/interfaces/InterfaceFormStateTypes.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormStateTypes Defined in: [src/types/AdminPortal/Advertisement/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L21) ## Properties ### attachments > **attachments**: `File`[] Defined in: [src/types/AdminPortal/Advertisement/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L28) *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L25) *** ### endAt > **endAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L26) *** ### existingAttachments? > `optional` **existingAttachments**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L29) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L22) *** ### organizationId? > `optional` **organizationId**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L27) *** ### startAt > **startAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L24) *** ### type > **type**: `string` Defined in: [src/types/AdminPortal/Advertisement/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L23) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/type/enumerations/AdvertisementType.md ================================================ [Admin Docs](/) *** # Enumeration: AdvertisementType Defined in: [src/types/AdminPortal/Advertisement/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L5) ## Enumeration Members ### Banner > **Banner**: `"banner"` Defined in: [src/types/AdminPortal/Advertisement/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L6) *** ### Menu > **Menu**: `"menu"` Defined in: [src/types/AdminPortal/Advertisement/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L7) *** ### Popup > **Popup**: `"pop_up"` Defined in: [src/types/AdminPortal/Advertisement/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L8) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/Advertisement.md ================================================ [Admin Docs](/) *** # Type Alias: Advertisement > **Advertisement** = `object` Defined in: [src/types/AdminPortal/Advertisement/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L12) ## Properties ### attachments? > `optional` **attachments**: [`AdvertisementAttachment`](AdvertisementAttachment.md)[] Defined in: [src/types/AdminPortal/Advertisement/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L26) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/type.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L14) *** ### creator? > `optional` **creator**: [`User`](../../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/Advertisement/type.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L16) *** ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L15) *** ### endAt > **endAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/type.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L20) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L13) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L21) *** ### organization > **organization**: `object` Defined in: [src/types/AdminPortal/Advertisement/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L17) #### id > **id**: `string` *** ### orgId > **orgId**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L22) *** ### startAt > **startAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L23) *** ### type > **type**: [`AdvertisementType`](../enumerations/AdvertisementType.md) Defined in: [src/types/AdminPortal/Advertisement/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L24) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L25) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/AdvertisementAttachment.md ================================================ [Admin Docs](/) *** # Type Alias: AdvertisementAttachment > **AdvertisementAttachment** = `object` Defined in: [src/types/AdminPortal/Advertisement/type.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L30) ## Properties ### mimeType > **mimeType**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L32) *** ### url > **url**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L31) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/AdvertisementEdge.md ================================================ [Admin Docs](/) *** # Type Alias: AdvertisementEdge > **AdvertisementEdge** = `object` Defined in: [src/types/AdminPortal/Advertisement/type.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L35) ## Properties ### cursor? > `optional` **cursor**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L36) *** ### node? > `optional` **node**: [`Advertisement`](Advertisement.md) Defined in: [src/types/AdminPortal/Advertisement/type.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L37) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/AdvertisementsConnection.md ================================================ [Admin Docs](/) *** # Type Alias: AdvertisementsConnection > **AdvertisementsConnection** = `object` Defined in: [src/types/AdminPortal/Advertisement/type.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L40) ## Properties ### edges? > `optional` **edges**: [`AdvertisementEdge`](AdvertisementEdge.md)[] Defined in: [src/types/AdminPortal/Advertisement/type.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L41) *** ### pageInfo? > `optional` **pageInfo**: [`DefaultConnectionPageInfo`](../../../pagination/type-aliases/DefaultConnectionPageInfo.md) Defined in: [src/types/AdminPortal/Advertisement/type.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L42) *** ### totalCount? > `optional` **totalCount**: `number` Defined in: [src/types/AdminPortal/Advertisement/type.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L43) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/CreateAdvertisementInput.md ================================================ [Admin Docs](/) *** # Type Alias: CreateAdvertisementInput > **CreateAdvertisementInput** = `object` Defined in: [src/types/AdminPortal/Advertisement/type.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L46) ## Properties ### attachments > **attachments**: `File`[] Defined in: [src/types/AdminPortal/Advertisement/type.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L53) *** ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L48) *** ### endAt > **endAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/type.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L52) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L47) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/AdminPortal/Advertisement/type.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L50) *** ### startAt > **startAt**: `Date` Defined in: [src/types/AdminPortal/Advertisement/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L51) *** ### type > **type**: [`AdvertisementType`](../enumerations/AdvertisementType.md) Defined in: [src/types/AdminPortal/Advertisement/type.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L49) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/CreateAdvertisementPayload.md ================================================ [Admin Docs](/) *** # Type Alias: CreateAdvertisementPayload > **CreateAdvertisementPayload** = `object` Defined in: [src/types/AdminPortal/Advertisement/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L56) ## Properties ### advertisement? > `optional` **advertisement**: [`Advertisement`](Advertisement.md) Defined in: [src/types/AdminPortal/Advertisement/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L57) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaDragAndDropProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaDragAndDropProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:304](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L304) Props for the AgendaDragAndDrop component. Defines the data and callback handlers required to render agenda folders and agenda items with drag-and-drop support, along with edit, preview, and delete actions. ## Properties ### agendaFolderConnection > **agendaFolderConnection**: `"Organization"` \| `"Event"` Defined in: [src/types/AdminPortal/Agenda/interface.ts:307](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L307) *** ### folders > **folders**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:305](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L305) *** ### onDeleteFolder() > **onDeleteFolder**: (`folder`) => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L311) #### Parameters ##### folder [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md) #### Returns `void` *** ### onDeleteItem() > **onDeleteItem**: (`item`) => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L315) #### Parameters ##### item [`InterfaceAgendaItemInfo`](InterfaceAgendaItemInfo.md) #### Returns `void` *** ### onEditFolder() > **onEditFolder**: (`folder`) => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:310](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L310) #### Parameters ##### folder [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md) #### Returns `void` *** ### onEditItem() > **onEditItem**: (`item`) => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:314](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L314) #### Parameters ##### item [`InterfaceAgendaItemInfo`](InterfaceAgendaItemInfo.md) #### Returns `void` *** ### onPreviewItem() > **onPreviewItem**: (`item`) => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:313](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L313) #### Parameters ##### item [`InterfaceAgendaItemInfo`](InterfaceAgendaItemInfo.md) #### Returns `void` *** ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L316) #### Returns `void` *** ### setFolders > **setFolders**: `Dispatch`\<`SetStateAction`\<[`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[]\>\> Defined in: [src/types/AdminPortal/Agenda/interface.ts:306](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L306) *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:308](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L308) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderCreateFormStateType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaFolderCreateFormStateType Defined in: [src/types/AdminPortal/Agenda/interface.ts:222](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L222) ## Properties ### creator > **creator**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:226](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L226) #### name > **name**: `string` *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:225](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L225) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:223](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L223) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:224](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L224) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderCreateModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaFolderCreateModalProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:231](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L231) ## Properties ### agendaFolderData > **agendaFolderData**: [`InterfaceAgendaFolderList`](InterfaceAgendaFolderList.md) Defined in: [src/types/AdminPortal/Agenda/interface.ts:235](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L235) *** ### eventId > **eventId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L234) *** ### hide() > **hide**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:233](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L233) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L232) *** ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:237](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L237) #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L236) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderDeleteModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaFolderDeleteModalProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:213](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L213) Props for the AgendaFolderDeleteModal component. ## Properties ### agendaFolderId > **agendaFolderId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:216](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L216) *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:214](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L214) *** ### onClose() > **onClose**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:215](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L215) #### Returns `void` *** ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L217) #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L218) #### Parameters ##### key `string` #### Returns `string` *** ### tCommon() > **tCommon**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:219](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L219) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaFolderInfo Defined in: [src/types/AdminPortal/Agenda/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L68) Defines the structure for agenda folder information. Represents a folder/section containing grouped agenda items for an event. ## Properties ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L71) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L69) *** ### isDefaultFolder? > `optional` **isDefaultFolder**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L74) *** ### items > **items**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L75) #### edges > **edges**: `object`[] *** ### key? > `optional` **key**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L73) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L70) *** ### sequence > **sequence**: `number` Defined in: [src/types/AdminPortal/Agenda/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L72) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderList.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaFolderList Defined in: [src/types/AdminPortal/Agenda/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L120) Defines the structure for a list of agenda folders by event. ## Properties ### agendaFoldersByEventId > **agendaFoldersByEventId**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L121) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderUpdateFormStateType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaFolderUpdateFormStateType Defined in: [src/types/AdminPortal/Agenda/interface.ts:240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L240) ## Properties ### creator > **creator**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:244](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L244) #### id > **id**: `string` #### name > **name**: `string` *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L243) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:241](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L241) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L242) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderUpdateModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaFolderUpdateModalProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:250](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L250) ## Properties ### agendaFolderId > **agendaFolderId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:253](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L253) *** ### folderFormState > **folderFormState**: [`InterfaceAgendaFolderUpdateFormStateType`](InterfaceAgendaFolderUpdateFormStateType.md) Defined in: [src/types/AdminPortal/Agenda/interface.ts:254](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L254) *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L251) *** ### onClose() > **onClose**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L252) #### Returns `void` *** ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:258](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L258) #### Returns `void` *** ### setFolderFormState() > **setFolderFormState**: (`state`) => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:255](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L255) #### Parameters ##### state `SetStateAction`\<[`InterfaceAgendaFolderUpdateFormStateType`](InterfaceAgendaFolderUpdateFormStateType.md)\> #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L259) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemCategoryInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaItemCategoryInfo Defined in: [src/types/AdminPortal/Agenda/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L6) Defines the structure for agenda item category information. ## Properties ### creator > **creator**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L10) #### id > **id**: `string` #### name > **name**: `string` *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L9) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L7) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L8) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemCategoryList.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaItemCategoryList Defined in: [src/types/AdminPortal/Agenda/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L19) Defines the structure for a list of agenda item categories by organization. ## Properties ### agendaCategoriesByEventId > **agendaCategoriesByEventId**: [`InterfaceAgendaItemCategoryInfo`](InterfaceAgendaItemCategoryInfo.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L20) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaItemInfo Defined in: [src/types/AdminPortal/Agenda/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L26) Defines the structure for agenda item information. ## Properties ### attachments? > `optional` **attachments**: `object`[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L39) #### fileHash > **fileHash**: `string` #### id > **id**: `string` #### mimeType > **mimeType**: `string` #### name > **name**: `string` #### objectName > **objectName**: `string` *** ### category > **category**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L34) #### description > **description**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### creator > **creator**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L46) #### id > **id**: `string` #### name > **name**: `string` *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L29) *** ### duration > **duration**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L30) *** ### event > **event**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L58) #### id > **id**: `string` #### name > **name**: `string` *** ### folder > **folder**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L54) #### id > **id**: `string` #### name > **name**: `string` *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L27) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L28) *** ### notes > **notes**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L32) *** ### sequence > **sequence**: `number` Defined in: [src/types/AdminPortal/Agenda/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L31) *** ### type? > `optional` **type**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L33) *** ### url > **url**: `object`[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L50) #### id > **id**: `string` #### url > **url**: `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsCreateModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaItemsCreateModalProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L171) Props for the AgendaItemsCreateModal component. ## Properties ### agendaFolderData > **agendaFolderData**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L177) *** ### agendaItemCategories > **agendaItemCategories**: [`InterfaceAgendaItemCategoryInfo`](InterfaceAgendaItemCategoryInfo.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L176) *** ### eventId > **eventId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L174) *** ### hide() > **hide**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L173) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L172) *** ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L178) #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L175) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsDeleteModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaItemsDeleteModalProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:201](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L201) Props for the AgendaItemsDeleteModal component. ## Properties ### agendaItemId > **agendaItemId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L204) *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:202](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L202) *** ### onClose() > **onClose**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L203) #### Returns `void` *** ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L207) #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L205) #### Parameters ##### key `string` #### Returns `string` *** ### tCommon() > **tCommon**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L206) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsPreviewModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaItemsPreviewModalProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L290) Props for the AgendaItemsPreviewModal component. Defines the data and callback functions required to display agenda item details in a preview modal and perform related actions such as updating or deleting an agenda item. ## Properties ### formState > **formState**: [`InterfaceItemFormStateType`](InterfaceItemFormStateType.md) Defined in: [src/types/AdminPortal/Agenda/interface.ts:293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L293) *** ### hidePreviewModal() > **hidePreviewModal**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L292) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L291) *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L294) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsUpdateModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAgendaItemsUpdateModalProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L184) Props for the AgendaItemsUpdateModal component. ## Properties ### agendaFolderData > **agendaFolderData**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L194) *** ### agendaItemCategories > **agendaItemCategories**: [`InterfaceAgendaItemCategoryInfo`](InterfaceAgendaItemCategoryInfo.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:193](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L193) *** ### agendaItemId > **agendaItemId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L187) *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/Agenda/interface.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L185) *** ### itemFormState > **itemFormState**: [`InterfaceFormStateType`](InterfaceFormStateType.md) Defined in: [src/types/AdminPortal/Agenda/interface.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L188) *** ### onClose() > **onClose**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L186) #### Returns `void` *** ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L195) #### Returns `void` *** ### setItemFormState() > **setItemFormState**: (`state`) => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L189) #### Parameters ##### state `SetStateAction`\<[`InterfaceFormStateType`](InterfaceFormStateType.md)\> #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L192) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAttachment.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAttachment Defined in: [src/types/AdminPortal/Agenda/interface.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L127) Defines the structure for file attachments in agenda items. ## Properties ### fileHash > **fileHash**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L130) *** ### mimeType > **mimeType**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L129) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L128) *** ### objectName > **objectName**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L131) *** ### previewUrl? > `optional` **previewUrl**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:132](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L132) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceCreateFormStateType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreateFormStateType Defined in: [src/types/AdminPortal/Agenda/interface.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L138) Defines the form state structure for creating a new agenda item. ## Properties ### attachments > **attachments**: [`InterfaceAttachment`](InterfaceAttachment.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L144) *** ### categoryId > **categoryId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L149) *** ### creator > **creator**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L146) #### name > **name**: `string` *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L142) *** ### duration > **duration**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L143) *** ### folderId > **folderId**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L140) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L139) *** ### notes > **notes**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L150) *** ### title > **title**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L141) *** ### urls > **urls**: `string`[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L145) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceFormStateType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormStateType Defined in: [src/types/AdminPortal/Agenda/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L156) Defines the form state structure for viewing/updating an agenda item. ## Properties ### attachments > **attachments**: [`InterfaceAttachment`](InterfaceAttachment.md)[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L163) *** ### category > **category**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L161) *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L159) *** ### duration > **duration**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L160) *** ### folder? > `optional` **folder**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L165) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L157) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L158) *** ### notes > **notes**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L162) *** ### url > **url**: `string`[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L164) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceItemFormStateType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceItemFormStateType Defined in: [src/types/AdminPortal/Agenda/interface.ts:262](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L262) ## Properties ### attachment? > `optional` **attachment**: `object`[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:268](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L268) #### mimeType > **mimeType**: `string` #### previewUrl > **previewUrl**: `string` *** ### category > **category**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:276](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L276) #### description > **description**: `string` #### name > **name**: `string` *** ### creator > **creator**: `object` Defined in: [src/types/AdminPortal/Agenda/interface.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L272) #### id > **id**: `string` #### name > **name**: `string` *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:265](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L265) *** ### duration > **duration**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:266](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L266) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:263](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L263) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:264](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L264) *** ### notes > **notes**: `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L267) *** ### url > **url**: `string`[] Defined in: [src/types/AdminPortal/Agenda/interface.ts:280](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L280) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceUseAgendaMutationsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUseAgendaMutationsProps Defined in: [src/types/AdminPortal/Agenda/interface.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L322) Props for the useAgendaMutations hook. ## Properties ### refetchAgendaFolder() > **refetchAgendaFolder**: () => `void` Defined in: [src/types/AdminPortal/Agenda/interface.ts:323](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L323) #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/AdminPortal/Agenda/interface.ts:324](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L324) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Agenda/type/type-aliases/AgendaCategory.md ================================================ [Admin Docs](/) *** # Type Alias: AgendaCategory > **AgendaCategory** = `object` Defined in: [src/types/AdminPortal/Agenda/type.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L4) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/Agenda/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L5) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/AdminPortal/Agenda/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L6) *** ### createdBy > **createdBy**: [`User`](../../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/Agenda/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L7) *** ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/Agenda/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L8) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Agenda/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L9) *** ### organization > **organization**: [`Organization`](../../../Organization/type/type-aliases/Organization.md) Defined in: [src/types/AdminPortal/Agenda/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L10) *** ### updatedAt? > `optional` **updatedAt**: `Date` Defined in: [src/types/AdminPortal/Agenda/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L11) *** ### updatedBy? > `optional` **updatedBy**: [`User`](../../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/Agenda/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L12) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/ApplyToSelector/interface/interfaces/InterfaceApplyToSelectorProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceApplyToSelectorProps Defined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L11) Props for ApplyToSelector component. ## Properties ### applyTo > **applyTo**: [`ApplyToType`](../type-aliases/ApplyToType.md) Defined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L13) Current selection value ('series' or 'instance') *** ### onChange() > **onChange**: (`value`) => `void` Defined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L15) Callback fired when user changes the selection #### Parameters ##### value [`ApplyToType`](../type-aliases/ApplyToType.md) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/ApplyToSelector/interface/type-aliases/ApplyToType.md ================================================ [Admin Docs](/) *** # Type Alias: ApplyToType > **ApplyToType** = `"series"` \| `"instance"` Defined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L6) Type representing the scope of action item application. - 'series': Apply to entire recurring series - 'instance': Apply to single event instance only ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/AssignmentTypeSelector/interface/interfaces/InterfaceAssignmentTypeSelectorProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAssignmentTypeSelectorProps Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L9) Props interface for the AssignmentTypeSelector component. ## Properties ### assignmentType > **assignmentType**: [`AssignmentType`](../type-aliases/AssignmentType.md) Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L11) Current assignment type selection *** ### isVolunteerDisabled > **isVolunteerDisabled**: `boolean` Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L15) Whether the volunteer chip is disabled *** ### isVolunteerGroupDisabled > **isVolunteerGroupDisabled**: `boolean` Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L17) Whether the volunteer group chip is disabled *** ### onClearVolunteer() > **onClearVolunteer**: () => `void` Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L19) Callback to clear volunteer selection when switching to volunteer group #### Returns `void` *** ### onClearVolunteerGroup() > **onClearVolunteerGroup**: () => `void` Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L21) Callback to clear volunteer group selection when switching to volunteer #### Returns `void` *** ### onTypeChange() > **onTypeChange**: (`type`) => `void` Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L13) Callback fired when assignment type changes #### Parameters ##### type [`AssignmentType`](../type-aliases/AssignmentType.md) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/AssignmentTypeSelector/interface/type-aliases/AssignmentType.md ================================================ [Admin Docs](/) *** # Type Alias: AssignmentType > **AssignmentType** = `"volunteer"` \| `"volunteerGroup"` Defined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L4) Type for assignment selection - either volunteer or volunteer group. ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Contribution/interface/interfaces/InterfaceContriStatsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceContriStatsProps Defined in: [src/types/AdminPortal/Contribution/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L1) ## Properties ### highestAmount > **highestAmount**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L4) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L2) *** ### recentAmount > **recentAmount**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L3) *** ### totalAmount > **totalAmount**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L5) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Contribution/interface/interfaces/InterfaceOrgContriCardsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgContriCardsProps Defined in: [src/types/AdminPortal/Contribution/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L8) ## Properties ### contriAmount > **contriAmount**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L13) *** ### contriDate > **contriDate**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L12) *** ### contriTransactionId > **contriTransactionId**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L14) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L10) *** ### key > **key**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L9) *** ### userEmail > **userEmail**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L15) *** ### userName > **userName**: `string` Defined in: [src/types/AdminPortal/Contribution/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L11) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/AddOnSpot/interfaces/InterfaceAddOnSpotAttendeeProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAddOnSpotAttendeeProps Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L4) Defines the props for the AddOnSpotAttendee component. ## Properties ### handleClose() > **handleClose**: () => `void` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L6) #### Returns `void` *** ### reloadMembers() > **reloadMembers**: () => `void` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L7) #### Returns `void` *** ### show > **show**: `boolean` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L5) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/AddOnSpot/interfaces/InterfaceFormData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormData Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L13) Defines the structure for form data. ## Properties ### email > **email**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L16) *** ### firstName > **firstName**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L14) *** ### gender > **gender**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L18) *** ### lastName > **lastName**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L15) *** ### phoneNo > **phoneNo**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L17) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface/interfaces/InterfaceInviteByEmailModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceInviteByEmailModalProps Defined 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) Props for InviteByEmailModal component. ## Properties ### eventId > **eventId**: `string` Defined 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) *** ### handleClose() > **handleClose**: () => `void` Defined 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) #### Returns `void` *** ### isRecurring? > `optional` **isRecurring**: `boolean` Defined 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) *** ### onInvitesSent()? > `optional` **onInvitesSent**: () => `void` Defined 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) #### Returns `void` *** ### show > **show**: `boolean` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceAutocompleteMockProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAutocompleteMockProps Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L27) Props for Autocomplete mock component used in tests. ## Properties ### getOptionLabel()? > `optional` **getOptionLabel**: (`option`) => `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L48) #### Parameters ##### option ###### id `string` ###### name? `string` #### Returns `string` *** ### inputValue? > `optional` **inputValue**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L39) *** ### noOptionsText? > `optional` **noOptionsText**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L40) *** ### onChange()? > `optional` **onChange**: (`event`, `value`) => `void` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L30) #### Parameters ##### event `SyntheticEvent` ##### value ###### id `string` ###### name? `string` #### Returns `void` *** ### onInputChange()? > `optional` **onInputChange**: (`event`, `value`, `reason`) => `void` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L34) #### Parameters ##### event `SyntheticEvent` ##### value `string` ##### reason `string` #### Returns `void` *** ### options? > `optional` **options**: `object`[] Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L29) #### id > **id**: `string` #### name? > `optional` **name**: `string` *** ### renderInput() > **renderInput**: (`params`) => `Element` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L28) #### Parameters ##### params `Record`\<`string`, `unknown`\> #### Returns `Element` *** ### renderOption()? > `optional` **renderOption**: (`props`, `option`, `state`) => `Element` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L41) #### Parameters ##### props `Record`\<`string`, `unknown`\> ##### option ###### id `string` ###### name? `string` ##### state ###### selected `boolean` #### Returns `Element` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceBaseModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceBaseModalProps Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L15) Props for BaseModal mock component used in tests. ## Properties ### children? > `optional` **children**: `ReactNode` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L17) *** ### dataTestId? > `optional` **dataTestId**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L20) *** ### footer? > `optional` **footer**: `ReactNode` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L18) *** ### onHide()? > `optional` **onHide**: () => `void` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L21) #### Returns `void` *** ### show > **show**: `boolean` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L16) *** ### title? > `optional` **title**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L19) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceEventRegistrantsModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventRegistrantsModalProps Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L5) ## Properties ### eventId > **eventId**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L7) *** ### handleClose() > **handleClose**: () => `void` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L9) #### Returns `void` *** ### orgId > **orgId**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L8) *** ### show > **show**: `boolean` Defined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L6) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/EventRegistrantsWrapper/interface/interfaces/InterfaceEventRegistrantsWrapperProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventRegistrantsWrapperProps Defined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L4) Props for EventRegistrantsWrapper component. ## Properties ### eventId > **eventId**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L5) *** ### onUpdate()? > `optional` **onUpdate**: () => `void` Defined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L7) #### Returns `void` *** ### orgId > **orgId**: `string` Defined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L6) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/interfaces/InterfaceAddressFieldConfig.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAddressFieldConfig Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L26) Interface representing the configuration for an address input field. ## Properties ### colSize? > `optional` **colSize**: `number` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L34) Optional column size for layout/grid purposes *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L28) Unique identifier for the field *** ### key > **key**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L32) Key used to map the field to data in the form or state *** ### testId > **testId**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L30) Test ID used for automated testing selectors ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/interfaces/InterfacePhoneFieldConfig.md ================================================ [Admin Docs](/) *** # Interface: InterfacePhoneFieldConfig Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L15) Interface representing the configuration for a phone input field. ## Properties ### id > **id**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L17) Unique identifier for the field *** ### key > **key**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L21) Key used to map the field to data in the form or state *** ### testId > **testId**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L19) Test ID used for automated testing selectors ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/interfaces/InterfaceResolveAvatarFileParams.md ================================================ [Admin Docs](/) *** # Interface: InterfaceResolveAvatarFileParams Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L4) Interface for the parameters of resolveAvatarFile function. ## Properties ### avatarURL > **avatarURL**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L10) URL of the existing avatar if no new file is uploaded *** ### newAvatarUploaded > **newAvatarUploaded**: `boolean` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L6) Whether a new avatar was uploaded *** ### selectedAvatar > **selectedAvatar**: `File` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L8) File object of the selected avatar if uploaded ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/type-aliases/InterfaceMemberDetailProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceMemberDetailProps > **InterfaceMemberDetailProps** = `object` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L37) Props for the MemberDetail screen component. ## Properties ### id? > `optional` **id**: `string` Defined in: [src/types/AdminPortal/MemberDetail/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L37) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceMutationUpdateOrganizationInput.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMutationUpdateOrganizationInput Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L40) Input type for the updateOrganization mutation. ## Properties ### addressLine1? > `optional` **addressLine1**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L44) *** ### addressLine2? > `optional` **addressLine2**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L45) *** ### avatar? > `optional` **avatar**: `File` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L50) *** ### city? > `optional` **city**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L46) *** ### countryCode? > `optional` **countryCode**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L49) *** ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L43) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L41) *** ### isUserRegistrationRequired? > `optional` **isUserRegistrationRequired**: `boolean` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L51) *** ### name? > `optional` **name**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L42) *** ### postalCode? > `optional` **postalCode**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L48) *** ### state? > `optional` **state**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L47) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceOrgUpdateProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgUpdateProps Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L4) Props for the OrgUpdate component. ## Properties ### orgId > **orgId**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L6) The unique identifier of the organization to update. ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceOrganization.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganization Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L12) Represents an organization's basic data structure. ## Properties ### addressLine1 > **addressLine1**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L20) Primary address line. *** ### addressLine2 > **addressLine2**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L22) Secondary address line. *** ### avatarURL > **avatarURL**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L32) URL of the organization's avatar image, or null if not set. *** ### city > **city**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L24) City of the organization. *** ### countryCode > **countryCode**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L30) ISO country code. *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L18) Description of the organization. *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L14) Unique identifier of the organization. *** ### isUserRegistrationRequired > **isUserRegistrationRequired**: `boolean` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L34) Whether user registration requires approval, or null if not configured. *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L16) Name of the organization. *** ### postalCode > **postalCode**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L28) Postal or ZIP code. *** ### state > **state**: `string` Defined in: [src/types/AdminPortal/OrgUpdate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L26) State or province. ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Organization/interface/interfaces/InterfaceOrgPeopleListCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgPeopleListCardProps Defined in: [src/types/AdminPortal/Organization/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L1) ## Properties ### id > **id**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L2) *** ### toggleRemoveModal() > **toggleRemoveModal**: () => `void` Defined in: [src/types/AdminPortal/Organization/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L3) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Organization/interface/interfaces/InterfaceOrgPostCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgPostCardProps Defined in: [src/types/AdminPortal/Organization/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L6) ## Properties ### id > **id**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L8) *** ### pinned > **pinned**: `boolean` Defined in: [src/types/AdminPortal/Organization/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L14) *** ### postAuthor > **postAuthor**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L11) *** ### postID > **postID**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L7) *** ### postInfo > **postInfo**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L10) *** ### postPhoto > **postPhoto**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L12) *** ### postTitle > **postTitle**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L9) *** ### postVideo > **postVideo**: `string` Defined in: [src/types/AdminPortal/Organization/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L13) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Organization/type/type-aliases/Organization.md ================================================ [Admin Docs](/) *** # Type Alias: Organization > **Organization** = `object` Defined in: [src/types/AdminPortal/Organization/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L24) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L25) *** ### actionItemCategories? > `optional` **actionItemCategories**: [`ActionItemCategory`](../../../actionItem/type-aliases/ActionItemCategory.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L26) *** ### address? > `optional` **address**: [`Address`](../../../address/type-aliases/Address.md) Defined in: [src/types/AdminPortal/Organization/type.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L27) *** ### admins? > `optional` **admins**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L28) *** ### agendaCategories? > `optional` **agendaCategories**: [`AgendaCategory`](../../../Agenda/type/type-aliases/AgendaCategory.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L29) *** ### apiUrl > **apiUrl**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L30) *** ### blockedUsers? > `optional` **blockedUsers**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L31) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/AdminPortal/Organization/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L32) *** ### creator? > `optional` **creator**: [`User`](../../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/Organization/type.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L33) *** ### customFields > **customFields**: [`OrganizationCustomField`](OrganizationCustomField.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L34) *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L35) *** ### image? > `optional` **image**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L36) *** ### members? > `optional` **members**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L37) *** ### membershipRequests? > `optional` **membershipRequests**: [`MembershipRequest`](../../../membership/type-aliases/MembershipRequest.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L38) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L39) *** ### pinnedPosts? > `optional` **pinnedPosts**: [`Post`](../../../../Post/type/type-aliases/Post.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L40) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/AdminPortal/Organization/type.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L41) *** ### userRegistrationRequired > **userRegistrationRequired**: `boolean` Defined in: [src/types/AdminPortal/Organization/type.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L42) *** ### venues? > `optional` **venues**: [`Venue`](../../../venue/type-aliases/Venue.md)[] Defined in: [src/types/AdminPortal/Organization/type.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L44) *** ### visibleInSearch > **visibleInSearch**: `boolean` Defined in: [src/types/AdminPortal/Organization/type.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L43) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Organization/type/type-aliases/OrganizationCustomField.md ================================================ [Admin Docs](/) *** # Type Alias: OrganizationCustomField > **OrganizationCustomField** = `object` Defined in: [src/types/AdminPortal/Organization/type.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L47) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L48) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L49) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L50) *** ### type > **type**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L51) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Organization/type/type-aliases/OrganizationInput.md ================================================ [Admin Docs](/) *** # Type Alias: OrganizationInput > **OrganizationInput** = `object` Defined in: [src/types/AdminPortal/Organization/type.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L54) ## Properties ### address > **address**: [`AddressInput`](../../../address/type-aliases/AddressInput.md) Defined in: [src/types/AdminPortal/Organization/type.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L55) *** ### apiUrl? > `optional` **apiUrl**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L56) *** ### attendees? > `optional` **attendees**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L57) *** ### description > **description**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L58) *** ### image? > `optional` **image**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L59) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/Organization/type.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L60) *** ### userRegistrationRequired? > `optional` **userRegistrationRequired**: `boolean` Defined in: [src/types/AdminPortal/Organization/type.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L61) *** ### visibleInSearch? > `optional` **visibleInSearch**: `boolean` Defined in: [src/types/AdminPortal/Organization/type.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L62) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/OrganizationDashCards/CardItem/interface/interfaces/InterfaceCardItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCardItem Defined 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) ## Properties ### creator? > `optional` **creator**: `object` Defined 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) #### id > **id**: `string` \| `number` #### name > **name**: `string` *** ### enddate? > `optional` **enddate**: `string` Defined 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) *** ### image? > `optional` **image**: `string` Defined 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) *** ### location? > `optional` **location**: `string` Defined 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) *** ### startdate? > `optional` **startdate**: `string` Defined 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) *** ### time? > `optional` **time**: `string` Defined 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) *** ### title > **title**: `string` Defined 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) *** ### type > **type**: `"Event"` \| `"Post"` \| `"MembershipRequest"` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/OrganizationPeople/addMember/interface/interfaces/InterfaceAddMemberProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAddMemberProps Defined 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) Props for the AddMember component (organization people "Add Members" dropdown and modals). Used to pass styling class names from the parent screen so styles stay decoupled from test IDs. ## Properties ### containerClassName? > `optional` **containerClassName**: `string` Defined 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) Optional class for the Add Members dropdown container. *** ### rootClassName? > `optional` **rootClassName**: `string` Defined 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) Optional class for the Add Members header wrapper (e.g. PageHeader root). *** ### toggleClassName? > `optional` **toggleClassName**: `string` Defined 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) Optional class for the Add Members dropdown toggle button. ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface/interfaces/IUninstallConfirmationModalProps.md ================================================ [Admin Docs](/) *** # Interface: IUninstallConfirmationModalProps Defined 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) Interface for the UninstallConfirmationModal component props. ## Param Boolean to control the visibility of the modal. ## Param Callback function to handle the closing of the modal. ## Param Callback function to handle the confirmation action. ## Param The plugin metadata object to be uninstalled, or null if none selected. ## Properties ### onClose() > **onClose**: () => `void` Defined 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) #### Returns `void` *** ### onConfirm() > **onConfirm**: () => `void` Defined 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) #### Returns `void` *** ### plugin > **plugin**: [`IPluginMeta`](../../../../../../plugin/types/interfaces/IPluginMeta.md) Defined 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) *** ### show > **show**: `boolean` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceAddPeopleToTagProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAddPeopleToTagProps Defined in: [src/types/AdminPortal/Tag/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L27) ## Properties ### addPeopleToTagModalIsOpen > **addPeopleToTagModalIsOpen**: `boolean` Defined in: [src/types/AdminPortal/Tag/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L28) *** ### hideAddPeopleToTagModal() > **hideAddPeopleToTagModal**: () => `void` Defined in: [src/types/AdminPortal/Tag/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L29) #### Returns `void` *** ### refetchAssignedMembersData() > **refetchAssignedMembersData**: () => `void` Defined in: [src/types/AdminPortal/Tag/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L30) #### Returns `void` *** ### t > **t**: `TFunction`\<`"translation"`, `"manageTag"`\> Defined in: [src/types/AdminPortal/Tag/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L31) *** ### tCommon > **tCommon**: `TFunction`\<`"common"`, `undefined`\> Defined in: [src/types/AdminPortal/Tag/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L32) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceBaseFetchMoreOptions.md ================================================ [Admin Docs](/) *** # Interface: InterfaceBaseFetchMoreOptions\ Defined in: [src/types/AdminPortal/Tag/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L45) ## Type Parameters ### T `T` ## Properties ### updateQuery()? > `optional` **updateQuery**: (`prev`, `options`) => `T` Defined in: [src/types/AdminPortal/Tag/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L47) #### Parameters ##### prev `T` ##### options ###### fetchMoreResult `T` #### Returns `T` *** ### variables > **variables**: [`InterfacePaginationVariables`](InterfacePaginationVariables.md) Defined in: [src/types/AdminPortal/Tag/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L46) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceBaseQueryResult.md ================================================ [Admin Docs](/) *** # Interface: InterfaceBaseQueryResult Defined in: [src/types/AdminPortal/Tag/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L39) ## Extended by - [`InterfaceTagUsersToAssignToQuery`](InterfaceTagUsersToAssignToQuery.md) ## Properties ### error? > `optional` **error**: `ApolloError` Defined in: [src/types/AdminPortal/Tag/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L41) *** ### loading > **loading**: `boolean` Defined in: [src/types/AdminPortal/Tag/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L40) *** ### refetch()? > `optional` **refetch**: () => `void` Defined in: [src/types/AdminPortal/Tag/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L42) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceMemberData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMemberData Defined in: [src/types/AdminPortal/Tag/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L4) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/Tag/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L5) *** ### firstName > **firstName**: `string` Defined in: [src/types/AdminPortal/Tag/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L6) *** ### lastName > **lastName**: `string` Defined in: [src/types/AdminPortal/Tag/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L7) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfacePaginationVariables.md ================================================ [Admin Docs](/) *** # Interface: InterfacePaginationVariables Defined in: [src/types/AdminPortal/Tag/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L35) ## Properties ### after? > `optional` **after**: `string` Defined in: [src/types/AdminPortal/Tag/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L36) *** ### first? > `optional` **first**: `number` Defined in: [src/types/AdminPortal/Tag/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L37) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryUserTagsMembersToAssignTo Defined in: [src/types/AdminPortal/Tag/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L50) ## Properties ### name > **name**: `string` Defined in: [src/types/AdminPortal/Tag/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L51) *** ### usersToAssignTo > **usersToAssignTo**: [`InterfaceTagMembersData`](InterfaceTagMembersData.md) Defined in: [src/types/AdminPortal/Tag/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L52) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceTagMembersData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagMembersData Defined in: [src/types/AdminPortal/Tag/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L10) ## Properties ### edges > **edges**: `object`[] Defined in: [src/types/AdminPortal/Tag/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L11) #### node > **node**: `object` ##### node.\_id > **\_id**: `string` ##### node.firstName > **firstName**: `string` ##### node.lastName > **lastName**: `string` *** ### pageInfo > **pageInfo**: `object` Defined in: [src/types/AdminPortal/Tag/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L18) #### endCursor > **endCursor**: `string` #### hasNextPage > **hasNextPage**: `boolean` #### hasPreviousPage > **hasPreviousPage**: `boolean` #### startCursor > **startCursor**: `string` *** ### totalCount > **totalCount**: `number` Defined in: [src/types/AdminPortal/Tag/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L24) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceTagUsersToAssignToQuery.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagUsersToAssignToQuery Defined in: [src/types/AdminPortal/Tag/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L55) ## Extends - [`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md) ## Properties ### data? > `optional` **data**: `object` Defined in: [src/types/AdminPortal/Tag/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L56) #### getUsersToAssignTo > **getUsersToAssignTo**: [`InterfaceQueryUserTagsMembersToAssignTo`](InterfaceQueryUserTagsMembersToAssignTo.md) *** ### error? > `optional` **error**: `ApolloError` Defined in: [src/types/AdminPortal/Tag/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L41) #### Inherited from [`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md).[`error`](InterfaceBaseQueryResult.md#error) *** ### fetchMore() > **fetchMore**: (`options`) => `void` Defined in: [src/types/AdminPortal/Tag/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L59) #### Parameters ##### options [`InterfaceBaseFetchMoreOptions`](InterfaceBaseFetchMoreOptions.md)\<\{ `getUsersToAssignTo`: [`InterfaceQueryUserTagsMembersToAssignTo`](InterfaceQueryUserTagsMembersToAssignTo.md); \}\> #### Returns `void` *** ### loading > **loading**: `boolean` Defined in: [src/types/AdminPortal/Tag/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L40) #### Inherited from [`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md).[`loading`](InterfaceBaseQueryResult.md#loading) *** ### refetch()? > `optional` **refetch**: () => `void` Defined in: [src/types/AdminPortal/Tag/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L42) #### Returns `void` #### Inherited from [`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md).[`refetch`](InterfaceBaseQueryResult.md#refetch) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/utils/variables/TAGS_QUERY_DATA_CHUNK_SIZE.md ================================================ [Admin Docs](/) *** # Variable: TAGS\_QUERY\_DATA\_CHUNK\_SIZE > `const` **TAGS\_QUERY\_DATA\_CHUNK\_SIZE**: `10` = `10` Defined in: [src/types/AdminPortal/Tag/utils.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/utils.ts#L1) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/Tag/utils/variables/dataGridStyle.md ================================================ [Admin Docs](/) *** # Variable: dataGridStyle > `const` **dataGridStyle**: `object` Defined in: [src/types/AdminPortal/Tag/utils.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/utils.ts#L3) ## Type Declaration #### & .MuiDataGrid-cell:focus > **& .MuiDataGrid-cell:focus**: `object` #### & .MuiDataGrid-cell:focus.outline > **outline**: `string` = `'2px solid #000'` #### & .MuiDataGrid-cell:focus.outlineOffset > **outlineOffset**: `string` = `'-2px'` #### & .MuiDataGrid-main > **& .MuiDataGrid-main**: `object` #### & .MuiDataGrid-main.borderRadius > **borderRadius**: `string` = `'0.1rem'` #### & .MuiDataGrid-root > **& .MuiDataGrid-root**: `object` #### & .MuiDataGrid-root.borderRadius > **borderRadius**: `string` = `'0.1rem'` #### & .MuiDataGrid-row:hover > **& .MuiDataGrid-row:hover**: `object` #### & .MuiDataGrid-row:hover.backgroundColor > **backgroundColor**: `string` = `'transparent'` #### & .MuiDataGrid-row:hover.boxShadow > **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'` #### & .MuiDataGrid-row.Mui-hovered > **& .MuiDataGrid-row.Mui-hovered**: `object` #### & .MuiDataGrid-row.Mui-hovered.backgroundColor > **backgroundColor**: `string` = `'transparent'` #### & .MuiDataGrid-row.Mui-hovered.boxShadow > **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'` #### & .MuiDataGrid-topContainer > **& .MuiDataGrid-topContainer**: `object` #### & .MuiDataGrid-topContainer.position > **position**: `string` = `'fixed'` #### & .MuiDataGrid-topContainer.top > **top**: `number` = `290` #### & .MuiDataGrid-topContainer.zIndex > **zIndex**: `number` = `1` #### & .MuiDataGrid-virtualScrollerContent > **& .MuiDataGrid-virtualScrollerContent**: `object` #### & .MuiDataGrid-virtualScrollerContent.marginTop > **marginTop**: `number` = `6.5` #### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within > **&.MuiDataGrid-root .MuiDataGrid-cell:focus-within**: `object` #### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within.outline > **outline**: `string` = `'none !important'` #### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within > **&.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within**: `object` #### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within.outline > **outline**: `string` = `'none'` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/TagActions/interface/interfaces/InterfaceTagActionsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagActionsProps Defined in: [src/types/AdminPortal/TagActions/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L4) ## Properties ### hideTagActionsModal() > **hideTagActionsModal**: () => `void` Defined in: [src/types/AdminPortal/TagActions/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L6) #### Returns `void` *** ### t > **t**: `TFunction`\<`"translation"`, `"manageTag"`\> Defined in: [src/types/AdminPortal/TagActions/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L8) *** ### tagActionsModalIsOpen > **tagActionsModalIsOpen**: `boolean` Defined in: [src/types/AdminPortal/TagActions/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L5) *** ### tagActionType > **tagActionType**: [`TagActionType`](../../../../../utils/organizationTagsUtils/type-aliases/TagActionType.md) Defined in: [src/types/AdminPortal/TagActions/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L7) *** ### tCommon > **tCommon**: `TFunction`\<`"common"`, `undefined`\> Defined in: [src/types/AdminPortal/TagActions/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UpdateSession/interface/interfaces/InterfaceUpdateSessionProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUpdateSessionProps Defined in: [src/types/AdminPortal/UpdateSession/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UpdateSession/interface.ts#L4) Props for UpdateSession component. ## Properties ### onValueChange()? > `optional` **onValueChange**: (`value`) => `void` Defined in: [src/types/AdminPortal/UpdateSession/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UpdateSession/interface.ts#L8) Callback invoked when the timeout value changes. #### Parameters ##### value `number` #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGQLEventLite.md ================================================ [Admin Docs](/) *** # Interface: InterfaceGQLEventLite Defined 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) Represents a minimal GraphQL event reference used for relational fields such as attended events. ## Properties ### id > **id**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGQLOrganization.md ================================================ [Admin Docs](/) *** # Interface: InterfaceGQLOrganization Defined 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) Represents a GraphQL organization entity associated with events and user participation. ## Properties ### id > **id**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGQLUser.md ================================================ [Admin Docs](/) *** # Interface: InterfaceGQLUser Defined 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) Represents a lightweight GraphQL user object containing basic identity details used in event relationships. ## Properties ### id > **id**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGetUserEventsData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceGetUserEventsData Defined 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) GraphQL response payload containing events fetched for a specific organization. ## Properties ### eventsByOrganizationId > **eventsByOrganizationId**: [`InterfaceUserEventsGQL`](InterfaceUserEventsGQL.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceUserEvent.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserEvent Defined 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) Represents a UI-friendly event payload with formatted date/time and minimal fields required for rendering user events. ## Properties ### creatorId > **creatorId**: `string` Defined 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) *** ### description > **description**: `string` Defined 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) *** ### endDate > **endDate**: `string` Defined 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) *** ### endTime > **endTime**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) *** ### startDate > **startDate**: `string` Defined 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) *** ### startTime > **startTime**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceUserEventsGQL.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserEventsGQL Defined 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) Represents detailed event data returned by GraphQL, including metadata, attendees, creator, and organization. ## Properties ### allDay > **allDay**: `boolean` Defined 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) *** ### attendees > **attendees**: [`InterfaceGQLUser`](InterfaceGQLUser.md)[] Defined 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) *** ### createdAt > **createdAt**: `string` Defined 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) *** ### creator > **creator**: [`InterfaceGQLUser`](InterfaceGQLUser.md) & `object` Defined 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) #### Type Declaration ##### eventsAttended > **eventsAttended**: [`InterfaceGQLEventLite`](InterfaceGQLEventLite.md)[] *** ### description > **description**: `string` Defined 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) *** ### endAt > **endAt**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isPublic > **isPublic**: `boolean` Defined 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) *** ### isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` Defined 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) *** ### isRegisterable > **isRegisterable**: `boolean` Defined 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) *** ### location > **location**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) *** ### organization > **organization**: [`InterfaceGQLOrganization`](InterfaceGQLOrganization.md) Defined 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) *** ### startAt > **startAt**: `string` Defined 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) *** ### updatedAt > **updatedAt**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/type-aliases/ParticipationFilter.md ================================================ [Admin Docs](/) *** # Type Alias: ParticipationFilter > **ParticipationFilter** = `"ALL"` \| `"ADMIN_CREATOR"` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/type/type-aliases/PeopleTabUserEventsProps.md ================================================ [Admin Docs](/) *** # Type Alias: PeopleTabUserEventsProps > **PeopleTabUserEventsProps** = `object` Defined 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) Props for the UserEvents component. ## Properties ### orgId? > `optional` **orgId**: `string` Defined 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) *** ### userId? > `optional` **userId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/interface/interfaces/InterfaceJoinedOrgEdge.md ================================================ [Admin Docs](/) *** # Interface: InterfaceJoinedOrgEdge Defined 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) ## Properties ### node > **node**: `object` Defined 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) #### adminsCount > **adminsCount**: `number` #### avatarURL? > `optional` **avatarURL**: `string` #### description? > `optional` **description**: `string` #### id > **id**: `string` #### membersCount > **membersCount**: `number` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/interface/interfaces/InterfaceJoinedOrganizationsData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceJoinedOrganizationsData Defined 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) ## Properties ### user > **user**: `object` Defined 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) #### organizationsWhereMember? > `optional` **organizationsWhereMember**: `object` ##### organizationsWhereMember.edges? > `optional` **edges**: [`InterfaceJoinedOrgEdge`](InterfaceJoinedOrgEdge.md)[] ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceOrgRelationType.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceOrgRelationType > **InterfaceOrgRelationType** = `"CREATED"` \| `"BELONG_TO"` \| `"JOINED"` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceUserOrg.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceUserOrg > **InterfaceUserOrg** = `object` Defined 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) ## Properties ### adminsCount > **adminsCount**: `number` Defined 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) *** ### avatarURL? > `optional` **avatarURL**: `string` Defined 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) *** ### description? > `optional` **description**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### membersCount > **membersCount**: `number` Defined 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) *** ### name > **name**: `string` Defined 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) *** ### relation > **relation**: [`InterfaceOrgRelationType`](InterfaceOrgRelationType.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceUserOrganizationsProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceUserOrganizationsProps > **InterfaceUserOrganizationsProps** = `object` Defined 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) ## Properties ### id? > `optional` **id**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/interface/interfaces/InterfaceGetUserTagsData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceGetUserTagsData Defined 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) Shape of the GraphQL response for the GetUserTags query. ## Properties ### userTags > **userTags**: [`InterfaceUserTagGQL`](InterfaceUserTagGQL.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/interface/interfaces/InterfaceUserTag.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserTag Defined 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) UI-mapped representation of a user tag for table display. ## Properties ### assignedTo > **assignedTo**: `number` Defined 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) *** ### createdAt > **createdAt**: `string` Defined 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) *** ### createdBy? > `optional` **createdBy**: `string` Defined 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) *** ### createdOn > **createdOn**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/interface/interfaces/InterfaceUserTagGQL.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserTagGQL Defined 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) Raw GraphQL shape for a single user tag as returned by the API. ## Properties ### assignees? > `optional` **assignees**: `object` Defined 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) #### edges > **edges**: `object`[] *** ### createdAt > **createdAt**: `string` Defined 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) *** ### creator? > `optional` **creator**: `object` Defined 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) #### id > **id**: `string` #### name > **name**: `string` *** ### folder? > `optional` **folder**: `object` Defined 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) #### id > **id**: `string` *** ### id > **id**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/type/type-aliases/InterfaceUserTagsProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceUserTagsProps > **InterfaceUserTagsProps** = `object` Defined 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) Props for the UserTags component. ## Properties ### id? > `optional` **id**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/interfaces/InterfaceActionButton.md ================================================ [Admin Docs](/) *** # Interface: InterfaceActionButton Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L26) Action button configuration interface ## Properties ### ariaLabel? > `optional` **ariaLabel**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L33) *** ### disabled? > `optional` **disabled**: `boolean` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L32) *** ### icon? > `optional` **icon**: `ReactElement` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L29) *** ### label > **label**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L27) *** ### onClick() > **onClick**: (`user`) => `void` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L28) #### Parameters ##### user [`InterfaceUserInfo`](InterfaceUserInfo.md) #### Returns `void` *** ### testId? > `optional` **testId**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L31) *** ### variant? > `optional` **variant**: [`InterfaceActionVariant`](../type-aliases/InterfaceActionVariant.md) Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L30) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/interfaces/InterfaceUserInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserInfo Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L6) User information interface for UserTableRow component ## Properties ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L10) *** ### createdAt? > `optional` **createdAt**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L11) *** ### emailAddress? > `optional` **emailAddress**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L9) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L7) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L8) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/interfaces/InterfaceUserTableRowProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserTableRowProps Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L39) Props interface for UserTableRow component ## Properties ### actions? > `optional` **actions**: [`InterfaceActionButton`](InterfaceActionButton.md)[] Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L43) *** ### compact? > `optional` **compact**: `boolean` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L47) *** ### isDataGrid? > `optional` **isDataGrid**: `boolean` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L46) *** ### linkPath? > `optional` **linkPath**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L42) *** ### onRowClick()? > `optional` **onRowClick**: (`user`) => `void` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L45) #### Parameters ##### user [`InterfaceUserInfo`](InterfaceUserInfo.md) #### Returns `void` *** ### rowNumber? > `optional` **rowNumber**: `number` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L41) *** ### showJoinedDate? > `optional` **showJoinedDate**: `boolean` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L44) *** ### testIdPrefix? > `optional` **testIdPrefix**: `string` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L48) *** ### user > **user**: [`InterfaceUserInfo`](InterfaceUserInfo.md) Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L40) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/type-aliases/InterfaceActionVariant.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceActionVariant > **InterfaceActionVariant** = `"primary"` \| `"success"` \| `"danger"` \| `"default"` Defined in: [src/types/AdminPortal/UserTableRow/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L17) Action button variant types for styling ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/VolunteerDeleteModal/interface/interfaces/InterfaceVolunteerDeleteModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerDeleteModalProps Defined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L6) Props for VolunteerDeleteModal component. ## Properties ### eventId? > `optional` **eventId**: `string` Defined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L12) *** ### hide() > **hide**: () => `void` Defined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L8) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L7) *** ### isRecurring? > `optional` **isRecurring**: `boolean` Defined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L11) *** ### refetchVolunteers() > **refetchVolunteers**: () => `void` Defined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L10) #### Returns `void` *** ### volunteer > **volunteer**: [`InterfaceEventVolunteerInfo`](../../../../../utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md) Defined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/VolunteerViewModal/interface/interfaces/InterfaceVolunteerViewModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerViewModalProps Defined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L6) Props for VolunteerViewModal component. ## Properties ### hide() > **hide**: () => `void` Defined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L8) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L7) *** ### volunteer > **volunteer**: [`InterfaceEventVolunteerInfo`](../../../../../utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md) Defined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/ActionItem.md ================================================ [Admin Docs](/) *** # Type Alias: ActionItem > **ActionItem** = `object` Defined in: [src/types/AdminPortal/actionItem.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L5) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L6) *** ### actionItemCategory? > `optional` **actionItemCategory**: [`ActionItemCategory`](ActionItemCategory.md) Defined in: [src/types/AdminPortal/actionItem.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L7) *** ### assignee? > `optional` **assignee**: [`User`](../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/actionItem.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L8) *** ### assigner? > `optional` **assigner**: [`User`](../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/actionItem.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L9) *** ### assignmentDate > **assignmentDate**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L10) *** ### completionDate > **completionDate**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L11) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L12) *** ### creator? > `optional` **creator**: [`User`](../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/actionItem.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L13) *** ### dueDate > **dueDate**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L14) *** ### event? > `optional` **event**: `Event` Defined in: [src/types/AdminPortal/actionItem.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L15) *** ### isCompleted > **isCompleted**: `boolean` Defined in: [src/types/AdminPortal/actionItem.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L16) *** ### postCompletionNotes? > `optional` **postCompletionNotes**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L17) *** ### preCompletionNotes? > `optional` **preCompletionNotes**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L18) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L19) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/ActionItemCategory.md ================================================ [Admin Docs](/) *** # Type Alias: ActionItemCategory > **ActionItemCategory** = `object` Defined in: [src/types/AdminPortal/actionItem.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L22) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L23) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L24) *** ### creator? > `optional` **creator**: [`User`](../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/actionItem.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L25) *** ### isDisabled > **isDisabled**: `boolean` Defined in: [src/types/AdminPortal/actionItem.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L26) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L27) *** ### organization? > `optional` **organization**: [`Organization`](../../Organization/type/type-aliases/Organization.md) Defined in: [src/types/AdminPortal/actionItem.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L28) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L29) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/CreateActionItemInput.md ================================================ [Admin Docs](/) *** # Type Alias: CreateActionItemInput > **CreateActionItemInput** = `object` Defined in: [src/types/AdminPortal/actionItem.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L32) ## Properties ### assigneeId > **assigneeId**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L33) *** ### dueDate? > `optional` **dueDate**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L34) *** ### eventId? > `optional` **eventId**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L35) *** ### preCompletionNotes? > `optional` **preCompletionNotes**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L36) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/UpdateActionItemInput.md ================================================ [Admin Docs](/) *** # Type Alias: UpdateActionItemInput > **UpdateActionItemInput** = `object` Defined in: [src/types/AdminPortal/actionItem.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L39) ## Properties ### assigneeId? > `optional` **assigneeId**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L40) *** ### completionDate? > `optional` **completionDate**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L41) *** ### dueDate? > `optional` **dueDate**: `Date` Defined in: [src/types/AdminPortal/actionItem.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L42) *** ### isCompleted? > `optional` **isCompleted**: `boolean` Defined in: [src/types/AdminPortal/actionItem.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L43) *** ### postCompletionNotes? > `optional` **postCompletionNotes**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L44) *** ### preCompletionNotes? > `optional` **preCompletionNotes**: `string` Defined in: [src/types/AdminPortal/actionItem.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L45) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/address/type-aliases/Address.md ================================================ [Admin Docs](/) *** # Type Alias: Address > **Address** = `object` Defined in: [src/types/AdminPortal/address.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L1) ## Properties ### city? > `optional` **city**: `string` Defined in: [src/types/AdminPortal/address.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L2) *** ### countryCode? > `optional` **countryCode**: `string` Defined in: [src/types/AdminPortal/address.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L3) *** ### dependentLocality? > `optional` **dependentLocality**: `string` Defined in: [src/types/AdminPortal/address.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L4) *** ### line1? > `optional` **line1**: `string` Defined in: [src/types/AdminPortal/address.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L5) *** ### line2? > `optional` **line2**: `string` Defined in: [src/types/AdminPortal/address.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L6) *** ### postalCode? > `optional` **postalCode**: `string` Defined in: [src/types/AdminPortal/address.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L7) *** ### sortingCode? > `optional` **sortingCode**: `string` Defined in: [src/types/AdminPortal/address.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L8) *** ### state? > `optional` **state**: `string` Defined in: [src/types/AdminPortal/address.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/address/type-aliases/AddressInput.md ================================================ [Admin Docs](/) *** # Type Alias: AddressInput > **AddressInput** = `object` Defined in: [src/types/AdminPortal/address.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L12) ## Properties ### city? > `optional` **city**: `string` Defined in: [src/types/AdminPortal/address.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L13) *** ### countryCode? > `optional` **countryCode**: `string` Defined in: [src/types/AdminPortal/address.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L14) *** ### dependentLocality? > `optional` **dependentLocality**: `string` Defined in: [src/types/AdminPortal/address.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L15) *** ### line1? > `optional` **line1**: `string` Defined in: [src/types/AdminPortal/address.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L16) *** ### line2? > `optional` **line2**: `string` Defined in: [src/types/AdminPortal/address.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L17) *** ### postalCode? > `optional` **postalCode**: `string` Defined in: [src/types/AdminPortal/address.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L18) *** ### sortingCode? > `optional` **sortingCode**: `string` Defined in: [src/types/AdminPortal/address.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L19) *** ### state? > `optional` **state**: `string` Defined in: [src/types/AdminPortal/address.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L20) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/membership/type-aliases/MembershipRequest.md ================================================ [Admin Docs](/) *** # Type Alias: MembershipRequest > **MembershipRequest** = `object` Defined in: [src/types/AdminPortal/membership.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L4) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/membership.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L5) *** ### organization > **organization**: [`Organization`](../../Organization/type/type-aliases/Organization.md) Defined in: [src/types/AdminPortal/membership.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L6) *** ### user > **user**: [`User`](../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/AdminPortal/membership.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L7) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/pagination/type-aliases/DefaultConnectionPageInfo.md ================================================ [Admin Docs](/) *** # Type Alias: DefaultConnectionPageInfo > **DefaultConnectionPageInfo** = `object` Defined in: [src/types/AdminPortal/pagination.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L1) ## Properties ### endCursor? > `optional` **endCursor**: `string` Defined in: [src/types/AdminPortal/pagination.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L5) *** ### hasNextPage > **hasNextPage**: `boolean` Defined in: [src/types/AdminPortal/pagination.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L2) *** ### hasPreviousPage > **hasPreviousPage**: `boolean` Defined in: [src/types/AdminPortal/pagination.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L3) *** ### startCursor? > `optional` **startCursor**: `string` Defined in: [src/types/AdminPortal/pagination.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L4) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/venue/type-aliases/EditVenueInput.md ================================================ [Admin Docs](/) *** # Type Alias: EditVenueInput > **EditVenueInput** = `object` Defined in: [src/types/AdminPortal/venue.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L20) ## Properties ### capacity? > `optional` **capacity**: `number` Defined in: [src/types/AdminPortal/venue.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L21) *** ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/venue.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L22) *** ### file? > `optional` **file**: `string` Defined in: [src/types/AdminPortal/venue.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L23) *** ### id > **id**: `string` Defined in: [src/types/AdminPortal/venue.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L24) *** ### name? > `optional` **name**: `string` Defined in: [src/types/AdminPortal/venue.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L25) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/venue/type-aliases/Venue.md ================================================ [Admin Docs](/) *** # Type Alias: Venue > **Venue** = `object` Defined in: [src/types/AdminPortal/venue.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L3) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/AdminPortal/venue.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L4) *** ### capacity > **capacity**: `number` Defined in: [src/types/AdminPortal/venue.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L5) *** ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/venue.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L6) *** ### imageUrl? > `optional` **imageUrl**: `string` Defined in: [src/types/AdminPortal/venue.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L7) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/venue.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L8) *** ### organization > **organization**: [`Organization`](../../Organization/type/type-aliases/Organization.md) Defined in: [src/types/AdminPortal/venue.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/AdminPortal/venue/type-aliases/VenueInput.md ================================================ [Admin Docs](/) *** # Type Alias: VenueInput > **VenueInput** = `object` Defined in: [src/types/AdminPortal/venue.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L12) ## Properties ### capacity > **capacity**: `number` Defined in: [src/types/AdminPortal/venue.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L13) *** ### description? > `optional` **description**: `string` Defined in: [src/types/AdminPortal/venue.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L14) *** ### file? > `optional` **file**: `string` Defined in: [src/types/AdminPortal/venue.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L15) *** ### name > **name**: `string` Defined in: [src/types/AdminPortal/venue.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L16) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/AdminPortal/venue.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L17) ================================================ FILE: docs/docs/auto-docs/types/Auth/LoginForm/interface/interfaces/InterfaceLoginFormData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceLoginFormData Defined in: [src/types/Auth/LoginForm/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L4) Form data structure for login form state. ## Properties ### email > **email**: `string` Defined in: [src/types/Auth/LoginForm/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L6) User email address *** ### password > **password**: `string` Defined in: [src/types/Auth/LoginForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L8) User password ================================================ FILE: docs/docs/auto-docs/types/Auth/LoginForm/interface/interfaces/InterfaceLoginFormProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceLoginFormProps Defined in: [src/types/Auth/LoginForm/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L36) Props for the LoginForm component. ## Remarks LoginForm composes EmailField and PasswordField to create a reusable login form with callback support for success/error handling. ## Properties ### enableRecaptcha? > `optional` **enableRecaptcha**: `boolean` Defined in: [src/types/Auth/LoginForm/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L46) When true, render ReCAPTCHA and send token with sign-in request *** ### isAdmin? > `optional` **isAdmin**: `boolean` Defined in: [src/types/Auth/LoginForm/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L38) Whether this is an admin login form (affects heading text) *** ### onError()? > `optional` **onError**: (`error`) => `void` Defined in: [src/types/Auth/LoginForm/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L42) Callback fired when login fails with error details #### Parameters ##### error `Error` #### Returns `void` *** ### onSuccess()? > `optional` **onSuccess**: (`signInResult`) => `void` Defined in: [src/types/Auth/LoginForm/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L40) Callback fired on successful login with full signIn result (user + tokens) #### Parameters ##### signInResult [`InterfaceSignInResult`](InterfaceSignInResult.md) #### Returns `void` *** ### testId? > `optional` **testId**: `string` Defined in: [src/types/Auth/LoginForm/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L44) Test ID for testing purposes ================================================ FILE: docs/docs/auto-docs/types/Auth/LoginForm/interface/interfaces/InterfaceSignInResult.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSignInResult Defined in: [src/types/Auth/LoginForm/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L15) Shape of the signIn result from SIGNIN_QUERY, passed to onSuccess so the parent can handle session, redirect, and invitation logic. ## Properties ### authenticationToken > **authenticationToken**: `string` Defined in: [src/types/Auth/LoginForm/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L25) *** ### refreshToken? > `optional` **refreshToken**: `string` Defined in: [src/types/Auth/LoginForm/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L26) *** ### user > **user**: `object` Defined in: [src/types/Auth/LoginForm/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L16) #### avatarURL > **avatarURL**: `string` #### countryCode > **countryCode**: `string` #### emailAddress > **emailAddress**: `string` #### id > **id**: `string` #### isEmailAddressVerified > **isEmailAddressVerified**: `boolean` #### name > **name**: `string` #### role > **role**: `string` ================================================ FILE: docs/docs/auto-docs/types/Auth/OrgSelector/interface/interfaces/InterfaceOrgOption.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgOption Defined in: [src/types/Auth/OrgSelector/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L4) Represents an organization option in the selector. ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/Auth/OrgSelector/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L6) Unique identifier for the organization *** ### name > **name**: `string` Defined in: [src/types/Auth/OrgSelector/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L9) Display name of the organization ================================================ FILE: docs/docs/auto-docs/types/Auth/OrgSelector/interface/interfaces/InterfaceOrgSelectorProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgSelectorProps Defined in: [src/types/Auth/OrgSelector/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L19) Props for the OrgSelector component. ## Remarks This component is designed for Phase 2 UI implementation. Integration with validators will be handled in Phase 2b. ## Properties ### disabled? > `optional` **disabled**: `boolean` Defined in: [src/types/Auth/OrgSelector/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L36) Whether the selector is disabled *** ### error? > `optional` **error**: `string` Defined in: [src/types/Auth/OrgSelector/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L30) Error message to display - null or undefined means no error *** ### label? > `optional` **label**: `string` Defined in: [src/types/Auth/OrgSelector/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L42) Optional custom label text - defaults to "Organization" *** ### onChange() > **onChange**: (`orgId`) => `void` Defined in: [src/types/Auth/OrgSelector/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L27) Callback invoked when the selected organization changes #### Parameters ##### orgId `string` #### Returns `void` *** ### options > **options**: [`InterfaceOrgOption`](InterfaceOrgOption.md)[] Defined in: [src/types/Auth/OrgSelector/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L21) Array of available organizations to select from *** ### required? > `optional` **required**: `boolean` Defined in: [src/types/Auth/OrgSelector/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L39) Whether the field is required - shows asterisk if true *** ### testId? > `optional` **testId**: `string` Defined in: [src/types/Auth/OrgSelector/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L33) Test ID for testing purposes *** ### value? > `optional` **value**: `string` Defined in: [src/types/Auth/OrgSelector/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L24) Currently selected organization ID ================================================ FILE: docs/docs/auto-docs/types/Auth/PasswordStrengthIndicator/interface/interfaces/InterfacePasswordStrengthIndicatorProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePasswordStrengthIndicatorProps Defined in: [src/types/Auth/PasswordStrengthIndicator/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/PasswordStrengthIndicator/interface.ts#L7) Props for the PasswordStrengthIndicator component. ## Remarks Displays a checklist of password requirements with real-time feedback. ## Properties ### isVisible? > `optional` **isVisible**: `boolean` Defined in: [src/types/Auth/PasswordStrengthIndicator/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/PasswordStrengthIndicator/interface.ts#L12) Controls component visibility - defaults to true *** ### password > **password**: `string` Defined in: [src/types/Auth/PasswordStrengthIndicator/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/PasswordStrengthIndicator/interface.ts#L9) Password string to validate against requirements ================================================ FILE: docs/docs/auto-docs/types/Auth/RegistrationForm/interface/interfaces/IRegistrationFormData.md ================================================ [Admin Docs](/) *** # Interface: IRegistrationFormData Defined in: [src/types/Auth/RegistrationForm/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L7) Form data structure for user registration ## Properties ### confirmPassword > **confirmPassword**: `string` Defined in: [src/types/Auth/RegistrationForm/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L11) *** ### email > **email**: `string` Defined in: [src/types/Auth/RegistrationForm/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L9) *** ### name > **name**: `string` Defined in: [src/types/Auth/RegistrationForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L8) *** ### orgId? > `optional` **orgId**: `string` Defined in: [src/types/Auth/RegistrationForm/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L12) *** ### password > **password**: `string` Defined in: [src/types/Auth/RegistrationForm/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L10) ================================================ FILE: docs/docs/auto-docs/types/Auth/RegistrationForm/interface/interfaces/IRegistrationFormProps.md ================================================ [Admin Docs](/) *** # Interface: IRegistrationFormProps Defined in: [src/types/Auth/RegistrationForm/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L18) Props for the RegistrationForm component ## Properties ### enableRecaptcha? > `optional` **enableRecaptcha**: `boolean` Defined in: [src/types/Auth/RegistrationForm/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L23) *** ### onError()? > `optional` **onError**: (`e`) => `void` Defined in: [src/types/Auth/RegistrationForm/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L22) #### Parameters ##### e `Error` #### Returns `void` *** ### onSuccess()? > `optional` **onSuccess**: (`result`) => `void` Defined in: [src/types/Auth/RegistrationForm/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L21) Called on successful signup with result so parent can handle session/redirect #### Parameters ##### result [`IRegistrationSuccessResult`](../../../../../hooks/auth/useRegistration/interfaces/IRegistrationSuccessResult.md) #### Returns `void` *** ### organizations > **organizations**: [`InterfaceOrgOption`](../../../OrgSelector/interface/interfaces/InterfaceOrgOption.md)[] Defined in: [src/types/Auth/RegistrationForm/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L19) ================================================ FILE: docs/docs/auto-docs/types/Auth/ValidationInterfaces/interfaces/InterfacePasswordRequirements.md ================================================ [Admin Docs](/) *** # Interface: InterfacePasswordRequirements Defined in: [src/types/Auth/ValidationInterfaces.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L14) Password complexity requirements status. ## Properties ### lowercase > **lowercase**: `boolean` Defined in: [src/types/Auth/ValidationInterfaces.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L16) Has lowercase letter *** ### numeric > **numeric**: `boolean` Defined in: [src/types/Auth/ValidationInterfaces.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L20) Has numeric digit *** ### specialChar > **specialChar**: `boolean` Defined in: [src/types/Auth/ValidationInterfaces.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L22) Has special character *** ### uppercase > **uppercase**: `boolean` Defined in: [src/types/Auth/ValidationInterfaces.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L18) Has uppercase letter ================================================ FILE: docs/docs/auto-docs/types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md ================================================ [Admin Docs](/) *** # Interface: InterfaceValidationResult Defined in: [src/types/Auth/ValidationInterfaces.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L4) Result of a validation operation. ## Properties ### error? > `optional` **error**: `string` Defined in: [src/types/Auth/ValidationInterfaces.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L8) Error message if validation failed *** ### isValid > **isValid**: `boolean` Defined in: [src/types/Auth/ValidationInterfaces.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L6) Whether the validation passed ================================================ FILE: docs/docs/auto-docs/types/Auth/auth/interfaces/IOAuthProviderConfig.md ================================================ [Admin Docs](/) *** # Interface: IOAuthProviderConfig Defined in: [src/types/Auth/auth.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L77) ## Properties ### clientId? > `optional` **clientId**: `string` Defined in: [src/types/Auth/auth.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L81) *** ### displayName > **displayName**: `string` Defined in: [src/types/Auth/auth.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L79) *** ### enabled > **enabled**: `boolean` Defined in: [src/types/Auth/auth.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L83) *** ### id > **id**: [`OAuthProviderKey`](../type-aliases/OAuthProviderKey.md) Defined in: [src/types/Auth/auth.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L78) *** ### redirectUri? > `optional` **redirectUri**: `string` Defined in: [src/types/Auth/auth.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L82) *** ### scopes > **scopes**: `string`[] Defined in: [src/types/Auth/auth.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L80) ================================================ FILE: docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceAuthenticationPayload.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAuthenticationPayload Defined in: [src/types/Auth/auth.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L36) Payload returned after successful authentication. ## Properties ### authenticationToken > **authenticationToken**: `string` Defined in: [src/types/Auth/auth.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L38) Token used for authenticating API requests *** ### refreshToken? > `optional` **refreshToken**: `string` Defined in: [src/types/Auth/auth.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L40) Optional token for refreshing the authentication token *** ### user > **user**: `InterfaceAuthUser` Defined in: [src/types/Auth/auth.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L42) Authenticated user information ================================================ FILE: docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceOAuthAccount.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOAuthAccount Defined in: [src/types/Auth/auth.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L48) Represents a linked OAuth account. ## Properties ### email > **email**: `string` Defined in: [src/types/Auth/auth.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L52) Email address associated with the OAuth account *** ### lastUsedAt > **lastUsedAt**: `string` Defined in: [src/types/Auth/auth.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L56) Date when the account was last used for authentication *** ### linkedAt > **linkedAt**: `string` Defined in: [src/types/Auth/auth.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L54) Date when the account was linked *** ### provider > **provider**: `string` Defined in: [src/types/Auth/auth.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L50) OAuth provider name ================================================ FILE: docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceOAuthLinkResponse.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOAuthLinkResponse Defined in: [src/types/Auth/auth.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L62) Response data returned from linking an OAuth account. ## Properties ### emailAddress > **emailAddress**: `string` Defined in: [src/types/Auth/auth.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L68) User's email address *** ### id > **id**: `string` Defined in: [src/types/Auth/auth.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L64) User's unique identifier *** ### isEmailAddressVerified > **isEmailAddressVerified**: `boolean` Defined in: [src/types/Auth/auth.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L70) Whether the user's email address has been verified *** ### name > **name**: `string` Defined in: [src/types/Auth/auth.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L66) User's full name *** ### oauthAccounts > **oauthAccounts**: [`InterfaceOAuthAccount`](InterfaceOAuthAccount.md)[] Defined in: [src/types/Auth/auth.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L74) List of linked OAuth accounts *** ### role > **role**: [`UserRole`](../../../../utils/interfaces/enumerations/UserRole.md) Defined in: [src/types/Auth/auth.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L72) User's role in the system ================================================ FILE: docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceOAuthLoginInput.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOAuthLoginInput Defined in: [src/types/Auth/auth.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L24) Input data required for OAuth login flow. ## Properties ### authorizationCode > **authorizationCode**: `string` Defined in: [src/types/Auth/auth.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L28) Authorization code received from OAuth provider *** ### provider > **provider**: [`OAuthProviderKey`](../type-aliases/OAuthProviderKey.md) Defined in: [src/types/Auth/auth.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L26) The OAuth provider to use for authentication *** ### redirectUri > **redirectUri**: `string` Defined in: [src/types/Auth/auth.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L30) Redirect URI registered with the OAuth provider ================================================ FILE: docs/docs/auto-docs/types/Auth/auth/type-aliases/OAuthProviderKey.md ================================================ [Admin Docs](/) *** # Type Alias: OAuthProviderKey > **OAuthProviderKey** = `"GOOGLE"` \| `"GITHUB"` Defined in: [src/types/Auth/auth.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L19) Supported OAuth providers for authentication. ================================================ FILE: docs/docs/auto-docs/types/Auth/useFieldValidation/interfaces/IUseFieldValidationReturn.md ================================================ [Admin Docs](/) *** # Interface: IUseFieldValidationReturn Defined in: [src/types/Auth/useFieldValidation.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L8) ## Properties ### clearError() > **clearError**: () => `void` Defined in: [src/types/Auth/useFieldValidation.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L11) #### Returns `void` *** ### error > **error**: `string` Defined in: [src/types/Auth/useFieldValidation.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L9) *** ### validate() > **validate**: () => `boolean` Defined in: [src/types/Auth/useFieldValidation.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L10) #### Returns `boolean` ================================================ FILE: docs/docs/auto-docs/types/Auth/useFieldValidation/interfaces/IValidationResult.md ================================================ [Admin Docs](/) *** # Interface: IValidationResult Defined in: [src/types/Auth/useFieldValidation.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L1) ## Properties ### error? > `optional` **error**: `string` Defined in: [src/types/Auth/useFieldValidation.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L3) *** ### isValid > **isValid**: `boolean` Defined in: [src/types/Auth/useFieldValidation.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L2) ================================================ FILE: docs/docs/auto-docs/types/Auth/useFieldValidation/type-aliases/ValidationTrigger.md ================================================ [Admin Docs](/) *** # Type Alias: ValidationTrigger > **ValidationTrigger** = `"onChange"` \| `"onBlur"` \| `"manual"` Defined in: [src/types/Auth/useFieldValidation.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L6) ================================================ FILE: docs/docs/auto-docs/types/Auth/useLogin/interface/interfaces/ILoginCredentials.md ================================================ [Admin Docs](/) *** # Interface: ILoginCredentials Defined in: [src/types/Auth/useLogin/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L6) Credentials required for login. ## Properties ### email > **email**: `string` Defined in: [src/types/Auth/useLogin/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L7) *** ### password > **password**: `string` Defined in: [src/types/Auth/useLogin/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L8) *** ### recaptchaToken? > `optional` **recaptchaToken**: `string` Defined in: [src/types/Auth/useLogin/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/Auth/useLogin/interface/interfaces/IUseLoginOptions.md ================================================ [Admin Docs](/) *** # Interface: IUseLoginOptions Defined in: [src/types/Auth/useLogin/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L15) Options for the useLogin hook. ## Properties ### onError()? > `optional` **onError**: (`error`) => `void` Defined in: [src/types/Auth/useLogin/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L17) #### Parameters ##### error `Error` #### Returns `void` *** ### onSuccess()? > `optional` **onSuccess**: (`result`) => `void` Defined in: [src/types/Auth/useLogin/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L16) #### Parameters ##### result [`InterfaceSignInResult`](../../../LoginForm/interface/interfaces/InterfaceSignInResult.md) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/Auth/usePasswordVisibility/interfaces/IUsePasswordVisibilityReturn.md ================================================ [Admin Docs](/) *** # Interface: IUsePasswordVisibilityReturn Defined in: [src/types/Auth/usePasswordVisibility.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/usePasswordVisibility.ts#L4) Return type for the usePasswordVisibility hook. ## Properties ### showPassword > **showPassword**: `boolean` Defined in: [src/types/Auth/usePasswordVisibility.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/usePasswordVisibility.ts#L5) *** ### togglePassword() > **togglePassword**: () => `void` Defined in: [src/types/Auth/usePasswordVisibility.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/usePasswordVisibility.ts#L6) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/Comment/type/type-aliases/Comment.md ================================================ [Admin Docs](/) *** # Type Alias: Comment > **Comment** = `object` Defined in: [src/types/Comment/type.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L4) ## Properties ### createdAt > **createdAt**: `Date` Defined in: [src/types/Comment/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L6) *** ### creator > **creator**: `Partial`\<[`User`](../../../shared-components/User/type/type-aliases/User.md)\> Defined in: [src/types/Comment/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L7) *** ### id > **id**: `string` Defined in: [src/types/Comment/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L5) *** ### likeCount? > `optional` **likeCount**: `number` Defined in: [src/types/Comment/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L8) *** ### post > **post**: [`Post`](../../../Post/type/type-aliases/Post.md) Defined in: [src/types/Comment/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L9) *** ### text > **text**: `string` Defined in: [src/types/Comment/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L10) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/Comment/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L11) ================================================ FILE: docs/docs/auto-docs/types/Comment/type/type-aliases/CommentInput.md ================================================ [Admin Docs](/) *** # Type Alias: CommentInput > **CommentInput** = `object` Defined in: [src/types/Comment/type.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L14) ## Properties ### text > **text**: `string` Defined in: [src/types/Comment/type.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L15) ================================================ FILE: docs/docs/auto-docs/types/CursorPagination/interface/interfaces/InterfaceConnectionData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceConnectionData\ Defined in: [src/types/CursorPagination/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L26) Represents the GraphQL connection structure with edges and pageInfo. This follows the Relay cursor pagination specification. ## Remarks While the Relay spec requires both edges and pageInfo, this interface makes pageInfo optional to gracefully handle incomplete responses. When pageInfo is missing, items are still rendered but pagination is disabled. ## Type Parameters ### TNode `TNode` The type of individual items in the connection ## Properties ### edges > **edges**: `object`[] Defined in: [src/types/CursorPagination/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L27) #### cursor > **cursor**: `string` #### node > **node**: `TNode` *** ### pageInfo? > `optional` **pageInfo**: [`DefaultConnectionPageInfo`](../../../AdminPortal/pagination/type-aliases/DefaultConnectionPageInfo.md) Defined in: [src/types/CursorPagination/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L31) ================================================ FILE: docs/docs/auto-docs/types/CursorPagination/interface/interfaces/InterfaceCursorPaginationManagerProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCursorPaginationManagerProps\ Defined in: [src/types/CursorPagination/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L40) Props for the CursorPaginationManager component. ## Type Parameters ### TData `TData` ### TNode `TNode` The type of individual items extracted from edges ### TVariables `TVariables` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\> The GraphQL query variables type (defaults to `Record`) ## Properties ### actionRef? > `optional` **actionRef**: `Ref`\<[`InterfaceCursorPaginationManagerRef`](InterfaceCursorPaginationManagerRef.md)\<`TNode`\>\> Defined in: [src/types/CursorPagination/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L166) Ref to access imperative actions *** ### className? > `optional` **className**: `string` Defined in: [src/types/CursorPagination/interface.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L171) Custom class name for the container *** ### dataPath > **dataPath**: `string` Defined in: [src/types/CursorPagination/interface.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L60) Dot-separated path to extract connection data from the query response #### Examples ```ts "users" for data.users ``` ```ts "organization.members" for data.organization.members ``` *** ### emptyStateComponent? > `optional` **emptyStateComponent**: `ReactNode` Defined in: [src/types/CursorPagination/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L119) Custom component to show when no items are available *** ### infiniteScroll? > `optional` **infiniteScroll**: `boolean` Defined in: [src/types/CursorPagination/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L176) Enable infinite scroll behavior (auto-load when reaching threshold) *** ### itemsPerPage? > `optional` **itemsPerPage**: `number` Defined in: [src/types/CursorPagination/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L66) Number of items to fetch per page default 10 *** ### keyExtractor()? > `optional` **keyExtractor**: (`item`, `index`) => `string` \| `number` Defined in: [src/types/CursorPagination/interface.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L109) Optional function to extract a unique key for each item #### Parameters ##### item `TNode` The current item ##### index `number` The index of the item in the array #### Returns `string` \| `number` A unique string or number identifier for the item #### Remarks Provides a stable key for React reconciliation. When not provided, falls back to using the array index as the key. #### Example ```tsx keyExtractor={(user) => user.id} ``` *** ### loadingComponent? > `optional` **loadingComponent**: `ReactNode` Defined in: [src/types/CursorPagination/interface.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L114) Custom loading component to show during initial data fetch *** ### onContentScroll()? > `optional` **onContentScroll**: (`e`) => `void` Defined in: [src/types/CursorPagination/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L161) Callback to handle scroll events or restoration. If provided, the manager might delegate some scroll logic to the parent. #### Parameters ##### e `UIEvent`\<`HTMLElement`\> #### Returns `void` *** ### onDataChange()? > `optional` **onDataChange**: (`data`) => `void` Defined in: [src/types/CursorPagination/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L124) Callback invoked when the data changes (initial load or after loading more) #### Parameters ##### data `TNode`[] #### Returns `void` *** ### onQueryResult()? > `optional` **onQueryResult**: (`data`) => `void` Defined in: [src/types/CursorPagination/interface.ts:155](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L155) Callback to return the full query result data. Useful when the parent component needs access to metadata in the response (e.g., chat title, member count) outside of the connection data. #### Parameters ##### data `TData` #### Returns `void` *** ### paginationType? > `optional` **paginationType**: `"forward"` \| `"backward"` Defined in: [src/types/CursorPagination/interface.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L137) Direction of pagination. 'forward': Uses 'first' and 'after' (default) 'backward': Uses 'last' and 'before' (mapped via variableKeyMap if needed) *** ### query > **query**: `DocumentNode` Defined in: [src/types/CursorPagination/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L48) GraphQL query document for fetching data *** ### queryVariables? > `optional` **queryVariables**: `Omit`\<`TVariables`, `"first"` \| `"after"`\> Defined in: [src/types/CursorPagination/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L53) Query variables (excluding pagination variables like 'first' and 'after') *** ### refetchTrigger? > `optional` **refetchTrigger**: `number` Defined in: [src/types/CursorPagination/interface.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L130) Trigger value that causes a refetch when changed Can be a number (counter) or any value that changes *** ### renderItem() > **renderItem**: (`item`, `index`) => `ReactNode` Defined in: [src/types/CursorPagination/interface.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L91) Function to render each item in the list #### Parameters ##### item `TNode` ##### index `number` #### Returns `ReactNode` #### Remarks When items have stable unique identifiers, provide a keyExtractor function to ensure proper React reconciliation. If keyExtractor is not provided, the component falls back to using the array index as the key, which works for append-only pagination but may cause issues if items are reordered. #### Example ```tsx // With keyExtractor for stable keys: user.id} renderItem={(user) =>
{user.name}
} /> // Without keyExtractor (uses index):
{user.name}
} /> ``` *** ### scrollThreshold? > `optional` **scrollThreshold**: `number` Defined in: [src/types/CursorPagination/interface.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L182) Distance from edge (top for backward, bottom for forward) to trigger load more. Default: 50px *** ### variableKeyMap? > `optional` **variableKeyMap**: `object` Defined in: [src/types/CursorPagination/interface.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L143) Map generic pagination variables (first, after, last, before) to custom query variable names. Useful when the query uses different variable names (e.g., 'lastMessages' instead of 'last'). #### after? > `optional` **after**: `string` #### before? > `optional` **before**: `string` #### first? > `optional` **first**: `string` #### last? > `optional` **last**: `string` ================================================ FILE: docs/docs/auto-docs/types/CursorPagination/interface/interfaces/InterfaceCursorPaginationManagerRef.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCursorPaginationManagerRef\ Defined in: [src/types/CursorPagination/interface.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L185) ## Type Parameters ### TNode `TNode` ## Properties ### addItem() > **addItem**: (`item`, `position?`) => `void` Defined in: [src/types/CursorPagination/interface.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L186) #### Parameters ##### item `TNode` ##### position? `"start"` | `"end"` #### Returns `void` *** ### getItems() > **getItems**: () => `TNode`[] Defined in: [src/types/CursorPagination/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L192) #### Returns `TNode`[] *** ### removeItem() > **removeItem**: (`predicate`) => `void` Defined in: [src/types/CursorPagination/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L187) #### Parameters ##### predicate (`item`) => `boolean` #### Returns `void` *** ### updateItem() > **updateItem**: (`predicate`, `updater`) => `void` Defined in: [src/types/CursorPagination/interface.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L188) #### Parameters ##### predicate (`item`) => `boolean` ##### updater (`item`) => `TNode` #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/CursorPagination/interface/type-aliases/PaginationVariables.md ================================================ [Admin Docs](/) *** # Type Alias: PaginationVariables\ > **PaginationVariables**\<`T`\> = `T` & `object` Defined in: [src/types/CursorPagination/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L7) Helper type to combine pagination variables with custom query variables ## Type Declaration ### after? > `optional` **after**: `string` \| `null` ### before? > `optional` **before**: `string` \| `null` ### first? > `optional` **first**: `number` ### last? > `optional` **last**: `number` ## Type Parameters ### T `T` *extends* `Record`\<`string`, `unknown`\> ================================================ FILE: docs/docs/auto-docs/types/DataGridWrapper/interface/interfaces/InterfaceDataGridWrapperProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDataGridWrapperProps\ Defined in: [src/types/DataGridWrapper/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L46) Props for the DataGridWrapper component. This interface defines the configuration for the `DataGridWrapper`, a standardized wrapper around MUI's DataGrid that provides consistent search, sorting, pagination, and styling across the application. ## Type Parameters ### T `T` *extends* `GridValidRowModel` = `GridValidRowModel` ## Properties ### actionColumn()? > `optional` **actionColumn**: (`row`) => `ReactNode` Defined in: [src/types/DataGridWrapper/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L168) A function to render custom content in the "Actions" column (appended to the right). #### Parameters ##### row `T` The data object for the row being rendered. #### Returns `ReactNode` A ReactNode (e.g., buttons, menu) to display in the actions cell. *** ### columns? > `optional` **columns**: [`TokenAwareGridColDef`](../type-aliases/TokenAwareGridColDef.md)\<`GridValidRowModel`, `unknown`, `unknown`\>[] Defined in: [src/types/DataGridWrapper/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L70) Configuration for the grid columns. Defines headers, widths, and cell rendering logic. Supports design tokens for width properties (width, minWidth, maxWidth). Token names like 'space-15' are automatically converted to pixel values. #### Example ```tsx columns={[ { field: 'name', headerName: 'Name', minWidth: 'space-15' }, // 150px { field: 'email', headerName: 'Email', minWidth: 200 }, // raw pixel value still works ]} ``` *** ### emptyStateMessage? > `optional` **emptyStateMessage**: `string` Defined in: [src/types/DataGridWrapper/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L198) Custom message to display when there are no rows and `loading` is false. Use `emptyStateProps` instead for full customization. If `emptyStateProps` is provided, this prop is ignored. This property is maintained for backward compatibility. *** ### emptyStateProps? > `optional` **emptyStateProps**: [`InterfaceEmptyStateProps`](../../../shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md) Defined in: [src/types/DataGridWrapper/interface.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L190) Full EmptyState component props for flexible empty state rendering. Takes precedence over `emptyStateMessage`. Allows customization of icon, description, action buttons, and more. #### Example ```tsx emptyStateProps={{ icon: "users", message: "noUsers", description: "inviteFirstUser", action: { label: "inviteUser", onClick: handleInvite, variant: "primary" }, dataTestId: "users-empty-state" }} ``` *** ### error? > `optional` **error**: `ReactNode` Defined in: [src/types/DataGridWrapper/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L203) Error message or component to display instead of the grid when data fetch fails. *** ### loading? > `optional` **loading**: `boolean` Defined in: [src/types/DataGridWrapper/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L75) If `true`, displays a loading indicator (e.g., Progress Bar) overlaying the grid. *** ### onRowClick()? > `optional` **onRowClick**: (`row`) => `void` Defined in: [src/types/DataGridWrapper/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L161) Callback fired when a row is clicked. #### Parameters ##### row `T` The data object of the clicked row. #### Returns `void` *** ### paginationConfig? > `optional` **paginationConfig**: `object` Defined in: [src/types/DataGridWrapper/interface.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L148) Configuration for pagination. #### defaultPageSize? > `optional` **defaultPageSize**: `number` The default number of rows per page. #### enabled > **enabled**: `boolean` Enables pagination controls. #### pageSizeOptions? > `optional` **pageSizeOptions**: `number`[] Available options for rows per page. default: [10, 25, 50, 100] *** ### rows? > `optional` **rows**: readonly `T`[] Defined in: [src/types/DataGridWrapper/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L53) The array of data rows to display in the grid. Each row must include a unique `id` property (string or number). *** ### searchConfig? > `optional` **searchConfig**: `object` Defined in: [src/types/DataGridWrapper/interface.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L105) Configuration for search functionality (client-side or server-side). #### debounceMs? > `optional` **debounceMs**: `number` Delay in milliseconds for search debounce. #### enabled > **enabled**: `boolean` Enables the search bar in the toolbar. #### fields? > `optional` **fields**: keyof `T` & `string`[] The fields (keys of T) to include in the search filter. Client-side only. #### onSearchByChange()? > `optional` **onSearchByChange**: (`searchBy`) => `void` Callback when search type changes in server-side mode. ##### Parameters ###### searchBy `string` ##### Returns `void` #### onSearchChange()? > `optional` **onSearchChange**: (`term`, `searchBy?`) => `void` Callback when search changes in server-side mode. ##### Parameters ###### term `string` ###### searchBy? `string` ##### Returns `void` #### placeholder? > `optional` **placeholder**: `string` Custom placeholder text for the search input. #### searchByOptions? > `optional` **searchByOptions**: `object`[] Search type options dropdown for server-side mode. #### searchInputTestId? > `optional` **searchInputTestId**: `string` Test ID for search input. #### searchTerm? > `optional` **searchTerm**: `string` Current search term value for server-side mode. #### selectedSearchBy? > `optional` **selectedSearchBy**: `string` Current selected search type for server-side mode. #### serverSide? > `optional` **serverSide**: `boolean` Enable server-side search mode. #### Example ```ts // Client-side search searchConfig: { enabled: true, fields: ['name', 'email'], placeholder: 'Search users...', } // Server-side search with search-by dropdown searchConfig: { enabled: true, serverSide: true, searchTerm: 'john', searchByOptions: [ { label: 'Group', value: 'group' }, { label: 'Leader', value: 'leader' } ], selectedSearchBy: 'group', onSearchChange: (term, searchBy) => refetchData(term, searchBy), onSearchByChange: (searchBy) => setSearchBy(searchBy), searchInputTestId: 'searchByInput' } ``` *** ### sortConfig? > `optional` **sortConfig**: `object` Defined in: [src/types/DataGridWrapper/interface.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L134) Configuration for sorting options displayed in a dropdown. Note: This is separate from MUI DataGrid's native column header sorting. #### defaultSortField? > `optional` **defaultSortField**: `string` #### defaultSortOrder? > `optional` **defaultSortOrder**: `"desc"` \| `"asc"` #### onSortChange()? > `optional` **onSortChange**: (`value`) => `void` Callback when sort changes in server-side mode. ##### Parameters ###### value `string` | `number` ##### Returns `void` #### selectedSort? > `optional` **selectedSort**: `string` \| `number` Current selected sort option for server-side mode. #### sortingOptions? > `optional` **sortingOptions**: `object`[] Array of sorting options for the SortingButton component. ================================================ FILE: docs/docs/auto-docs/types/DataGridWrapper/interface/type-aliases/TokenAwareGridColDef.md ================================================ [Admin Docs](/) *** # Type Alias: TokenAwareGridColDef\ > **TokenAwareGridColDef**\<`TRow`, `TValue`, `TFormattedValue`\> = `Omit`\<`GridColDef`\<`TRow`, `TValue`, `TFormattedValue`\>, `"width"` \| `"minWidth"` \| `"maxWidth"`\> & `object` Defined in: [src/types/DataGridWrapper/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L24) Extended column definition that accepts design tokens for width properties. MUI DataGrid requires numeric values for width, minWidth, and maxWidth. This type allows using spacing token names (e.g., 'space-15') which are converted to pixel values by DataGridWrapper before passing to MUI. ## Type Declaration ### maxWidth? > `optional` **maxWidth**: `number` \| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md) Maximum column width - accepts number (pixels) or spacing token name ### minWidth? > `optional` **minWidth**: `number` \| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md) Minimum column width - accepts number (pixels) or spacing token name ### width? > `optional` **width**: `number` \| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md) Column width - accepts number (pixels) or spacing token name ## Type Parameters ### TRow `TRow` *extends* `GridValidRowModel` = `GridValidRowModel` ### TValue `TValue` = `unknown` ### TFormattedValue `TFormattedValue` = `TValue` ## Example ```tsx const columns: TokenAwareGridColDef[] = [ { field: 'name', headerName: 'Name', minWidth: 'space-15' }, // 150px { field: 'email', headerName: 'Email', width: 'space-17' }, // 220px ]; ``` ================================================ FILE: docs/docs/auto-docs/types/DropDown/interface/interfaces/InterfaceCollapsibleDropdown.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCollapsibleDropdown Defined in: [src/types/DropDown/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L8) ## Properties ### setShowDropdown > **setShowDropdown**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/types/DropDown/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L11) *** ### showDropdown > **showDropdown**: `boolean` Defined in: [src/types/DropDown/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L9) *** ### target > **target**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md) Defined in: [src/types/DropDown/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L10) ================================================ FILE: docs/docs/auto-docs/types/DropDown/interface/interfaces/InterfaceDropDownProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDropDownProps Defined in: [src/types/DropDown/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L2) ## Properties ### btnStyle? > `optional` **btnStyle**: `string` Defined in: [src/types/DropDown/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L4) *** ### btnTextStyle? > `optional` **btnTextStyle**: `string` Defined in: [src/types/DropDown/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L5) *** ### parentContainerStyle? > `optional` **parentContainerStyle**: `string` Defined in: [src/types/DropDown/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L3) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/enumerations/UserRole.md ================================================ [Admin Docs](/) *** # Enumeration: UserRole Defined in: [src/types/Event/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L7) ## Enumeration Members ### ADMINISTRATOR > **ADMINISTRATOR**: `"ADMINISTRATOR"` Defined in: [src/types/Event/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L8) *** ### REGULAR > **REGULAR**: `"REGULAR"` Defined in: [src/types/Event/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IAttendanceStatisticsModalProps.md ================================================ [Admin Docs](/) *** # Interface: IAttendanceStatisticsModalProps Defined in: [src/types/Event/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L203) ## Properties ### handleClose() > **handleClose**: () => `void` Defined in: [src/types/Event/interface.ts:205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L205) #### Returns `void` *** ### memberData > **memberData**: [`IMember`](IMember.md)[] Defined in: [src/types/Event/interface.ts:211](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L211) *** ### show > **show**: `boolean` Defined in: [src/types/Event/interface.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L204) *** ### statistics > **statistics**: `object` Defined in: [src/types/Event/interface.ts:206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L206) #### attendanceRate > **attendanceRate**: `number` #### membersAttended > **membersAttended**: `number` #### totalMembers > **totalMembers**: `number` *** ### t() > **t**: (`key`, `options?`) => `string` Defined in: [src/types/Event/interface.ts:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L212) #### Parameters ##### key `string` ##### options? `Record`\<`string`, `unknown`\> #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/ICalendarProps.md ================================================ [Admin Docs](/) *** # Interface: ICalendarProps Defined in: [src/types/Event/interface.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L111) ## Properties ### currentMonth? > `optional` **currentMonth**: `number` Defined in: [src/types/Event/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L119) *** ### currentYear? > `optional` **currentYear**: `number` Defined in: [src/types/Event/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L120) *** ### eventData > **eventData**: [`IEvent`](IEvent.md)[] Defined in: [src/types/Event/interface.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L112) *** ### onMonthChange()? > `optional` **onMonthChange**: (`month`, `year`) => `void` Defined in: [src/types/Event/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L118) #### Parameters ##### month `number` ##### year `number` #### Returns `void` *** ### orgData? > `optional` **orgData**: [`IOrgList`](IOrgList.md) Defined in: [src/types/Event/interface.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L114) *** ### refetchEvents()? > `optional` **refetchEvents**: () => `void` Defined in: [src/types/Event/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L113) #### Returns `void` *** ### userId? > `optional` **userId**: `string` Defined in: [src/types/Event/interface.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L116) *** ### userRole? > `optional` **userRole**: `string` Defined in: [src/types/Event/interface.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L115) *** ### viewType? > `optional` **viewType**: [`ViewType`](../../../../screens/AdminPortal/OrganizationEvents/OrganizationEvents/enumerations/ViewType.md) Defined in: [src/types/Event/interface.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L117) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/ICreateEventInput.md ================================================ [Admin Docs](/) *** # Interface: ICreateEventInput Defined in: [src/types/Event/interface.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L267) Input interface for creating events via CREATE_EVENT_MUTATION. Used by both Admin Portal (CreateEventModal) and User Portal (Events). Note: The recurrence property type matches the return type of formatRecurrenceForPayload from EventForm.tsx ## Properties ### allDay > **allDay**: `boolean` Defined in: [src/types/Event/interface.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L272) *** ### description? > `optional` **description**: `string` Defined in: [src/types/Event/interface.ts:280](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L280) *** ### endAt > **endAt**: `string` Defined in: [src/types/Event/interface.ts:270](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L270) *** ### isInviteOnly > **isInviteOnly**: `boolean` Defined in: [src/types/Event/interface.ts:279](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L279) *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Event/interface.ts:277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L277) Determines if the event is visible to the entire community. Often referred to as "Community Visible" in the UI. *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/Event/interface.ts:278](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L278) *** ### location? > `optional` **location**: `string` Defined in: [src/types/Event/interface.ts:281](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L281) *** ### name > **name**: `string` Defined in: [src/types/Event/interface.ts:268](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L268) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/Event/interface.ts:271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L271) *** ### recurrence? > `optional` **recurrence**: `Omit`\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `"endDate"`\> & `object` Defined in: [src/types/Event/interface.ts:282](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L282) #### Type Declaration ##### endDate? > `optional` **endDate**: `string` *** ### startAt > **startAt**: `string` Defined in: [src/types/Event/interface.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L269) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IDeleteEventModalProps.md ================================================ [Admin Docs](/) *** # Interface: IDeleteEventModalProps Defined in: [src/types/Event/interface.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L139) ## Properties ### deleteEventHandler() > **deleteEventHandler**: (`deleteOption?`) => `Promise`\<`void`\> Defined in: [src/types/Event/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L145) #### Parameters ##### deleteOption? `"all"` | `"single"` | `"following"` #### Returns `Promise`\<`void`\> *** ### eventDeleteModalIsOpen > **eventDeleteModalIsOpen**: `boolean` Defined in: [src/types/Event/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L141) *** ### eventListCardProps > **eventListCardProps**: [`IEventListCard`](IEventListCard.md) Defined in: [src/types/Event/interface.ts:140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L140) *** ### t() > **t**: (`key`, `options?`) => `string` Defined in: [src/types/Event/interface.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L143) #### Parameters ##### key `string` ##### options? `Record`\<`string`, `unknown`\> #### Returns `string` *** ### tCommon() > **tCommon**: (`key`) => `string` Defined in: [src/types/Event/interface.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L144) #### Parameters ##### key `string` #### Returns `string` *** ### toggleDeleteModal() > **toggleDeleteModal**: () => `void` Defined in: [src/types/Event/interface.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L142) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IEvent.md ================================================ [Admin Docs](/) *** # Interface: IEvent Defined in: [src/types/Event/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L40) ## Extended by - [`IEventListCard`](IEventListCard.md) ## Properties ### allDay > **allDay**: `boolean` Defined in: [src/types/Event/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L51) *** ### attendees > **attendees**: `Partial`\<[`User`](../../type/type-aliases/User.md)\>[] Defined in: [src/types/Event/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L64) *** ### averageFeedbackScore? > `optional` **averageFeedbackScore**: `number` Defined in: [src/types/Event/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L66) *** ### baseEvent? > `optional` **baseEvent**: `object` Defined in: [src/types/Event/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L70) #### id > **id**: `string` *** ### creator > **creator**: `Partial`\<[`User`](../../type/type-aliases/User.md)\> Defined in: [src/types/Event/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L65) *** ### description > **description**: `string` Defined in: [src/types/Event/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L46) *** ### endAt > **endAt**: `string` Defined in: [src/types/Event/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L48) *** ### endTime? > `optional` **endTime**: `string` Defined in: [src/types/Event/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L50) *** ### feedback? > `optional` **feedback**: [`Feedback`](../../type/type-aliases/Feedback.md)[] Defined in: [src/types/Event/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L67) *** ### hasExceptions? > `optional` **hasExceptions**: `boolean` Defined in: [src/types/Event/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L75) *** ### id > **id**: `string` Defined in: [src/types/Event/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L43) *** ### isInviteOnly > **isInviteOnly**: `boolean` Defined in: [src/types/Event/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L63) Determines if the event is restricted to invited participants only. When true, only invited users can see and access the event. *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Event/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L57) Determines if the event is visible to the entire community. Often referred to as "Community Visible" in the UI. *** ### isRecurringEventTemplate? > `optional` **isRecurringEventTemplate**: `boolean` Defined in: [src/types/Event/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L69) *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/Event/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L58) *** ### key? > `optional` **key**: `string` Defined in: [src/types/Event/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L42) *** ### location > **location**: `string` Defined in: [src/types/Event/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L44) *** ### name > **name**: `string` Defined in: [src/types/Event/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L45) *** ### progressLabel? > `optional` **progressLabel**: `string` Defined in: [src/types/Event/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L76) *** ### recurrenceDescription? > `optional` **recurrenceDescription**: `string` Defined in: [src/types/Event/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L78) *** ### recurrenceRule? > `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/types/Event/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L79) *** ### sequenceNumber? > `optional` **sequenceNumber**: `number` Defined in: [src/types/Event/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L73) *** ### startAt > **startAt**: `string` Defined in: [src/types/Event/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L47) *** ### startTime? > `optional` **startTime**: `string` Defined in: [src/types/Event/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L49) *** ### totalCount? > `optional` **totalCount**: `number` Defined in: [src/types/Event/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L74) *** ### userId? > `optional` **userId**: `string` Defined in: [src/types/Event/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L52) *** ### userRole? > `optional` **userRole**: `string` Defined in: [src/types/Event/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L41) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IEventEdge.md ================================================ [Admin Docs](/) *** # Interface: IEventEdge Defined in: [src/types/Event/interface.ts:215](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L215) ## Properties ### cursor > **cursor**: `string` Defined in: [src/types/Event/interface.ts:257](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L257) *** ### node > **node**: `object` Defined in: [src/types/Event/interface.ts:216](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L216) #### allDay > **allDay**: `boolean` #### attendees? > `optional` **attendees**: `object`[] #### baseEvent? > `optional` **baseEvent**: `object` ##### baseEvent.id > **id**: `string` ##### baseEvent.name > **name**: `string` #### creator? > `optional` **creator**: `object` ##### creator.id > **id**: `string` ##### creator.name > **name**: `string` #### description? > `optional` **description**: `string` #### endAt > **endAt**: `string` #### hasExceptions? > `optional` **hasExceptions**: `boolean` #### id > **id**: `string` #### isInviteOnly > **isInviteOnly**: `boolean` Determines if the event is restricted to invited participants only. When true, only invited users, the creator, and admins can see and access the event. #### isPublic > **isPublic**: `boolean` Determines if the event is visible to the entire community. Often referred to as "Community Visible" in the UI. #### isRecurringEventTemplate? > `optional` **isRecurringEventTemplate**: `boolean` #### isRegisterable > **isRegisterable**: `boolean` #### location? > `optional` **location**: `string` #### name > **name**: `string` #### progressLabel? > `optional` **progressLabel**: `string` #### recurrenceDescription? > `optional` **recurrenceDescription**: `string` #### recurrenceRule? > `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) #### sequenceNumber? > `optional` **sequenceNumber**: `number` #### startAt > **startAt**: `string` #### totalCount? > `optional` **totalCount**: `number` ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IEventHeaderProps.md ================================================ [Admin Docs](/) *** # Interface: IEventHeaderProps Defined in: [src/types/Event/interface.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L123) ## Properties ### handleChangeView() > **handleChangeView**: (`item`) => `void` Defined in: [src/types/Event/interface.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L125) #### Parameters ##### item `string` #### Returns `void` *** ### showInviteModal() > **showInviteModal**: () => `void` Defined in: [src/types/Event/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L126) #### Returns `void` *** ### viewType > **viewType**: [`ViewType`](../../../../screens/AdminPortal/OrganizationEvents/OrganizationEvents/enumerations/ViewType.md) Defined in: [src/types/Event/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L124) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IEventListCard.md ================================================ [Admin Docs](/) *** # Interface: IEventListCard Defined in: [src/types/Event/interface.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L134) Props for EventListCard component. `@remarks` Extends IEvent and adds optional refetchEvents callback. ## Extends - [`IEvent`](IEvent.md) ## Properties ### allDay > **allDay**: `boolean` Defined in: [src/types/Event/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L51) #### Inherited from [`IEvent`](IEvent.md).[`allDay`](IEvent.md#allday) *** ### attendees > **attendees**: `Partial`\<[`User`](../../type/type-aliases/User.md)\>[] Defined in: [src/types/Event/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L64) #### Inherited from [`IEvent`](IEvent.md).[`attendees`](IEvent.md#attendees) *** ### averageFeedbackScore? > `optional` **averageFeedbackScore**: `number` Defined in: [src/types/Event/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L66) #### Inherited from [`IEvent`](IEvent.md).[`averageFeedbackScore`](IEvent.md#averagefeedbackscore) *** ### baseEvent? > `optional` **baseEvent**: `object` Defined in: [src/types/Event/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L70) #### id > **id**: `string` #### Inherited from [`IEvent`](IEvent.md).[`baseEvent`](IEvent.md#baseevent) *** ### creator > **creator**: `Partial`\<[`User`](../../type/type-aliases/User.md)\> Defined in: [src/types/Event/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L65) #### Inherited from [`IEvent`](IEvent.md).[`creator`](IEvent.md#creator) *** ### description > **description**: `string` Defined in: [src/types/Event/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L46) #### Inherited from [`IEvent`](IEvent.md).[`description`](IEvent.md#description) *** ### endAt > **endAt**: `string` Defined in: [src/types/Event/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L48) #### Inherited from [`IEvent`](IEvent.md).[`endAt`](IEvent.md#endat) *** ### endTime? > `optional` **endTime**: `string` Defined in: [src/types/Event/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L50) #### Inherited from [`IEvent`](IEvent.md).[`endTime`](IEvent.md#endtime) *** ### feedback? > `optional` **feedback**: [`Feedback`](../../type/type-aliases/Feedback.md)[] Defined in: [src/types/Event/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L67) #### Inherited from [`IEvent`](IEvent.md).[`feedback`](IEvent.md#feedback) *** ### hasExceptions? > `optional` **hasExceptions**: `boolean` Defined in: [src/types/Event/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L75) #### Inherited from [`IEvent`](IEvent.md).[`hasExceptions`](IEvent.md#hasexceptions) *** ### id > **id**: `string` Defined in: [src/types/Event/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L43) #### Inherited from [`IEvent`](IEvent.md).[`id`](IEvent.md#id) *** ### isInviteOnly > **isInviteOnly**: `boolean` Defined in: [src/types/Event/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L63) Determines if the event is restricted to invited participants only. When true, only invited users can see and access the event. #### Inherited from [`IEvent`](IEvent.md).[`isInviteOnly`](IEvent.md#isinviteonly) *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Event/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L57) Determines if the event is visible to the entire community. Often referred to as "Community Visible" in the UI. #### Inherited from [`IEvent`](IEvent.md).[`isPublic`](IEvent.md#ispublic) *** ### isRecurringEventTemplate? > `optional` **isRecurringEventTemplate**: `boolean` Defined in: [src/types/Event/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L69) #### Inherited from [`IEvent`](IEvent.md).[`isRecurringEventTemplate`](IEvent.md#isrecurringeventtemplate) *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/Event/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L58) #### Inherited from [`IEvent`](IEvent.md).[`isRegisterable`](IEvent.md#isregisterable) *** ### key? > `optional` **key**: `string` Defined in: [src/types/Event/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L42) #### Inherited from [`IEvent`](IEvent.md).[`key`](IEvent.md#key) *** ### location > **location**: `string` Defined in: [src/types/Event/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L44) #### Inherited from [`IEvent`](IEvent.md).[`location`](IEvent.md#location) *** ### name > **name**: `string` Defined in: [src/types/Event/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L45) #### Inherited from [`IEvent`](IEvent.md).[`name`](IEvent.md#name) *** ### progressLabel? > `optional` **progressLabel**: `string` Defined in: [src/types/Event/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L76) #### Inherited from [`IEvent`](IEvent.md).[`progressLabel`](IEvent.md#progresslabel) *** ### recurrenceDescription? > `optional` **recurrenceDescription**: `string` Defined in: [src/types/Event/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L78) #### Inherited from [`IEvent`](IEvent.md).[`recurrenceDescription`](IEvent.md#recurrencedescription) *** ### recurrenceRule? > `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/types/Event/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L79) #### Inherited from [`IEvent`](IEvent.md).[`recurrenceRule`](IEvent.md#recurrencerule) *** ### refetchEvents()? > `optional` **refetchEvents**: () => `void` Defined in: [src/types/Event/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L136) Optional callback to refresh the events list after modifications. #### Returns `void` *** ### sequenceNumber? > `optional` **sequenceNumber**: `number` Defined in: [src/types/Event/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L73) #### Inherited from [`IEvent`](IEvent.md).[`sequenceNumber`](IEvent.md#sequencenumber) *** ### startAt > **startAt**: `string` Defined in: [src/types/Event/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L47) #### Inherited from [`IEvent`](IEvent.md).[`startAt`](IEvent.md#startat) *** ### startTime? > `optional` **startTime**: `string` Defined in: [src/types/Event/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L49) #### Inherited from [`IEvent`](IEvent.md).[`startTime`](IEvent.md#starttime) *** ### totalCount? > `optional` **totalCount**: `number` Defined in: [src/types/Event/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L74) #### Inherited from [`IEvent`](IEvent.md).[`totalCount`](IEvent.md#totalcount) *** ### userId? > `optional` **userId**: `string` Defined in: [src/types/Event/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L52) #### Inherited from [`IEvent`](IEvent.md).[`userId`](IEvent.md#userid) *** ### userRole? > `optional` **userRole**: `string` Defined in: [src/types/Event/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L41) #### Inherited from [`IEvent`](IEvent.md).[`userRole`](IEvent.md#userrole) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IMember.md ================================================ [Admin Docs](/) *** # Interface: IMember Defined in: [src/types/Event/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L18) ## Properties ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/Event/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L22) *** ### birthDate > **birthDate**: `Date` Defined in: [src/types/Event/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L27) *** ### createdAt > **createdAt**: `string` Defined in: [src/types/Event/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L19) *** ### emailAddress > **emailAddress**: `` `${string}@${string}.${string}` `` Defined in: [src/types/Event/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L21) *** ### eventsAttended? > `optional` **eventsAttended**: `object`[] Defined in: [src/types/Event/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L24) #### id > **id**: `string` *** ### id > **id**: `string` Defined in: [src/types/Event/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L29) *** ### name > **name**: `string` Defined in: [src/types/Event/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L20) *** ### natalSex > **natalSex**: `string` Defined in: [src/types/Event/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L23) *** ### role > **role**: `string` Defined in: [src/types/Event/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L28) *** ### tagsAssignedWith > **tagsAssignedWith**: `object` Defined in: [src/types/Event/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L30) #### edges > **edges**: `object`[] ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IOrgList.md ================================================ [Admin Docs](/) *** # Interface: IOrgList Defined in: [src/types/Event/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L82) ## Properties ### id > **id**: `string` Defined in: [src/types/Event/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L83) *** ### members > **members**: `object` Defined in: [src/types/Event/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L84) #### edges > **edges**: `object`[] #### pageInfo > **pageInfo**: `object` ##### pageInfo.endCursor > **endCursor**: `string` ##### pageInfo.hasNextPage > **hasNextPage**: `boolean` ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IPreviewEventModalProps.md ================================================ [Admin Docs](/) *** # Interface: IPreviewEventModalProps Defined in: [src/types/Event/interface.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L150) ## Properties ### allDayChecked > **allDayChecked**: `boolean` Defined in: [src/types/Event/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L163) *** ### customRecurrenceModalIsOpen > **customRecurrenceModalIsOpen**: `boolean` Defined in: [src/types/Event/interface.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L190) *** ### eventEndDate > **eventEndDate**: `Date` Defined in: [src/types/Event/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L160) *** ### eventListCardProps > **eventListCardProps**: [`IEventListCard`](IEventListCard.md) Defined in: [src/types/Event/interface.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L151) *** ### eventModalIsOpen > **eventModalIsOpen**: `boolean` Defined in: [src/types/Event/interface.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L152) *** ### eventStartDate > **eventStartDate**: `Date` Defined in: [src/types/Event/interface.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L159) *** ### formState > **formState**: `object` Defined in: [src/types/Event/interface.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L171) #### endTime > **endTime**: `string` #### eventDescription > **eventDescription**: `string` #### location > **location**: `string` #### name > **name**: `string` #### startTime > **startTime**: `string` *** ### handleEventUpdate() > **handleEventUpdate**: () => `Promise`\<`void`\> Defined in: [src/types/Event/interface.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L186) #### Returns `Promise`\<`void`\> *** ### hideViewModal() > **hideViewModal**: () => `void` Defined in: [src/types/Event/interface.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L153) #### Returns `void` *** ### inviteOnlyChecked > **inviteOnlyChecked**: `boolean` Defined in: [src/types/Event/interface.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L169) *** ### isRegistered? > `optional` **isRegistered**: `boolean` Defined in: [src/types/Event/interface.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L157) *** ### openEventDashboard() > **openEventDashboard**: () => `void` Defined in: [src/types/Event/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L187) #### Returns `void` *** ### publicChecked > **publicChecked**: `boolean` Defined in: [src/types/Event/interface.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L165) *** ### recurrence > **recurrence**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/types/Event/interface.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L188) *** ### registerableChecked > **registerableChecked**: `boolean` Defined in: [src/types/Event/interface.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L167) *** ### registerEventHandler() > **registerEventHandler**: () => `Promise`\<`void`\> Defined in: [src/types/Event/interface.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L185) #### Returns `Promise`\<`void`\> *** ### setAllDayChecked > **setAllDayChecked**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/types/Event/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L164) *** ### setCustomRecurrenceModalIsOpen > **setCustomRecurrenceModalIsOpen**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/types/Event/interface.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L191) *** ### setEventEndDate > **setEventEndDate**: `Dispatch`\<`SetStateAction`\<`Date`\>\> Defined in: [src/types/Event/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L162) *** ### setEventStartDate > **setEventStartDate**: `Dispatch`\<`SetStateAction`\<`Date`\>\> Defined in: [src/types/Event/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L161) *** ### setFormState() > **setFormState**: (`state`) => `void` Defined in: [src/types/Event/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L178) #### Parameters ##### state ###### endTime `string` ###### eventDescription `string` ###### location `string` ###### name `string` ###### startTime `string` #### Returns `void` *** ### setInviteOnlyChecked > **setInviteOnlyChecked**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/types/Event/interface.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L170) *** ### setPublicChecked > **setPublicChecked**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/types/Event/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L166) *** ### setRecurrence > **setRecurrence**: `Dispatch`\<`SetStateAction`\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\>\> Defined in: [src/types/Event/interface.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L189) *** ### setRegisterableChecked > **setRegisterableChecked**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/types/Event/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L168) *** ### t() > **t**: (`key`, `options?`) => `string` Defined in: [src/types/Event/interface.ts:155](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L155) #### Parameters ##### key `string` ##### options? `Record`\<`string`, `unknown`\> #### Returns `string` *** ### tCommon() > **tCommon**: (`key`) => `string` Defined in: [src/types/Event/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L156) #### Parameters ##### key `string` #### Returns `string` *** ### toggleDeleteModal() > **toggleDeleteModal**: () => `void` Defined in: [src/types/Event/interface.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L154) #### Returns `void` *** ### userId > **userId**: `string` Defined in: [src/types/Event/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L158) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IStatsModal.md ================================================ [Admin Docs](/) *** # Interface: IStatsModal Defined in: [src/types/Event/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L101) ## Properties ### data > **data**: `object` Defined in: [src/types/Event/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L102) #### event > **event**: `object` ##### event.\_id > **\_id**: `string` ##### event.averageFeedbackScore > **averageFeedbackScore**: `number` ##### event.feedback > **feedback**: [`Feedback`](../../type/type-aliases/Feedback.md)[] ================================================ FILE: docs/docs/auto-docs/types/Event/interface/interfaces/IUpdateEventModalProps.md ================================================ [Admin Docs](/) *** # Interface: IUpdateEventModalProps Defined in: [src/types/Event/interface.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L194) ## Properties ### eventListCardProps > **eventListCardProps**: [`IEventListCard`](IEventListCard.md) Defined in: [src/types/Event/interface.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L195) *** ### recurringEventUpdateModalIsOpen > **recurringEventUpdateModalIsOpen**: `boolean` Defined in: [src/types/Event/interface.ts:196](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L196) *** ### t() > **t**: (`key`, `options?`) => `string` Defined in: [src/types/Event/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L198) #### Parameters ##### key `string` ##### options? `Record`\<`string`, `unknown`\> #### Returns `string` *** ### tCommon() > **tCommon**: (`key`) => `string` Defined in: [src/types/Event/interface.ts:199](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L199) #### Parameters ##### key `string` #### Returns `string` *** ### toggleRecurringEventUpdateModal() > **toggleRecurringEventUpdateModal**: () => `void` Defined in: [src/types/Event/interface.ts:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L197) #### Returns `void` *** ### updateEventHandler() > **updateEventHandler**: () => `Promise`\<`void`\> Defined in: [src/types/Event/interface.ts:200](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L200) #### Returns `Promise`\<`void`\> ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceAttendanceStatisticsModalProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceAttendanceStatisticsModalProps > **InterfaceAttendanceStatisticsModalProps** = [`IAttendanceStatisticsModalProps`](../interfaces/IAttendanceStatisticsModalProps.md) Defined in: [src/types/Event/interface.ts:300](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L300) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceCalendarProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceCalendarProps > **InterfaceCalendarProps** = [`ICalendarProps`](../interfaces/ICalendarProps.md) Defined in: [src/types/Event/interface.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L294) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceDeleteEventModalProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceDeleteEventModalProps > **InterfaceDeleteEventModalProps** = [`IDeleteEventModalProps`](../interfaces/IDeleteEventModalProps.md) Defined in: [src/types/Event/interface.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L296) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceEvent.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceEvent > **InterfaceEvent** = [`IEvent`](../interfaces/IEvent.md) Defined in: [src/types/Event/interface.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L291) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceEventEdge.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceEventEdge > **InterfaceEventEdge** = [`IEventEdge`](../interfaces/IEventEdge.md) Defined in: [src/types/Event/interface.ts:298](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L298) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceEventHeaderProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceEventHeaderProps > **InterfaceEventHeaderProps** = [`IEventHeaderProps`](../interfaces/IEventHeaderProps.md) Defined in: [src/types/Event/interface.ts:295](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L295) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceIOrgList.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceIOrgList > **InterfaceIOrgList** = [`IOrgList`](../interfaces/IOrgList.md) Defined in: [src/types/Event/interface.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L292) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceMember.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceMember > **InterfaceMember** = [`IMember`](../interfaces/IMember.md) Defined in: [src/types/Event/interface.ts:290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L290) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfacePreviewEventModalProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfacePreviewEventModalProps > **InterfacePreviewEventModalProps** = [`IPreviewEventModalProps`](../interfaces/IPreviewEventModalProps.md) Defined in: [src/types/Event/interface.ts:297](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L297) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceStatsModal.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceStatsModal > **InterfaceStatsModal** = [`IStatsModal`](../interfaces/IStatsModal.md) Defined in: [src/types/Event/interface.ts:293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L293) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceUpdateEventModalProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceUpdateEventModalProps > **InterfaceUpdateEventModalProps** = [`IUpdateEventModalProps`](../interfaces/IUpdateEventModalProps.md) Defined in: [src/types/Event/interface.ts:299](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L299) ================================================ FILE: docs/docs/auto-docs/types/Event/interface/variables/FilterPeriod.md ================================================ [Admin Docs](/) *** # Variable: FilterPeriod > `const` **FilterPeriod**: `object` Defined in: [src/types/Event/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L12) ## Type Declaration ### All > `readonly` **All**: `"All"` = `'All'` ### ThisMonth > `readonly` **ThisMonth**: `"This Month"` = `'This Month'` ### ThisYear > `readonly` **ThisYear**: `"This Year"` = `'This Year'` ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/Event.md ================================================ [Admin Docs](/) *** # Type Alias: Event > **Event** = `object` Defined in: [src/types/Event/type.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L16) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/Event/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L17) *** ### actionItems > **actionItems**: [`ActionItem`](../../../AdminPortal/actionItem/type-aliases/ActionItem.md)[] Defined in: [src/types/Event/type.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L18) *** ### admins? > `optional` **admins**: [`User`](User.md)[] Defined in: [src/types/Event/type.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L19) *** ### allDay > **allDay**: `boolean` Defined in: [src/types/Event/type.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L20) *** ### attendees > **attendees**: [`User`](User.md)[] Defined in: [src/types/Event/type.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L21) *** ### attendeesCheckInStatus > **attendeesCheckInStatus**: [`CheckInStatus`](../../../shared-components/CheckIn/type/type-aliases/CheckInStatus.md)[] Defined in: [src/types/Event/type.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L22) *** ### averageFeedbackScore? > `optional` **averageFeedbackScore**: `number` Defined in: [src/types/Event/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L23) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/Event/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L24) *** ### creator > **creator**: [`User`](User.md) Defined in: [src/types/Event/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L25) *** ### description > **description**: `string` Defined in: [src/types/Event/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L26) *** ### endDate? > `optional` **endDate**: `Date` Defined in: [src/types/Event/type.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L27) *** ### endTime? > `optional` **endTime**: `string` Defined in: [src/types/Event/type.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L28) *** ### feedback > **feedback**: [`Feedback`](Feedback.md)[] Defined in: [src/types/Event/type.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L29) *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Event/type.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L30) *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/Event/type.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L31) *** ### latitude? > `optional` **latitude**: `number` Defined in: [src/types/Event/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L32) *** ### location? > `optional` **location**: `string` Defined in: [src/types/Event/type.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L33) *** ### longitude? > `optional` **longitude**: `number` Defined in: [src/types/Event/type.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L34) *** ### organization? > `optional` **organization**: [`Organization`](../../../AdminPortal/Organization/type/type-aliases/Organization.md) Defined in: [src/types/Event/type.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L35) *** ### recurrence? > `optional` **recurrence**: `string` Defined in: [src/types/Event/type.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L36) *** ### recurring > **recurring**: `boolean` Defined in: [src/types/Event/type.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L37) *** ### startDate > **startDate**: `Date` Defined in: [src/types/Event/type.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L38) *** ### startTime > **startTime**: `string` Defined in: [src/types/Event/type.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L39) *** ### status > **status**: `string` Defined in: [src/types/Event/type.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L40) *** ### title > **title**: `string` Defined in: [src/types/Event/type.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L41) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/Event/type.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L42) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/EventAttendeeInput.md ================================================ [Admin Docs](/) *** # Type Alias: EventAttendeeInput > **EventAttendeeInput** = `object` Defined in: [src/types/Event/type.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L78) ## Properties ### eventId > **eventId**: `string` Defined in: [src/types/Event/type.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L79) *** ### userId > **userId**: `string` Defined in: [src/types/Event/type.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L80) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/EventInput.md ================================================ [Admin Docs](/) *** # Type Alias: EventInput > **EventInput** = `object` Defined in: [src/types/Event/type.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L60) ## Properties ### allDay > **allDay**: `boolean` Defined in: [src/types/Event/type.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L61) *** ### description > **description**: `string` Defined in: [src/types/Event/type.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L62) *** ### endDate? > `optional` **endDate**: `Date` Defined in: [src/types/Event/type.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L63) *** ### endTime? > `optional` **endTime**: `string` Defined in: [src/types/Event/type.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L64) *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Event/type.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L65) *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/Event/type.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L66) *** ### latitude? > `optional` **latitude**: `number` Defined in: [src/types/Event/type.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L67) *** ### location? > `optional` **location**: `string` Defined in: [src/types/Event/type.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L68) *** ### longitude? > `optional` **longitude**: `number` Defined in: [src/types/Event/type.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L69) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/Event/type.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L70) *** ### recurrence? > `optional` **recurrence**: `string` Defined in: [src/types/Event/type.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L71) *** ### recurring > **recurring**: `boolean` Defined in: [src/types/Event/type.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L72) *** ### startDate > **startDate**: `Date` Defined in: [src/types/Event/type.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L73) *** ### startTime? > `optional` **startTime**: `string` Defined in: [src/types/Event/type.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L74) *** ### title > **title**: `string` Defined in: [src/types/Event/type.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L75) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/EventOrderByInput.md ================================================ [Admin Docs](/) *** # Type Alias: EventOrderByInput > **EventOrderByInput** = *typeof* [`EventOrderByInputEnum`](../variables/EventOrderByInputEnum.md)\[keyof *typeof* [`EventOrderByInputEnum`](../variables/EventOrderByInputEnum.md)\] Defined in: [src/types/Event/type.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L138) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/EventVolunteer.md ================================================ [Admin Docs](/) *** # Type Alias: EventVolunteer > **EventVolunteer** = `object` Defined in: [src/types/Event/type.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L83) ## Properties ### createdAt > **createdAt**: `Date` Defined in: [src/types/Event/type.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L88) *** ### creator? > `optional` **creator**: [`User`](User.md) Defined in: [src/types/Event/type.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L92) *** ### event? > `optional` **event**: [`Event`](Event.md) Defined in: [src/types/Event/type.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L91) *** ### hasAccepted > **hasAccepted**: `boolean` Defined in: [src/types/Event/type.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L85) *** ### hoursVolunteered > **hoursVolunteered**: `number` Defined in: [src/types/Event/type.ts:86](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L86) *** ### id > **id**: `string` Defined in: [src/types/Event/type.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L84) *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Event/type.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L87) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/Event/type.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L89) *** ### updater? > `optional` **updater**: [`User`](User.md) Defined in: [src/types/Event/type.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L93) *** ### user > **user**: [`User`](User.md) Defined in: [src/types/Event/type.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L90) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/EventVolunteerInput.md ================================================ [Admin Docs](/) *** # Type Alias: EventVolunteerInput > **EventVolunteerInput** = `object` Defined in: [src/types/Event/type.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L96) ## Properties ### eventId > **eventId**: `string` Defined in: [src/types/Event/type.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L97) *** ### groupId? > `optional` **groupId**: `string` Defined in: [src/types/Event/type.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L99) *** ### userId > **userId**: `string` Defined in: [src/types/Event/type.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L98) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/EventVolunteerResponse.md ================================================ [Admin Docs](/) *** # Type Alias: EventVolunteerResponse > **EventVolunteerResponse** = *typeof* [`EventVolunteerResponseEnum`](../variables/EventVolunteerResponseEnum.md)\[keyof *typeof* [`EventVolunteerResponseEnum`](../variables/EventVolunteerResponseEnum.md)\] Defined in: [src/types/Event/type.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L113) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/EventWhereInput.md ================================================ [Admin Docs](/) *** # Type Alias: EventWhereInput > **EventWhereInput** = `object` Defined in: [src/types/Event/type.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L141) ## Properties ### description? > `optional` **description**: `string` Defined in: [src/types/Event/type.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L142) *** ### description\_contains? > `optional` **description\_contains**: `string` Defined in: [src/types/Event/type.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L143) *** ### description\_in? > `optional` **description\_in**: `string`[] Defined in: [src/types/Event/type.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L144) *** ### description\_not? > `optional` **description\_not**: `string` Defined in: [src/types/Event/type.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L145) *** ### description\_not\_in? > `optional` **description\_not\_in**: `string`[] Defined in: [src/types/Event/type.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L146) *** ### description\_starts\_with? > `optional` **description\_starts\_with**: `string` Defined in: [src/types/Event/type.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L147) *** ### id? > `optional` **id**: `string` Defined in: [src/types/Event/type.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L149) *** ### id\_contains? > `optional` **id\_contains**: `string` Defined in: [src/types/Event/type.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L150) *** ### id\_in? > `optional` **id\_in**: `string`[] Defined in: [src/types/Event/type.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L151) *** ### id\_not? > `optional` **id\_not**: `string` Defined in: [src/types/Event/type.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L152) *** ### id\_not\_in? > `optional` **id\_not\_in**: `string`[] Defined in: [src/types/Event/type.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L153) *** ### id\_starts\_with? > `optional` **id\_starts\_with**: `string` Defined in: [src/types/Event/type.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L154) *** ### location? > `optional` **location**: `string` Defined in: [src/types/Event/type.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L156) *** ### location\_contains? > `optional` **location\_contains**: `string` Defined in: [src/types/Event/type.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L157) *** ### location\_in? > `optional` **location\_in**: `string`[] Defined in: [src/types/Event/type.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L158) *** ### location\_not? > `optional` **location\_not**: `string` Defined in: [src/types/Event/type.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L159) *** ### location\_not\_in? > `optional` **location\_not\_in**: `string`[] Defined in: [src/types/Event/type.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L160) *** ### location\_starts\_with? > `optional` **location\_starts\_with**: `string` Defined in: [src/types/Event/type.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L161) *** ### organization\_id? > `optional` **organization\_id**: `string` Defined in: [src/types/Event/type.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L163) *** ### title? > `optional` **title**: `string` Defined in: [src/types/Event/type.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L165) *** ### title\_contains? > `optional` **title\_contains**: `string` Defined in: [src/types/Event/type.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L166) *** ### title\_in? > `optional` **title\_in**: `string`[] Defined in: [src/types/Event/type.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L167) *** ### title\_not? > `optional` **title\_not**: `string` Defined in: [src/types/Event/type.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L168) *** ### title\_not\_in? > `optional` **title\_not\_in**: `string`[] Defined in: [src/types/Event/type.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L169) *** ### title\_starts\_with? > `optional` **title\_starts\_with**: `string` Defined in: [src/types/Event/type.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L170) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/Feedback.md ================================================ [Admin Docs](/) *** # Type Alias: Feedback > **Feedback** = `object` Defined in: [src/types/Event/type.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L45) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/Event/type.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L46) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/Event/type.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L47) *** ### event? > `optional` **event**: [`Event`](Event.md) Defined in: [src/types/Event/type.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L48) *** ### rating > **rating**: `number` Defined in: [src/types/Event/type.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L49) *** ### review > **review**: `string` \| `null` Defined in: [src/types/Event/type.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L50) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/Event/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L51) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/FeedbackInput.md ================================================ [Admin Docs](/) *** # Type Alias: FeedbackInput > **FeedbackInput** = `object` Defined in: [src/types/Event/type.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L54) ## Properties ### eventId > **eventId**: `string` Defined in: [src/types/Event/type.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L55) *** ### rating > **rating**: `number` Defined in: [src/types/Event/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L56) *** ### review? > `optional` **review**: `string` Defined in: [src/types/Event/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L57) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/UpdateEventVolunteerInput.md ================================================ [Admin Docs](/) *** # Type Alias: UpdateEventVolunteerInput > **UpdateEventVolunteerInput** = `object` Defined in: [src/types/Event/type.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L102) ## Properties ### assignments? > `optional` **assignments**: `string`[] Defined in: [src/types/Event/type.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L103) *** ### hasAccepted? > `optional` **hasAccepted**: `boolean` Defined in: [src/types/Event/type.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L104) *** ### isPublic? > `optional` **isPublic**: `boolean` Defined in: [src/types/Event/type.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L105) ================================================ FILE: docs/docs/auto-docs/types/Event/type/type-aliases/User.md ================================================ [Admin Docs](/) *** # Type Alias: User > **User** = `object` Defined in: [src/types/Event/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L5) ## Properties ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/Event/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L9) *** ### createdAt? > `optional` **createdAt**: `Date` Defined in: [src/types/Event/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L11) *** ### emailAddress > **emailAddress**: `string` Defined in: [src/types/Event/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L8) *** ### id > **id**: `string` Defined in: [src/types/Event/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L6) *** ### name > **name**: `string` Defined in: [src/types/Event/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L7) *** ### natalSex? > `optional` **natalSex**: `string` Defined in: [src/types/Event/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L13) *** ### role? > `optional` **role**: `string` Defined in: [src/types/Event/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L10) *** ### updatedAt? > `optional` **updatedAt**: `Date` Defined in: [src/types/Event/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L12) ================================================ FILE: docs/docs/auto-docs/types/Event/type/variables/EventOrderByInputEnum.md ================================================ [Admin Docs](/) *** # Variable: EventOrderByInputEnum > `const` **EventOrderByInputEnum**: `object` Defined in: [src/types/Event/type.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L116) ## Type Declaration ### allDay\_ASC > `readonly` **allDay\_ASC**: `"allDay_ASC"` = `'allDay_ASC'` ### allDay\_DESC > `readonly` **allDay\_DESC**: `"allDay_DESC"` = `'allDay_DESC'` ### description\_ASC > `readonly` **description\_ASC**: `"description_ASC"` = `'description_ASC'` ### description\_DESC > `readonly` **description\_DESC**: `"description_DESC"` = `'description_DESC'` ### endDate\_ASC > `readonly` **endDate\_ASC**: `"endDate_ASC"` = `'endDate_ASC'` ### endDate\_DESC > `readonly` **endDate\_DESC**: `"endDate_DESC"` = `'endDate_DESC'` ### endTime\_ASC > `readonly` **endTime\_ASC**: `"endTime_ASC"` = `'endTime_ASC'` ### endTime\_DESC > `readonly` **endTime\_DESC**: `"endTime_DESC"` = `'endTime_DESC'` ### id\_ASC > `readonly` **id\_ASC**: `"id_ASC"` = `'id_ASC'` ### id\_DESC > `readonly` **id\_DESC**: `"id_DESC"` = `'id_DESC'` ### location\_ASC > `readonly` **location\_ASC**: `"location_ASC"` = `'location_ASC'` ### location\_DESC > `readonly` **location\_DESC**: `"location_DESC"` = `'location_DESC'` ### recurrence\_ASC > `readonly` **recurrence\_ASC**: `"recurrence_ASC"` = `'recurrence_ASC'` ### recurrence\_DESC > `readonly` **recurrence\_DESC**: `"recurrence_DESC"` = `'recurrence_DESC'` ### startDate\_ASC > `readonly` **startDate\_ASC**: `"startDate_ASC"` = `'startDate_ASC'` ### startDate\_DESC > `readonly` **startDate\_DESC**: `"startDate_DESC"` = `'startDate_DESC'` ### startTime\_ASC > `readonly` **startTime\_ASC**: `"startTime_ASC"` = `'startTime_ASC'` ### startTime\_DESC > `readonly` **startTime\_DESC**: `"startTime_DESC"` = `'startTime_DESC'` ### title\_ASC > `readonly` **title\_ASC**: `"title_ASC"` = `'title_ASC'` ### title\_DESC > `readonly` **title\_DESC**: `"title_DESC"` = `'title_DESC'` ================================================ FILE: docs/docs/auto-docs/types/Event/type/variables/EventVolunteerResponseEnum.md ================================================ [Admin Docs](/) *** # Variable: EventVolunteerResponseEnum > `const` **EventVolunteerResponseEnum**: `object` Defined in: [src/types/Event/type.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L108) ## Type Declaration ### NO > `readonly` **NO**: `"NO"` = `'NO'` ### YES > `readonly` **YES**: `"YES"` = `'YES'` ================================================ FILE: docs/docs/auto-docs/types/Event/utils/interfaces/InterfaceHoliday.md ================================================ [Admin Docs](/) *** # Interface: InterfaceHoliday Defined in: [src/types/Event/utils.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L1) ## Properties ### date > **date**: `string` Defined in: [src/types/Event/utils.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L3) *** ### month > **month**: `string` Defined in: [src/types/Event/utils.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L4) *** ### name > **name**: `string` Defined in: [src/types/Event/utils.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L2) ================================================ FILE: docs/docs/auto-docs/types/Event/utils/variables/holidays.md ================================================ [Admin Docs](/) *** # Variable: holidays > `const` **holidays**: [`InterfaceHoliday`](../interfaces/InterfaceHoliday.md)[] Defined in: [src/types/Event/utils.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L7) ================================================ FILE: docs/docs/auto-docs/types/Event/utils/variables/weekdays.md ================================================ [Admin Docs](/) *** # Variable: weekdays > `const` **weekdays**: `string`[] Defined in: [src/types/Event/utils.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L19) ================================================ FILE: docs/docs/auto-docs/types/EventForm/interface/interfaces/IEventFormProps.md ================================================ [Admin Docs](/) *** # Interface: IEventFormProps Defined in: [src/types/EventForm/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L68) Props interface for the EventForm component. Provides a reusable form for creating and editing events across Admin and User portals. - `initialValues`: Initial form values - `onSubmit`: Callback fired when form is submitted with valid data - `onCancel`: Callback fired when form is cancelled - `submitLabel`: Label text for the submit button - `t`: Translation function for event-specific keys - `tCommon`: Translation function for common keys - `showCreateChat`: Whether to show the "Create Chat" toggle - `showRegisterable`: Whether to show the "Is Registerable" toggle - `showPublicToggle`: Whether to show the "Is Public" toggle - `disableRecurrence`: Whether to disable recurrence options - `submitting`: Whether the form is currently submitting - `showRecurrenceToggle`: Whether to show the recurrence toggle - `showCancelButton`: Whether to show the cancel button ## Properties ### disableRecurrence? > `optional` **disableRecurrence**: `boolean` Defined in: [src/types/EventForm/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L79) *** ### initialValues > **initialValues**: [`IEventFormValues`](IEventFormValues.md) Defined in: [src/types/EventForm/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L69) *** ### onCancel() > **onCancel**: () => `void` Defined in: [src/types/EventForm/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L71) #### Returns `void` *** ### onSubmit() > **onSubmit**: (`payload`) => `void` \| `Promise`\<`void`\> Defined in: [src/types/EventForm/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L70) #### Parameters ##### payload [`IEventFormSubmitPayload`](IEventFormSubmitPayload.md) #### Returns `void` \| `Promise`\<`void`\> *** ### showCancelButton? > `optional` **showCancelButton**: `boolean` Defined in: [src/types/EventForm/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L82) *** ### showCreateChat? > `optional` **showCreateChat**: `boolean` Defined in: [src/types/EventForm/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L75) *** ### showPublicToggle? > `optional` **showPublicToggle**: `boolean` Defined in: [src/types/EventForm/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L77) *** ### showRecurrenceToggle? > `optional` **showRecurrenceToggle**: `boolean` Defined in: [src/types/EventForm/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L81) *** ### showRegisterable? > `optional` **showRegisterable**: `boolean` Defined in: [src/types/EventForm/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L76) *** ### submitLabel > **submitLabel**: `string` Defined in: [src/types/EventForm/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L72) *** ### submitting? > `optional` **submitting**: `boolean` Defined in: [src/types/EventForm/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L80) *** ### t() > **t**: (`key`, `options?`) => `string` Defined in: [src/types/EventForm/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L73) #### Parameters ##### key `string` ##### options? `Record`\<`string`, `unknown`\> #### Returns `string` *** ### tCommon() > **tCommon**: (`key`, `options?`) => `string` Defined in: [src/types/EventForm/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L74) #### Parameters ##### key `string` ##### options? `Record`\<`string`, `unknown`\> #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/EventForm/interface/interfaces/IEventFormSubmitPayload.md ================================================ [Admin Docs](/) *** # Interface: IEventFormSubmitPayload Defined in: [src/types/EventForm/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L43) Payload interface for event form submission. Extends base fields with ISO timestamp strings for API transmission. ## Extends - `IEventFormBase` ## Properties ### allDay > **allDay**: `boolean` Defined in: [src/types/EventForm/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L11) #### Inherited from `IEventFormBase.allDay` *** ### createChat? > `optional` **createChat**: `boolean` Defined in: [src/types/EventForm/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L25) #### Inherited from `IEventFormBase.createChat` *** ### description > **description**: `string` Defined in: [src/types/EventForm/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L9) #### Inherited from `IEventFormBase.description` *** ### endAtISO > **endAtISO**: `string` Defined in: [src/types/EventForm/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L45) *** ### endDate > **endDate**: `Date` Defined in: [src/types/EventForm/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L47) *** ### isInviteOnly > **isInviteOnly**: `boolean` Defined in: [src/types/EventForm/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L21) Determines if the event is accessible only by invitation. Mutually exclusive with isPublic. #### Inherited from `IEventFormBase.isInviteOnly` *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/EventForm/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L16) Determines if the event is visible to the entire community. Often referred to as "Community Visible" in the UI. #### Inherited from `IEventFormBase.isPublic` *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/EventForm/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L22) #### Inherited from `IEventFormBase.isRegisterable` *** ### location > **location**: `string` Defined in: [src/types/EventForm/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L10) #### Inherited from `IEventFormBase.location` *** ### name > **name**: `string` Defined in: [src/types/EventForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L8) #### Inherited from `IEventFormBase.name` *** ### recurrenceRule > **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/types/EventForm/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L24) #### Inherited from `IEventFormBase.recurrenceRule` *** ### startAtISO > **startAtISO**: `string` Defined in: [src/types/EventForm/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L44) *** ### startDate > **startDate**: `Date` Defined in: [src/types/EventForm/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L46) ================================================ FILE: docs/docs/auto-docs/types/EventForm/interface/interfaces/IEventFormValues.md ================================================ [Admin Docs](/) *** # Interface: IEventFormValues Defined in: [src/types/EventForm/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L32) Form values interface for event creation/editing. Extends base fields with Date objects and time strings for form inputs. ## Extends - `IEventFormBase` ## Properties ### allDay > **allDay**: `boolean` Defined in: [src/types/EventForm/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L11) #### Inherited from `IEventFormBase.allDay` *** ### createChat? > `optional` **createChat**: `boolean` Defined in: [src/types/EventForm/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L25) #### Inherited from `IEventFormBase.createChat` *** ### description > **description**: `string` Defined in: [src/types/EventForm/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L9) #### Inherited from `IEventFormBase.description` *** ### endDate > **endDate**: `Date` Defined in: [src/types/EventForm/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L34) *** ### endTime > **endTime**: `string` Defined in: [src/types/EventForm/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L36) *** ### isInviteOnly > **isInviteOnly**: `boolean` Defined in: [src/types/EventForm/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L21) Determines if the event is accessible only by invitation. Mutually exclusive with isPublic. #### Inherited from `IEventFormBase.isInviteOnly` *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/EventForm/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L16) Determines if the event is visible to the entire community. Often referred to as "Community Visible" in the UI. #### Inherited from `IEventFormBase.isPublic` *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/EventForm/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L22) #### Inherited from `IEventFormBase.isRegisterable` *** ### location > **location**: `string` Defined in: [src/types/EventForm/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L10) #### Inherited from `IEventFormBase.location` *** ### name > **name**: `string` Defined in: [src/types/EventForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L8) #### Inherited from `IEventFormBase.name` *** ### recurrenceRule > **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/types/EventForm/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L24) #### Inherited from `IEventFormBase.recurrenceRule` *** ### startDate > **startDate**: `Date` Defined in: [src/types/EventForm/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L33) *** ### startTime > **startTime**: `string` Defined in: [src/types/EventForm/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L35) ================================================ FILE: docs/docs/auto-docs/types/FormFieldGroup/interface/interfaces/IFormTextFieldProps.md ================================================ [Admin Docs](/) *** # Interface: IFormTextFieldProps Defined in: [src/types/FormFieldGroup/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L22) Props for FormFieldGroup component. ## Extends - [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md) ## Indexable \[`x`: `string`\]: `unknown` Additional HTML input attributes passed through to the underlying control ## Properties ### className? > `optional` **className**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L17) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`className`](InterfaceFormFieldGroupProps.md#classname) *** ### data-testid? > `optional` **data-testid**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`data-testid`](InterfaceFormFieldGroupProps.md#data-testid) *** ### disabled? > `optional` **disabled**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L29) #### Overrides [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`disabled`](InterfaceFormFieldGroupProps.md#disabled) *** ### endAdornment? > `optional` **endAdornment**: `ReactNode` Defined in: [src/types/FormFieldGroup/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L28) *** ### error? > `optional` **error**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`error`](InterfaceFormFieldGroupProps.md#error) *** ### helpText? > `optional` **helpText**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`helpText`](InterfaceFormFieldGroupProps.md#helptext) *** ### hideLabel? > `optional` **hideLabel**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`hideLabel`](InterfaceFormFieldGroupProps.md#hidelabel) *** ### inline? > `optional` **inline**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L15) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`inline`](InterfaceFormFieldGroupProps.md#inline) *** ### inputId? > `optional` **inputId**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`inputId`](InterfaceFormFieldGroupProps.md#inputid) *** ### label > **label**: `ReactNode` Defined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`label`](InterfaceFormFieldGroupProps.md#label) *** ### labelClassName? > `optional` **labelClassName**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`labelClassName`](InterfaceFormFieldGroupProps.md#labelclassname) *** ### name > **name**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`name`](InterfaceFormFieldGroupProps.md#name) *** ### onChange()? > `optional` **onChange**: (`v`) => `void` Defined in: [src/types/FormFieldGroup/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L26) #### Parameters ##### v `string` #### Returns `void` *** ### placeholder? > `optional` **placeholder**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L24) *** ### required? > `optional` **required**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`required`](InterfaceFormFieldGroupProps.md#required) *** ### startAdornment? > `optional` **startAdornment**: `ReactNode` Defined in: [src/types/FormFieldGroup/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L27) *** ### touched? > `optional` **touched**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12) #### Inherited from [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`touched`](InterfaceFormFieldGroupProps.md#touched) *** ### type? > `optional` **type**: `"number"` \| `"text"` \| `"email"` \| `"password"` \| `"url"` \| `"tel"` Defined in: [src/types/FormFieldGroup/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L23) *** ### value > **value**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L25) ================================================ FILE: docs/docs/auto-docs/types/FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormFieldGroupProps Defined in: [src/types/FormFieldGroup/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L6) Props for FormFieldGroup component. ## Extended by - [`IFormTextFieldProps`](IFormTextFieldProps.md) - [`InterfaceFormSelectFieldProps`](../../../shared-components/FormFieldGroup/interface/interfaces/InterfaceFormSelectFieldProps.md) - [`InterfaceFormCheckFieldProps`](../../../shared-components/FormFieldGroup/interface/interfaces/InterfaceFormCheckFieldProps.md) ## Properties ### className? > `optional` **className**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L17) *** ### data-testid? > `optional` **data-testid**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13) *** ### disabled? > `optional` **disabled**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L18) *** ### error? > `optional` **error**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11) *** ### helpText? > `optional` **helpText**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10) *** ### hideLabel? > `optional` **hideLabel**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16) *** ### inline? > `optional` **inline**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L15) *** ### inputId? > `optional` **inputId**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19) *** ### label > **label**: `ReactNode` Defined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8) *** ### labelClassName? > `optional` **labelClassName**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14) *** ### name > **name**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7) *** ### required? > `optional` **required**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9) *** ### touched? > `optional` **touched**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12) ================================================ FILE: docs/docs/auto-docs/types/OrganizationCard/interface/interfaces/InterfaceOrganizationCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationCardProps Defined in: [src/types/OrganizationCard/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L1) ## Properties ### addressLine1 > **addressLine1**: `string` Defined in: [src/types/OrganizationCard/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L14) *** ### admins? > `optional` **admins**: `object`[] Defined in: [src/types/OrganizationCard/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L13) #### id > **id**: `string` *** ### adminsCount? > `optional` **adminsCount**: `number` Defined in: [src/types/OrganizationCard/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L16) *** ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/OrganizationCard/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L26) *** ### createdAt? > `optional` **createdAt**: `string` Defined in: [src/types/OrganizationCard/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L27) *** ### description > **description**: `string` Defined in: [src/types/OrganizationCard/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L5) *** ### id > **id**: `string` Defined in: [src/types/OrganizationCard/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L2) *** ### image? > `optional` **image**: `string` Defined in: [src/types/OrganizationCard/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L4) *** ### isJoined? > `optional` **isJoined**: `boolean` Defined in: [src/types/OrganizationCard/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L25) *** ### members? > `optional` **members**: `object` Defined in: [src/types/OrganizationCard/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L6) #### edges > **edges**: `object`[] *** ### membersCount? > `optional` **membersCount**: `number` Defined in: [src/types/OrganizationCard/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L15) *** ### membershipRequests? > `optional` **membershipRequests**: `object`[] Defined in: [src/types/OrganizationCard/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L19) #### id > **id**: `string` #### user > **user**: `object` ##### user.id > **id**: `string` *** ### membershipRequestStatus? > `optional` **membershipRequestStatus**: `string` Defined in: [src/types/OrganizationCard/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L17) *** ### name > **name**: `string` Defined in: [src/types/OrganizationCard/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L3) *** ### role > **role**: `string` Defined in: [src/types/OrganizationCard/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L28) *** ### userRegistrationRequired? > `optional` **userRegistrationRequired**: `boolean` Defined in: [src/types/OrganizationCard/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L18) ================================================ FILE: docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePageHeaderProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePageHeaderProps Defined in: [src/types/PeopleTab/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L4) ## Properties ### actions? > `optional` **actions**: `ReactNode` Defined in: [src/types/PeopleTab/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L21) *** ### search? > `optional` **search**: `object` Defined in: [src/types/PeopleTab/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L6) #### buttonTestId? > `optional` **buttonTestId**: `string` #### inputTestId? > `optional` **inputTestId**: `string` #### onSearch() > **onSearch**: (`value`) => `void` ##### Parameters ###### value `string` ##### Returns `void` #### placeholder > **placeholder**: `string` *** ### sorting? > `optional` **sorting**: `object`[] Defined in: [src/types/PeopleTab/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L12) #### icon? > `optional` **icon**: `ReactNode` #### onChange() > **onChange**: (`value`) => `void` ##### Parameters ###### value `string` | `number` ##### Returns `void` #### options > **options**: `object`[] #### selected > **selected**: `string` \| `number` #### testIdPrefix > **testIdPrefix**: `string` #### title > **title**: `string` *** ### title? > `optional` **title**: `string` Defined in: [src/types/PeopleTab/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L5) ================================================ FILE: docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTab.md ================================================ [Admin Docs](/) *** # Interface: InterfacePeopleTab Defined in: [src/types/PeopleTab/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L45) ## Properties ### action() > **action**: () => `void` Defined in: [src/types/PeopleTab/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L49) #### Returns `void` *** ### icon? > `optional` **icon**: `ReactElement`\<`SVGProps`\<`SVGSVGElement`\>\> Defined in: [src/types/PeopleTab/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L47) *** ### isActive? > `optional` **isActive**: `boolean` Defined in: [src/types/PeopleTab/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L48) *** ### testId? > `optional` **testId**: `string` Defined in: [src/types/PeopleTab/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L50) *** ### title > **title**: `string` Defined in: [src/types/PeopleTab/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L46) ================================================ FILE: docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTabNavbar.md ================================================ [Admin Docs](/) *** # Interface: InterfacePeopleTabNavbar Defined in: [src/types/PeopleTab/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L53) ## Properties ### action() > **action**: () => `void` Defined in: [src/types/PeopleTab/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L57) #### Returns `void` *** ### icon? > `optional` **icon**: `string` Defined in: [src/types/PeopleTab/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L55) *** ### isActive? > `optional` **isActive**: `boolean` Defined in: [src/types/PeopleTab/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L56) *** ### testId? > `optional` **testId**: `string` Defined in: [src/types/PeopleTab/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L58) *** ### title > **title**: `string` Defined in: [src/types/PeopleTab/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L54) ================================================ FILE: docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTabNavbarProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePeopleTabNavbarProps Defined in: [src/types/PeopleTab/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L24) ## Properties ### actions? > `optional` **actions**: `ReactNode` Defined in: [src/types/PeopleTab/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L41) *** ### search? > `optional` **search**: `object` Defined in: [src/types/PeopleTab/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L26) #### buttonTestId? > `optional` **buttonTestId**: `string` #### inputTestId? > `optional` **inputTestId**: `string` #### onSearch() > **onSearch**: (`value`) => `void` ##### Parameters ###### value `string` ##### Returns `void` #### placeholder > **placeholder**: `string` *** ### sorting? > `optional` **sorting**: `object`[] Defined in: [src/types/PeopleTab/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L32) #### icon? > `optional` **icon**: `string` #### onChange() > **onChange**: (`value`) => `void` ##### Parameters ###### value `string` | `number` ##### Returns `void` #### options > **options**: `object`[] #### selected > **selected**: `string` \| `number` #### testIdPrefix > **testIdPrefix**: `string` #### title > **title**: `string` *** ### title? > `optional` **title**: `string` Defined in: [src/types/PeopleTab/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L25) ================================================ FILE: docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTabUserOrganizationProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePeopleTabUserOrganizationProps Defined in: [src/types/PeopleTab/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L74) ## Properties ### actionIcon? > `optional` **actionIcon**: `ReactNode` Defined in: [src/types/PeopleTab/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L80) *** ### actionName? > `optional` **actionName**: `string` Defined in: [src/types/PeopleTab/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L81) *** ### adminCount? > `optional` **adminCount**: `number` Defined in: [src/types/PeopleTab/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L78) *** ### description? > `optional` **description**: `string` Defined in: [src/types/PeopleTab/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L77) *** ### img? > `optional` **img**: `string` Defined in: [src/types/PeopleTab/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L75) *** ### membersCount? > `optional` **membersCount**: `number` Defined in: [src/types/PeopleTab/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L79) *** ### title > **title**: `string` Defined in: [src/types/PeopleTab/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L76) ================================================ FILE: docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopletabUserEventsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePeopletabUserEventsProps Defined in: [src/types/PeopleTab/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L62) ## Properties ### actionIcon? > `optional` **actionIcon**: `ReactNode` Defined in: [src/types/PeopleTab/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L69) *** ### actionName? > `optional` **actionName**: `string` Defined in: [src/types/PeopleTab/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L70) *** ### endDate? > `optional` **endDate**: `string` Defined in: [src/types/PeopleTab/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L66) *** ### endTime? > `optional` **endTime**: `string` Defined in: [src/types/PeopleTab/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L64) *** ### eventDescription? > `optional` **eventDescription**: `string` Defined in: [src/types/PeopleTab/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L68) *** ### eventName? > `optional` **eventName**: `string` Defined in: [src/types/PeopleTab/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L67) *** ### startDate? > `optional` **startDate**: `string` Defined in: [src/types/PeopleTab/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L65) *** ### startTime? > `optional` **startTime**: `string` Defined in: [src/types/PeopleTab/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L63) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/ICreatePostModalProps.md ================================================ [Admin Docs](/) *** # Interface: ICreatePostModalProps Defined in: [src/types/Post/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L118) ## Properties ### body? > `optional` **body**: `string` Defined in: [src/types/Post/interface.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L122) *** ### id? > `optional` **id**: `string` Defined in: [src/types/Post/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L120) *** ### onHide() > **onHide**: () => `void` Defined in: [src/types/Post/interface.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L123) #### Returns `void` *** ### orgId > **orgId**: `string` Defined in: [src/types/Post/interface.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L125) *** ### refetch() > **refetch**: () => `Promise`\<`unknown`\> Defined in: [src/types/Post/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L124) #### Returns `Promise`\<`unknown`\> *** ### show > **show**: `boolean` Defined in: [src/types/Post/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L119) *** ### title? > `optional` **title**: `string` Defined in: [src/types/Post/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L121) *** ### type > **type**: `"create"` \| `"edit"` Defined in: [src/types/Post/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L126) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceAttachment.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAttachment Defined in: [src/types/Post/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L76) ## Properties ### url > **url**: `string` Defined in: [src/types/Post/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L77) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceCreator.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreator Defined in: [src/types/Post/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L80) ## Properties ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/Post/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L84) *** ### email > **email**: `string` Defined in: [src/types/Post/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L83) *** ### id > **id**: `string` Defined in: [src/types/Post/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L81) *** ### name > **name**: `string` Defined in: [src/types/Post/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L82) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceMutationCreatePostInput.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMutationCreatePostInput Defined in: [src/types/Post/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L69) ## Properties ### attachments? > `optional` **attachments**: `File`[] Defined in: [src/types/Post/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L73) *** ### caption > **caption**: `string` Defined in: [src/types/Post/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L70) *** ### isPinned > **isPinned**: `boolean` Defined in: [src/types/Post/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L72) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/Post/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L71) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceOrganization.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganization Defined in: [src/types/Post/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L50) ## Properties ### id > **id**: `string` Defined in: [src/types/Post/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L51) *** ### pinnedPosts > **pinnedPosts**: `object` Defined in: [src/types/Post/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L57) #### edges > **edges**: [`InterfacePostEdge`](InterfacePostEdge.md)[] #### pageInfo > **pageInfo**: [`InterfacePageInfo`](InterfacePageInfo.md) #### totalCount > **totalCount**: `number` *** ### posts > **posts**: `object` Defined in: [src/types/Post/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L52) #### edges > **edges**: [`InterfacePostEdge`](InterfacePostEdge.md)[] #### pageInfo > **pageInfo**: [`InterfacePageInfo`](InterfacePageInfo.md) #### totalCount > **totalCount**: `number` ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceOrganizationPostListData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationPostListData Defined in: [src/types/Post/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L64) ## Properties ### organization > **organization**: [`InterfaceOrganization`](InterfaceOrganization.md) Defined in: [src/types/Post/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L65) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePageInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfacePageInfo Defined in: [src/types/Post/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L38) ## Properties ### endCursor > **endCursor**: `string` Defined in: [src/types/Post/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L40) *** ### hasNextPage > **hasNextPage**: `boolean` Defined in: [src/types/Post/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L41) *** ### hasPreviousPage > **hasPreviousPage**: `boolean` Defined in: [src/types/Post/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L42) *** ### startCursor > **startCursor**: `string` Defined in: [src/types/Post/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L39) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePinnedPostCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePinnedPostCardProps Defined in: [src/types/Post/interface.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L112) ## Properties ### onPostUpdate()? > `optional` **onPostUpdate**: () => `void` Defined in: [src/types/Post/interface.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L115) #### Returns `void` *** ### onStoryClick() > **onStoryClick**: (`post`) => `void` Defined in: [src/types/Post/interface.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L114) #### Parameters ##### post [`InterfacePost`](InterfacePost.md) #### Returns `void` *** ### pinnedPost > **pinnedPost**: [`InterfacePostEdge`](InterfacePostEdge.md) Defined in: [src/types/Post/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L113) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePinnedPostsLayoutProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePinnedPostsLayoutProps Defined in: [src/types/Post/interface.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L106) ## Properties ### onPostUpdate()? > `optional` **onPostUpdate**: () => `void` Defined in: [src/types/Post/interface.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L109) #### Returns `void` *** ### onStoryClick() > **onStoryClick**: (`post`) => `void` Defined in: [src/types/Post/interface.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L108) #### Parameters ##### post [`InterfacePost`](InterfacePost.md) #### Returns `void` *** ### pinnedPosts > **pinnedPosts**: [`InterfacePostEdge`](InterfacePostEdge.md)[] Defined in: [src/types/Post/interface.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L107) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePost.md ================================================ [Admin Docs](/) *** # Interface: InterfacePost Defined in: [src/types/Post/interface.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L87) ## Properties ### attachments? > `optional` **attachments**: \[\{ `mimeType`: `string`; \}\] Defined in: [src/types/Post/interface.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L96) *** ### attachmentURL? > `optional` **attachmentURL**: `string` Defined in: [src/types/Post/interface.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L95) *** ### body? > `optional` **body**: `string` Defined in: [src/types/Post/interface.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L94) *** ### caption? > `optional` **caption**: `string` Defined in: [src/types/Post/interface.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L89) *** ### commentsCount? > `optional` **commentsCount**: `number` Defined in: [src/types/Post/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L103) *** ### createdAt > **createdAt**: `string` Defined in: [src/types/Post/interface.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L90) *** ### creator? > `optional` **creator**: [`InterfaceCreator`](InterfaceCreator.md) Defined in: [src/types/Post/interface.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L93) *** ### downVotesCount? > `optional` **downVotesCount**: `number` Defined in: [src/types/Post/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L102) *** ### hasUserVoted? > `optional` **hasUserVoted**: `object` Defined in: [src/types/Post/interface.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L97) #### hasVoted > **hasVoted**: `boolean` #### voteType > **voteType**: `"up_vote"` \| `"down_vote"` *** ### id > **id**: `string` Defined in: [src/types/Post/interface.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L88) *** ### pinned? > `optional` **pinned**: `boolean` Defined in: [src/types/Post/interface.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L92) *** ### pinnedAt? > `optional` **pinnedAt**: `string` Defined in: [src/types/Post/interface.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L91) *** ### upVotesCount? > `optional` **upVotesCount**: `number` Defined in: [src/types/Post/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L101) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostCard.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostCard Defined in: [src/types/Post/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L3) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/Post/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L4) *** ### commentCount > **commentCount**: `number` Defined in: [src/types/Post/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L12) *** ### comments > **comments**: [`Comment`](../../../Comment/type/type-aliases/Comment.md)[] Defined in: [src/types/Post/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L13) *** ### creator > **creator**: `Partial`\<[`User`](../../../shared-components/User/type/type-aliases/User.md)\> Defined in: [src/types/Post/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L5) *** ### fetchPosts() > **fetchPosts**: () => `void` Defined in: [src/types/Post/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L14) #### Returns `void` *** ### image > **image**: `string` Defined in: [src/types/Post/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L7) *** ### likeCount > **likeCount**: `number` Defined in: [src/types/Post/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L11) *** ### postedAt > **postedAt**: `string` Defined in: [src/types/Post/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L6) *** ### text > **text**: `string` Defined in: [src/types/Post/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L9) *** ### title > **title**: `string` Defined in: [src/types/Post/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L10) *** ### video > **video**: `string` Defined in: [src/types/Post/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L8) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostConnection.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostConnection Defined in: [src/types/Post/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L45) ## Properties ### edges > **edges**: [`InterfacePostEdge`](InterfacePostEdge.md)[] Defined in: [src/types/Post/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L46) *** ### pageInfo > **pageInfo**: [`InterfacePageInfo`](InterfacePageInfo.md) Defined in: [src/types/Post/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L47) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostCreator.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostCreator Defined in: [src/types/Post/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L17) ## Properties ### firstName? > `optional` **firstName**: `string` Defined in: [src/types/Post/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L19) *** ### id > **id**: `string` Defined in: [src/types/Post/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L18) *** ### lastName? > `optional` **lastName**: `string` Defined in: [src/types/Post/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L20) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostEdge.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostEdge Defined in: [src/types/Post/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L34) ## Properties ### cursor > **cursor**: `string` Defined in: [src/types/Post/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L36) *** ### node > **node**: [`InterfacePost`](InterfacePost.md) Defined in: [src/types/Post/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L35) ================================================ FILE: docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostNode.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostNode Defined in: [src/types/Post/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L23) ## Properties ### caption > **caption**: `string` Defined in: [src/types/Post/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L25) *** ### createdAt > **createdAt**: `string` Defined in: [src/types/Post/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L31) *** ### creator? > `optional` **creator**: [`InterfacePostCreator`](InterfacePostCreator.md) Defined in: [src/types/Post/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L29) *** ### id > **id**: `string` Defined in: [src/types/Post/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L24) *** ### imageUrl? > `optional` **imageUrl**: `string` Defined in: [src/types/Post/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L27) *** ### pinned? > `optional` **pinned**: `boolean` Defined in: [src/types/Post/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L30) *** ### text? > `optional` **text**: `string` Defined in: [src/types/Post/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L26) *** ### videoUrl? > `optional` **videoUrl**: `string` Defined in: [src/types/Post/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L28) ================================================ FILE: docs/docs/auto-docs/types/Post/type/interfaces/ICreatePostData.md ================================================ [Admin Docs](/) *** # Interface: ICreatePostData Defined in: [src/types/Post/type.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L156) ## Properties ### createPost > **createPost**: `object` Defined in: [src/types/Post/type.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L157) #### attachments? > `optional` **attachments**: `object`[] #### caption > **caption**: `string` #### id > **id**: `string` #### pinnedAt? > `optional` **pinnedAt**: `string` ================================================ FILE: docs/docs/auto-docs/types/Post/type/interfaces/ICreatePostInput.md ================================================ [Admin Docs](/) *** # Interface: ICreatePostInput Defined in: [src/types/Post/type.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L170) ## Properties ### attachments? > `optional` **attachments**: `File`[] Defined in: [src/types/Post/type.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L175) *** ### body? > `optional` **body**: `string` Defined in: [src/types/Post/type.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L172) *** ### caption > **caption**: `string` Defined in: [src/types/Post/type.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L171) *** ### isPinned > **isPinned**: `boolean` Defined in: [src/types/Post/type.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L174) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/Post/type.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L173) ================================================ FILE: docs/docs/auto-docs/types/Post/type/interfaces/IFileMetadataInput.md ================================================ [Admin Docs](/) *** # Interface: IFileMetadataInput Defined in: [src/types/Post/type.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L178) ## Properties ### fileHash > **fileHash**: `string` Defined in: [src/types/Post/type.ts:179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L179) *** ### mimetype > **mimetype**: `string` Defined in: [src/types/Post/type.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L180) *** ### name > **name**: `string` Defined in: [src/types/Post/type.ts:181](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L181) *** ### objectName > **objectName**: `string` Defined in: [src/types/Post/type.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L182) ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/Post.md ================================================ [Admin Docs](/) *** # Type Alias: Post > **Post** = `object` Defined in: [src/types/Post/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L6) ## Properties ### \_id? > `optional` **\_id**: `string` Defined in: [src/types/Post/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L7) *** ### commentCount? > `optional` **commentCount**: `number` Defined in: [src/types/Post/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L8) *** ### comments? > `optional` **comments**: [`Comment`](../../../Comment/type/type-aliases/Comment.md)[] Defined in: [src/types/Post/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L9) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/Post/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L10) *** ### creator? > `optional` **creator**: [`User`](../../../shared-components/User/type/type-aliases/User.md) Defined in: [src/types/Post/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L11) *** ### imageUrl? > `optional` **imageUrl**: `string` Defined in: [src/types/Post/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L12) *** ### likeCount? > `optional` **likeCount**: `number` Defined in: [src/types/Post/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L13) *** ### organization > **organization**: [`Organization`](../../../AdminPortal/Organization/type/type-aliases/Organization.md) Defined in: [src/types/Post/type.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L14) *** ### pinned? > `optional` **pinned**: `boolean` Defined in: [src/types/Post/type.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L15) *** ### text > **text**: `string` Defined in: [src/types/Post/type.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L16) *** ### title? > `optional` **title**: `string` Defined in: [src/types/Post/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L17) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/Post/type.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L18) *** ### videoUrl? > `optional` **videoUrl**: `string` Defined in: [src/types/Post/type.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L19) ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/PostComments.md ================================================ [Admin Docs](/) *** # Type Alias: PostComments > **PostComments** = `object`[] Defined in: [src/types/Post/type.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L83) ## Type Declaration ### creator > **creator**: `object` #### creator.email > **email**: `string` #### creator.firstName > **firstName**: `string` #### creator.id > **id**: `string` #### creator.lastName > **lastName**: `string` ### id > **id**: `string` ### likeCount > **likeCount**: `number` ### text > **text**: `string` ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/PostInput.md ================================================ [Admin Docs](/) *** # Type Alias: PostInput > **PostInput** = `object` Defined in: [src/types/Post/type.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L22) ## Properties ### \_id? > `optional` **\_id**: `string` Defined in: [src/types/Post/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L23) *** ### imageUrl? > `optional` **imageUrl**: `string` Defined in: [src/types/Post/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L24) *** ### organizationId > **organizationId**: `string` Defined in: [src/types/Post/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L25) *** ### pinned? > `optional` **pinned**: `boolean` Defined in: [src/types/Post/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L26) *** ### text > **text**: `string` Defined in: [src/types/Post/type.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L27) *** ### title? > `optional` **title**: `string` Defined in: [src/types/Post/type.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L28) *** ### videoUrl? > `optional` **videoUrl**: `string` Defined in: [src/types/Post/type.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L29) ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/PostLikes.md ================================================ [Admin Docs](/) *** # Type Alias: PostLikes > **PostLikes** = `object`[] Defined in: [src/types/Post/type.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L96) ## Type Declaration ### id > **id**: `string` ### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/PostNode.md ================================================ [Admin Docs](/) *** # Type Alias: PostNode > **PostNode** = `object` Defined in: [src/types/Post/type.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L101) ## Properties ### attachments > **attachments**: `object`[] Defined in: [src/types/Post/type.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L127) #### fileHash > **fileHash**: `string` #### mimeType > **mimeType**: `string` #### name > **name**: `string` #### objectName > **objectName**: `string` *** ### caption > **caption**: `string` \| `null` Defined in: [src/types/Post/type.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L103) *** ### commentCount > **commentCount**: `number` Defined in: [src/types/Post/type.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L105) *** ### comments? > `optional` **comments**: `object` Defined in: [src/types/Post/type.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L136) #### edges > **edges**: `object`[] *** ### commentsCount > **commentsCount**: `number` Defined in: [src/types/Post/type.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L134) *** ### createdAt > **createdAt**: `string` Defined in: [src/types/Post/type.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L104) *** ### creator > **creator**: `object` Defined in: [src/types/Post/type.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L106) #### avatarURL? > `optional` **avatarURL**: `string` \| `null` #### emailAddress > **emailAddress**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### downVoters > **downVoters**: `object` Defined in: [src/types/Post/type.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L116) #### edges > **edges**: `object`[] *** ### downVotesCount > **downVotesCount**: `number` Defined in: [src/types/Post/type.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L114) *** ### hasUserVoted > **hasUserVoted**: [`VoteState`](../../../../utils/interfaces/type-aliases/VoteState.md) Defined in: [src/types/Post/type.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L112) *** ### id > **id**: `string` Defined in: [src/types/Post/type.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L102) *** ### pinnedAt > **pinnedAt**: `string` \| `null` Defined in: [src/types/Post/type.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L115) *** ### upVotesCount > **upVotesCount**: `number` Defined in: [src/types/Post/type.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L113) ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/PostOrderByInput.md ================================================ [Admin Docs](/) *** # Type Alias: PostOrderByInput > **PostOrderByInput** = *typeof* [`PostOrderByInputEnum`](../variables/PostOrderByInputEnum.md)\[keyof *typeof* [`PostOrderByInputEnum`](../variables/PostOrderByInputEnum.md)\] Defined in: [src/types/Post/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L51) ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/PostUpdateInput.md ================================================ [Admin Docs](/) *** # Type Alias: PostUpdateInput > **PostUpdateInput** = `object` Defined in: [src/types/Post/type.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L54) ## Properties ### imageUrl? > `optional` **imageUrl**: `string` Defined in: [src/types/Post/type.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L55) *** ### text? > `optional` **text**: `string` Defined in: [src/types/Post/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L56) *** ### title? > `optional` **title**: `string` Defined in: [src/types/Post/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L57) *** ### videoUrl? > `optional` **videoUrl**: `string` Defined in: [src/types/Post/type.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L58) ================================================ FILE: docs/docs/auto-docs/types/Post/type/type-aliases/PostWhereInput.md ================================================ [Admin Docs](/) *** # Type Alias: PostWhereInput > **PostWhereInput** = `object` Defined in: [src/types/Post/type.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L61) ## Properties ### id? > `optional` **id**: `string` Defined in: [src/types/Post/type.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L63) *** ### id\_contains? > `optional` **id\_contains**: `string` Defined in: [src/types/Post/type.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L64) *** ### id\_in? > `optional` **id\_in**: `string`[] Defined in: [src/types/Post/type.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L65) *** ### id\_not? > `optional` **id\_not**: `string` Defined in: [src/types/Post/type.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L66) *** ### id\_not\_in? > `optional` **id\_not\_in**: `string`[] Defined in: [src/types/Post/type.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L67) *** ### id\_starts\_with? > `optional` **id\_starts\_with**: `string` Defined in: [src/types/Post/type.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L68) *** ### text? > `optional` **text**: `string` Defined in: [src/types/Post/type.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L69) *** ### text\_contains? > `optional` **text\_contains**: `string` Defined in: [src/types/Post/type.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L70) *** ### text\_in? > `optional` **text\_in**: `string`[] Defined in: [src/types/Post/type.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L71) *** ### text\_not? > `optional` **text\_not**: `string` Defined in: [src/types/Post/type.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L72) *** ### text\_not\_in? > `optional` **text\_not\_in**: `string`[] Defined in: [src/types/Post/type.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L73) *** ### text\_starts\_with? > `optional` **text\_starts\_with**: `string` Defined in: [src/types/Post/type.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L74) *** ### title? > `optional` **title**: `string` Defined in: [src/types/Post/type.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L75) *** ### title\_contains? > `optional` **title\_contains**: `string` Defined in: [src/types/Post/type.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L76) *** ### title\_in? > `optional` **title\_in**: `string`[] Defined in: [src/types/Post/type.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L77) *** ### title\_not? > `optional` **title\_not**: `string` Defined in: [src/types/Post/type.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L78) *** ### title\_not\_in? > `optional` **title\_not\_in**: `string`[] Defined in: [src/types/Post/type.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L79) *** ### title\_starts\_with? > `optional` **title\_starts\_with**: `string` Defined in: [src/types/Post/type.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L80) ================================================ FILE: docs/docs/auto-docs/types/Post/type/variables/PostOrderByInputEnum.md ================================================ [Admin Docs](/) *** # Variable: PostOrderByInputEnum > `const` **PostOrderByInputEnum**: `object` Defined in: [src/types/Post/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L32) ## Type Declaration ### COMMENT\_COUNT\_ASC > `readonly` **COMMENT\_COUNT\_ASC**: `"commentCount_ASC"` = `'commentCount_ASC'` ### COMMENT\_COUNT\_DESC > `readonly` **COMMENT\_COUNT\_DESC**: `"commentCount_DESC"` = `'commentCount_DESC'` ### CREATED\_AT\_ASC > `readonly` **CREATED\_AT\_ASC**: `"createdAt_ASC"` = `'createdAt_ASC'` ### CREATED\_AT\_DESC > `readonly` **CREATED\_AT\_DESC**: `"createdAt_DESC"` = `'createdAt_DESC'` ### ID\_ASC > `readonly` **ID\_ASC**: `"id_ASC"` = `'id_ASC'` ### ID\_DESC > `readonly` **ID\_DESC**: `"id_DESC"` = `'id_DESC'` ### IMAGE\_URL\_ASC > `readonly` **IMAGE\_URL\_ASC**: `"imageUrl_ASC"` = `'imageUrl_ASC'` ### IMAGE\_URL\_DESC > `readonly` **IMAGE\_URL\_DESC**: `"imageUrl_DESC"` = `'imageUrl_DESC'` ### LIKE\_COUNT\_ASC > `readonly` **LIKE\_COUNT\_ASC**: `"likeCount_ASC"` = `'likeCount_ASC'` ### LIKE\_COUNT\_DESC > `readonly` **LIKE\_COUNT\_DESC**: `"likeCount_DESC"` = `'likeCount_DESC'` ### TEXT\_ASC > `readonly` **TEXT\_ASC**: `"text_ASC"` = `'text_ASC'` ### TEXT\_DESC > `readonly` **TEXT\_DESC**: `"text_DESC"` = `'text_DESC'` ### TITLE\_ASC > `readonly` **TITLE\_ASC**: `"title_ASC"` = `'title_ASC'` ### TITLE\_DESC > `readonly` **TITLE\_DESC**: `"title_DESC"` = `'title_DESC'` ### VIDEO\_URL\_ASC > `readonly` **VIDEO\_URL\_ASC**: `"videoUrl_ASC"` = `'videoUrl_ASC'` ### VIDEO\_URL\_DESC > `readonly` **VIDEO\_URL\_DESC**: `"videoUrl_DESC"` = `'videoUrl_DESC'` ================================================ FILE: docs/docs/auto-docs/types/Recurrence/interface/interfaces/InterfaceCustomRecurrenceModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCustomRecurrenceModalProps Defined in: [src/types/Recurrence/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L7) Props interface for the CustomRecurrenceModal component ## Properties ### customRecurrenceModalIsOpen > **customRecurrenceModalIsOpen**: `boolean` Defined in: [src/types/Recurrence/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L19) Whether the custom recurrence modal is open *** ### endDate > **endDate**: `Date` Defined in: [src/types/Recurrence/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L15) Event end date *** ### hideCustomRecurrenceModal() > **hideCustomRecurrenceModal**: () => `void` Defined in: [src/types/Recurrence/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L21) Function to hide the custom recurrence modal #### Returns `void` *** ### recurrenceRuleState > **recurrenceRuleState**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/types/Recurrence/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L9) Current recurrence rule state *** ### setCustomRecurrenceModalIsOpen() > **setCustomRecurrenceModalIsOpen**: (`state`) => `void` Defined in: [src/types/Recurrence/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L23) Function to set custom recurrence modal open state #### Parameters ##### state `SetStateAction`\<`boolean`\> #### Returns `void` *** ### setEndDate() > **setEndDate**: (`state`) => `void` Defined in: [src/types/Recurrence/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L17) Function to set event end date #### Parameters ##### state `SetStateAction`\<`Date`\> #### Returns `void` *** ### setRecurrenceRuleState() > **setRecurrenceRuleState**: (`state`) => `void` Defined in: [src/types/Recurrence/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L11) Function to update recurrence rule state #### Parameters ##### state `SetStateAction`\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\> #### Returns `void` *** ### startDate > **startDate**: `Date` Defined in: [src/types/Recurrence/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L29) Event start date *** ### t() > **t**: (`key`) => `string` Defined in: [src/types/Recurrence/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L27) Translation function #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/InfiniteScrollProps.md ================================================ [Admin Docs](/) *** # Type Alias: InfiniteScrollProps > **InfiniteScrollProps** = `object` Defined in: [src/types/ReportingTable/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L55) Props for the InfiniteScroll component used in ReportingTable ## Properties ### dataLength > **dataLength**: `number` Defined in: [src/types/ReportingTable/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L56) *** ### hasMore > **hasMore**: `boolean` Defined in: [src/types/ReportingTable/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L58) *** ### next() > **next**: () => `void` Defined in: [src/types/ReportingTable/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L57) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingRow.md ================================================ [Admin Docs](/) *** # Type Alias: ReportingRow > **ReportingRow** = `Record`\<`string`, `unknown`\> Defined in: [src/types/ReportingTable/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L8) ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingTableColumn.md ================================================ [Admin Docs](/) *** # Type Alias: ReportingTableColumn > **ReportingTableColumn** = `Partial`\<`Omit`\<`GridColDef`, `"width"` \| `"minWidth"` \| `"maxWidth"`\>\> & `object` Defined in: [src/types/ReportingTable/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L16) ReportingTableColumnDef App-level column shape used across the app. It's a thin composition over MUI's `GridColDef` exposing the props we use commonly in screen files. ## Type Declaration ### align? > `optional` **align**: `"left"` \| `"center"` \| `"right"` Alignment for the column content ### field > **field**: `string` Unique field id for the column (required) ### flex? > `optional` **flex**: `number` Flex grow for the column ### headerAlign? > `optional` **headerAlign**: `"left"` \| `"center"` \| `"right"` Alignment for the column header ### headerClassName? > `optional` **headerClassName**: `string` Additional class applied to the header cell ### headerName? > `optional` **headerName**: `string` Header name for the column ### maxWidth? > `optional` **maxWidth**: `number` \| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md) Maximum width for the column - accepts number (pixels) or spacing token name ### minWidth? > `optional` **minWidth**: `number` \| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md) Minimum width for the column - accepts number (pixels) or spacing token name ### renderCell()? > `optional` **renderCell**: (`params`) => `ReactNode` Custom renderer for the cell #### Parameters ##### params `ReportingCellParams` #### Returns `ReactNode` ### sortable? > `optional` **sortable**: `boolean` Whether the column is sortable ### valueGetter()? > `optional` **valueGetter**: (`value`, `row`, `column`, `apiRef`) => `unknown` Custom value getter for the cell #### Parameters ##### value `unknown` ##### row [`ReportingRow`](ReportingRow.md) ##### column `GridColDef` ##### apiRef `unknown` #### Returns `unknown` ### width? > `optional` **width**: `number` \| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md) Column width - accepts number (pixels) or spacing token name ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingTableGridProps.md ================================================ [Admin Docs](/) *** # Type Alias: ReportingTableGridProps > **ReportingTableGridProps** = `object` Defined in: [src/types/ReportingTable/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L64) Props for the ReportingTableGrid component ## Indexable \[`key`: `string`\]: `unknown` ## Properties ### columns? > `optional` **columns**: [`ReportingTableColumn`](ReportingTableColumn.md)[] Defined in: [src/types/ReportingTable/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L66) *** ### compactColumns? > `optional` **compactColumns**: `boolean` Defined in: [src/types/ReportingTable/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L68) When true, applies tighter column widths for tables with many columns (7+) *** ### rows? > `optional` **rows**: readonly [`ReportingRow`](ReportingRow.md)[] Defined in: [src/types/ReportingTable/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L65) ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingTableProps.md ================================================ [Admin Docs](/) *** # Type Alias: ReportingTableProps > **ReportingTableProps** = `object` Defined in: [src/types/ReportingTable/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L76) Props for the ReportingTable component ## Properties ### columns > **columns**: [`ReportingTableColumn`](ReportingTableColumn.md)[] Defined in: [src/types/ReportingTable/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L78) *** ### gridProps? > `optional` **gridProps**: [`ReportingTableGridProps`](ReportingTableGridProps.md) Defined in: [src/types/ReportingTable/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L79) *** ### infiniteProps? > `optional` **infiniteProps**: [`InfiniteScrollProps`](InfiniteScrollProps.md) Defined in: [src/types/ReportingTable/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L81) Optional InfiniteScroll behavior; when provided, wraps the grid *** ### listProps? > `optional` **listProps**: `object` Defined in: [src/types/ReportingTable/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L83) Optional props applied to the InfiniteScroll container #### className? > `optional` **className**: `string` #### data-testid? > `optional` **data-testid**: `string` #### endMessage? > `optional` **endMessage**: `React.ReactNode` #### loader? > `optional` **loader**: `React.ReactNode` #### scrollThreshold? > `optional` **scrollThreshold**: `number` #### style? > `optional` **style**: `React.CSSProperties` *** ### rows > **rows**: readonly [`ReportingRow`](ReportingRow.md)[] Defined in: [src/types/ReportingTable/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L77) ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/utils/variables/PAGE_SIZE.md ================================================ [Admin Docs](/) *** # Variable: PAGE\_SIZE > `const` **PAGE\_SIZE**: `number` = `10` Defined in: [src/types/ReportingTable/utils.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/utils.ts#L3) ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/utils/variables/ROW_HEIGHT.md ================================================ [Admin Docs](/) *** # Variable: ROW\_HEIGHT > `const` **ROW\_HEIGHT**: `number` = `60` Defined in: [src/types/ReportingTable/utils.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/utils.ts#L2) ================================================ FILE: docs/docs/auto-docs/types/ReportingTable/utils/variables/dataGridStyle.md ================================================ [Admin Docs](/) *** # Variable: dataGridStyle > `const` **dataGridStyle**: `object` Defined in: [src/types/ReportingTable/utils.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/utils.ts#L9) Shared sx/style object for DataGrid across the app. Keep shape generic to avoid strict MUI theme coupling in the types package. ## Type Declaration #### & .MuiDataGrid-cell:focus > **& .MuiDataGrid-cell:focus**: `object` #### & .MuiDataGrid-cell:focus.outline > **outline**: `string` = `'none'` #### & .MuiDataGrid-cell:focus-within > **& .MuiDataGrid-cell:focus-within**: `object` #### & .MuiDataGrid-cell:focus-within.outline > **outline**: `string` = `'none'` #### & .MuiDataGrid-row > **& .MuiDataGrid-row**: `object` #### & .MuiDataGrid-row.&:focus-within > **&:focus-within**: `object` #### & .MuiDataGrid-row.&:focus-within.outline > **outline**: `string` = `'none'` #### & .MuiDataGrid-row.backgroundColor > **backgroundColor**: `string` = `'var(--row-background)'` #### & .MuiDataGrid-row:hover > **& .MuiDataGrid-row:hover**: `object` #### & .MuiDataGrid-row:hover.backgroundColor > **backgroundColor**: `string` = `'var(--row-background)'` #### & .MuiDataGrid-row.Mui-hovered > **& .MuiDataGrid-row.Mui-hovered**: `object` #### & .MuiDataGrid-row.Mui-hovered.backgroundColor > **backgroundColor**: `string` = `'var(--row-background)'` ### backgroundColor > **backgroundColor**: `string` = `'var(--row-background)'` ### borderRadius > **borderRadius**: `string` = `'var(--table-head-radius)'` ================================================ FILE: docs/docs/auto-docs/types/SearchBar/interface/interfaces/InterfaceSearchBarProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchBarProps Defined in: [src/types/SearchBar/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L33) Strongly typed props for the shared SearchBar component. ## Extends - `Omit`\<`React.InputHTMLAttributes`\<`HTMLInputElement`\>, `"onChange"` \| `"size"`\> ## Properties ### buttonAriaLabel? > `optional` **buttonAriaLabel**: `string` Defined in: [src/types/SearchBar/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L76) Accessible label for the search button. *** ### buttonClassName? > `optional` **buttonClassName**: `string` Defined in: [src/types/SearchBar/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L54) Additional class applied to the search button. *** ### buttonLabel? > `optional` **buttonLabel**: `string` Defined in: [src/types/SearchBar/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L74) Optional label shown inside the search button. *** ### buttonTestId? > `optional` **buttonTestId**: `string` Defined in: [src/types/SearchBar/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L58) Button test id override. *** ### className? > `optional` **className**: `string` Defined in: [src/types/SearchBar/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L50) Additional class applied to the container. #### Overrides `Omit.className` *** ### clearButtonAriaLabel? > `optional` **clearButtonAriaLabel**: `string` Defined in: [src/types/SearchBar/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L78) Accessible label for the clear button. *** ### clearButtonTestId? > `optional` **clearButtonTestId**: `string` Defined in: [src/types/SearchBar/interface.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L60) Clear button test id override. *** ### defaultValue? > `optional` **defaultValue**: `string` Defined in: [src/types/SearchBar/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L42) Initial value when used in uncontrolled mode. #### Overrides `Omit.defaultValue` *** ### icon? > `optional` **icon**: `ReactNode` Defined in: [src/types/SearchBar/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L82) Optional custom icon rendered inside the input field. *** ### inputClassName? > `optional` **inputClassName**: `string` Defined in: [src/types/SearchBar/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L52) Additional class applied to the input element. *** ### inputTestId? > `optional` **inputTestId**: `string` Defined in: [src/types/SearchBar/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L56) Input test id override. *** ### isLoading? > `optional` **isLoading**: `boolean` Defined in: [src/types/SearchBar/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L80) Renders a loading spinner inside the button when true. *** ### onChange()? > `optional` **onChange**: (`value`, `event?`) => `void` Defined in: [src/types/SearchBar/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L46) Callback fired whenever the input value changes. #### Parameters ##### value `string` ##### event? `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### onClear()? > `optional` **onClear**: () => `void` Defined in: [src/types/SearchBar/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L48) Callback fired after the clear button is pressed. #### Returns `void` *** ### onSearch()? > `optional` **onSearch**: (`value`, `metadata?`) => `void` Defined in: [src/types/SearchBar/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L44) Callback invoked when the user submits a search via button, Enter, or clear. #### Parameters ##### value `string` ##### metadata? [`InterfaceSearchMeta`](InterfaceSearchMeta.md) #### Returns `void` *** ### placeholder? > `optional` **placeholder**: `string` Defined in: [src/types/SearchBar/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L38) Placeholder text for the search input. #### Overrides `Omit.placeholder` *** ### showClearButton? > `optional` **showClearButton**: `boolean` Defined in: [src/types/SearchBar/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L68) Toggle visibility of the inline clear button. Defaults to true. *** ### showLeadingIcon? > `optional` **showLeadingIcon**: `boolean` Defined in: [src/types/SearchBar/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L70) Toggle the leading search icon visibility. Defaults to false. *** ### showSearchButton? > `optional` **showSearchButton**: `boolean` Defined in: [src/types/SearchBar/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L66) Toggle visibility of the trailing search button. Defaults to true. *** ### showTrailingIcon? > `optional` **showTrailingIcon**: `boolean` Defined in: [src/types/SearchBar/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L72) Toggle the trailing search icon visibility. Defaults to false. *** ### size? > `optional` **size**: [`SearchBarSize`](../../type/type-aliases/SearchBarSize.md) Defined in: [src/types/SearchBar/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L62) Visual size of the component. *** ### value? > `optional` **value**: `string` Defined in: [src/types/SearchBar/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L40) Controlled input value. #### Overrides `Omit.value` *** ### variant? > `optional` **variant**: [`SearchBarVariant`](../../type/type-aliases/SearchBarVariant.md) Defined in: [src/types/SearchBar/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L64) Visual variant of the component. ================================================ FILE: docs/docs/auto-docs/types/SearchBar/interface/interfaces/InterfaceSearchBarRef.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchBarRef Defined in: [src/types/SearchBar/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L21) Methods exposed by the SearchBar ref. ## Properties ### blur() > **blur**: () => `void` Defined in: [src/types/SearchBar/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L25) Programmatically blur the search input #### Returns `void` *** ### clear() > **clear**: () => `void` Defined in: [src/types/SearchBar/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L27) Clear the search input value and trigger onChange #### Returns `void` *** ### focus() > **focus**: () => `void` Defined in: [src/types/SearchBar/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L23) Programmatically focus the search input #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/SearchBar/interface/interfaces/InterfaceSearchMeta.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchMeta Defined in: [src/types/SearchBar/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L11) Metadata about how a search was triggered. ## Properties ### event? > `optional` **event**: `KeyboardEvent`\<`HTMLInputElement`\> \| `MouseEvent`\<`HTMLButtonElement`, `MouseEvent`\> Defined in: [src/types/SearchBar/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L15) The original DOM event that triggered the search, if available *** ### trigger > **trigger**: [`SearchBarTrigger`](../../type/type-aliases/SearchBarTrigger.md) Defined in: [src/types/SearchBar/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L13) The trigger source for the search (button click, enter key, etc.) ================================================ FILE: docs/docs/auto-docs/types/SearchBar/type/type-aliases/SearchBarSize.md ================================================ [Admin Docs](/) *** # Type Alias: SearchBarSize > **SearchBarSize** = `"sm"` \| `"md"` \| `"lg"` Defined in: [src/types/SearchBar/type.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/type.ts#L1) ================================================ FILE: docs/docs/auto-docs/types/SearchBar/type/type-aliases/SearchBarTrigger.md ================================================ [Admin Docs](/) *** # Type Alias: SearchBarTrigger > **SearchBarTrigger** = `"button"` \| `"enter"` \| `"clear"` Defined in: [src/types/SearchBar/type.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/type.ts#L3) ================================================ FILE: docs/docs/auto-docs/types/SearchBar/type/type-aliases/SearchBarVariant.md ================================================ [Admin Docs](/) *** # Type Alias: SearchBarVariant > **SearchBarVariant** = `"outline"` \| `"filled"` \| `"ghost"` Defined in: [src/types/SearchBar/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/type.ts#L2) ================================================ FILE: docs/docs/auto-docs/types/SidebarBase/interface/interfaces/ISidebarBaseProps.md ================================================ [Admin Docs](/) *** # Interface: ISidebarBaseProps Defined in: [src/types/SidebarBase/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L4) Interface for SidebarBase component props. ## Properties ### backgroundColor? > `optional` **backgroundColor**: `string` Defined in: [src/types/SidebarBase/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L18) (Optional) Background color override *** ### children > **children**: `ReactNode` Defined in: [src/types/SidebarBase/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L12) Navigation items and other content *** ### footerContent? > `optional` **footerContent**: `ReactNode` Defined in: [src/types/SidebarBase/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L16) (Optional) Footer content *** ### headerContent? > `optional` **headerContent**: `ReactNode` Defined in: [src/types/SidebarBase/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L14) (Optional) Content after branding (e.g., org section) *** ### hideDrawer > **hideDrawer**: `boolean` Defined in: [src/types/SidebarBase/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L6) State indicating whether the sidebar is hidden *** ### persistToggleState? > `optional` **persistToggleState**: `boolean` Defined in: [src/types/SidebarBase/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L20) (Optional) Whether to persist toggle state to localStorage *** ### portalType > **portalType**: `"user"` \| `"admin"` Defined in: [src/types/SidebarBase/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L10) Type of portal (admin or user) *** ### setHideDrawer > **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> Defined in: [src/types/SidebarBase/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L8) Function to toggle sidebar visibility ================================================ FILE: docs/docs/auto-docs/types/SidebarNavItem/interface/interfaces/ISidebarNavItemProps.md ================================================ [Admin Docs](/) *** # Interface: ISidebarNavItemProps Defined in: [src/types/SidebarNavItem/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L7) ## Properties ### dataCy? > `optional` **dataCy**: `string` Defined in: [src/types/SidebarNavItem/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L25) *** ### hideDrawer > **hideDrawer**: `boolean` Defined in: [src/types/SidebarNavItem/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L17) *** ### icon > **icon**: `ReactNode` Defined in: [src/types/SidebarNavItem/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L11) *** ### iconType? > `optional` **iconType**: `"svg"` \| `"react-icon"` Defined in: [src/types/SidebarNavItem/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L23) *** ### label > **label**: `string` Defined in: [src/types/SidebarNavItem/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L13) *** ### onClick()? > `optional` **onClick**: () => `void` Defined in: [src/types/SidebarNavItem/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L19) #### Returns `void` *** ### testId > **testId**: `string` Defined in: [src/types/SidebarNavItem/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L15) *** ### to > **to**: `string` Defined in: [src/types/SidebarNavItem/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L9) *** ### useSimpleButton? > `optional` **useSimpleButton**: `boolean` Defined in: [src/types/SidebarNavItem/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L21) ================================================ FILE: docs/docs/auto-docs/types/SidebarPluginSection/interface/interfaces/ISidebarPluginSectionProps.md ================================================ [Admin Docs](/) *** # Interface: ISidebarPluginSectionProps Defined in: [src/types/SidebarPluginSection/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L6) Interface for SidebarPluginSection component props. ## Properties ### hideDrawer > **hideDrawer**: `boolean` Defined in: [src/types/SidebarPluginSection/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L10) Whether the drawer is hidden/collapsed *** ### onItemClick()? > `optional` **onItemClick**: () => `void` Defined in: [src/types/SidebarPluginSection/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L14) (Optional) Handler for plugin item clicks #### Returns `void` *** ### orgId? > `optional` **orgId**: `string` Defined in: [src/types/SidebarPluginSection/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L12) (Optional) Organization ID for org-specific plugins *** ### pluginItems > **pluginItems**: [`IDrawerExtension`](../../../../plugin/types/interfaces/IDrawerExtension.md)[] Defined in: [src/types/SidebarPluginSection/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L8) Array of plugin drawer items *** ### useSimpleButton? > `optional` **useSimpleButton**: `boolean` Defined in: [src/types/SidebarPluginSection/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L16) (Optional) Use simple button style (for org drawers) ================================================ FILE: docs/docs/auto-docs/types/UseUserProfile/interfaces/InterfaceUseUserProfileReturn.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUseUserProfileReturn Defined in: [src/types/UseUserProfile.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L13) Return type for the useUserProfile hook. `@remarks` Provides user profile data and actions for rendering profile dropdowns and managing user authentication state across the application. `@example` ```tsx const { displayedName, userImage, handleLogout } = useUserProfile('user'); ``` ## Properties ### displayedName > **displayedName**: `string` Defined in: [src/types/UseUserProfile.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L24) Truncated display name (max 20 characters) with ellipsis if needed. Used for UI rendering to prevent layout overflow. *** ### handleLogout() > **handleLogout**: () => `Promise`\<`void`\> Defined in: [src/types/UseUserProfile.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L56) Async function to handle user logout. `@remarks` - Invokes logout mutation - Clears localStorage and session data - Navigates to root path - Includes race condition protection `@returns` Promise that resolves when logout completes `@throws` Logs errors but does not reject (fail-safe) #### Returns `Promise`\<`void`\> *** ### name > **name**: `string` Defined in: [src/types/UseUserProfile.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L18) Full user name retrieved from localStorage. `@defaultValue` Empty string if not found *** ### profileDestination > **profileDestination**: `string` Defined in: [src/types/UseUserProfile.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L42) Destination path for "View Profile" navigation. Resolved based on user role and portal context. *** ### tCommon() > **tCommon**: (`key`) => `string` Defined in: [src/types/UseUserProfile.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L64) Translation function for common strings. `@param` key - Translation key from common namespace `@returns` Translated string in the current locale #### Parameters ##### key `string` #### Returns `string` *** ### userImage > **userImage**: `string` Defined in: [src/types/UseUserProfile.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L36) Sanitized avatar URL or empty string if unavailable. Handles null, undefined, and string "null" values. *** ### userRole > **userRole**: `string` Defined in: [src/types/UseUserProfile.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L30) User's role in the system (e.g., 'ADMIN', 'USER', 'SUPERADMIN'). `@defaultValue` Empty string if not found ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceChatUser.md ================================================ [Admin Docs](/) *** # Interface: InterfaceChatUser Defined in: [src/types/UserPortal/Chat/interface.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L144) **`Internal`** Interface representing a chat user structure. ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L145) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/UserPortal/Chat/interface.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L149) *** ### email > **email**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L148) *** ### firstName > **firstName**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L146) *** ### lastName > **lastName**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L147) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceContactCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceContactCardProps Defined in: [src/types/UserPortal/Chat/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L119) Props for ContactCard component. ## Properties ### id > **id**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L120) *** ### image > **image**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L122) *** ### isGroup > **isGroup**: `boolean` Defined in: [src/types/UserPortal/Chat/interface.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L125) *** ### lastMessage > **lastMessage**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L127) *** ### selectedContact > **selectedContact**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L123) *** ### setSelectedContact > **setSelectedContact**: `Dispatch`\<`SetStateAction`\<`string`\>\> Defined in: [src/types/UserPortal/Chat/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L124) *** ### title > **title**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L121) *** ### unseenMessages > **unseenMessages**: `number` Defined in: [src/types/UserPortal/Chat/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L126) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceGroupChatDetailsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceGroupChatDetailsProps Defined in: [src/types/UserPortal/Chat/interface.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L99) ## Properties ### chat > **chat**: [`Chat`](../type-aliases/Chat.md) Defined in: [src/types/UserPortal/Chat/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L102) *** ### chatRefetch() > **chatRefetch**: (`variables?`) => `Promise`\<`ApolloQueryResult`\<\{ `chat`: [`Chat`](../type-aliases/Chat.md); \}\>\> Defined in: [src/types/UserPortal/Chat/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L103) #### Parameters ##### variables? `Partial`\<\{ `after?`: `string`; `beforeMessages?`: `string`; `first?`: `number`; `input`: \{ `id`: `string`; \}; `lastMessages?`: `number`; \}\> #### Returns `Promise`\<`ApolloQueryResult`\<\{ `chat`: [`Chat`](../type-aliases/Chat.md); \}\>\> *** ### groupChatDetailsModalisOpen > **groupChatDetailsModalisOpen**: `boolean` Defined in: [src/types/UserPortal/Chat/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L101) *** ### toggleGroupChatDetailsModal() > **toggleGroupChatDetailsModal**: () => `void` Defined in: [src/types/UserPortal/Chat/interface.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L100) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceMockMessage.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMockMessage Defined in: [src/types/UserPortal/Chat/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L156) **`Internal`** Interface representing a mock message structure for testing purposes. ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L157) *** ### createdAt > **createdAt**: `Date` Defined in: [src/types/UserPortal/Chat/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L158) *** ### media? > `optional` **media**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L163) *** ### messageContent > **messageContent**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L160) *** ### replyTo? > `optional` **replyTo**: `InterfaceMockMessage` Defined in: [src/types/UserPortal/Chat/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L161) *** ### sender > **sender**: [`InterfaceChatUser`](InterfaceChatUser.md) Defined in: [src/types/UserPortal/Chat/interface.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L159) *** ### updatedAt > **updatedAt**: `Date` Defined in: [src/types/UserPortal/Chat/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L162) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceOrganizationMember.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationMember Defined in: [src/types/UserPortal/Chat/interface.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L133) Organization member with their role. ## Properties ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L136) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L134) *** ### name > **name**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L135) *** ### role > **role**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L137) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Chat/interface/type-aliases/Chat.md ================================================ [Admin Docs](/) *** # Type Alias: Chat > **Chat** = `object` Defined in: [src/types/UserPortal/Chat/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L3) ## Properties ### avatarMimeType? > `optional` **avatarMimeType**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L7) *** ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L8) *** ### createdAt > **createdAt**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L10) *** ### creator? > `optional` **creator**: `object` Defined in: [src/types/UserPortal/Chat/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L41) #### avatarMimeType? > `optional` **avatarMimeType**: `string` #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### description? > `optional` **description**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L6) *** ### firstUnreadMessageId? > `optional` **firstUnreadMessageId**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L14) *** ### hasUnread? > `optional` **hasUnread**: `boolean` Defined in: [src/types/UserPortal/Chat/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L13) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L4) *** ### isGroup > **isGroup**: `boolean` Defined in: [src/types/UserPortal/Chat/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L9) *** ### lastMessage? > `optional` **lastMessage**: `object` Defined in: [src/types/UserPortal/Chat/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L15) #### body > **body**: `string` #### createdAt > **createdAt**: `string` #### creator > **creator**: `object` ##### creator.avatarMimeType? > `optional` **avatarMimeType**: `string` ##### creator.avatarURL? > `optional` **avatarURL**: `string` ##### creator.id > **id**: `string` ##### creator.name > **name**: `string` #### id > **id**: `string` #### parentMessage? > `optional` **parentMessage**: `object` ##### parentMessage.body > **body**: `string` ##### parentMessage.createdAt > **createdAt**: `string` ##### parentMessage.creator > **creator**: `object` ##### parentMessage.creator.id > **id**: `string` ##### parentMessage.creator.name > **name**: `string` ##### parentMessage.id > **id**: `string` #### updatedAt? > `optional` **updatedAt**: `string` \| `null` *** ### members? > `optional` **members**: `object` Defined in: [src/types/UserPortal/Chat/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L53) #### edges > **edges**: `object`[] *** ### messages? > `optional` **messages**: `object` Defined in: [src/types/UserPortal/Chat/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L67) #### edges > **edges**: `object`[] *** ### name > **name**: `string` Defined in: [src/types/UserPortal/Chat/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L5) *** ### organization? > `optional` **organization**: `object` Defined in: [src/types/UserPortal/Chat/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L36) #### countryCode? > `optional` **countryCode**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### unreadMessagesCount? > `optional` **unreadMessagesCount**: `number` Defined in: [src/types/UserPortal/Chat/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L12) *** ### updatedAt? > `optional` **updatedAt**: `string` \| `null` Defined in: [src/types/UserPortal/Chat/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L11) *** ### updater? > `optional` **updater**: `object` Defined in: [src/types/UserPortal/Chat/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L47) #### avatarMimeType? > `optional` **avatarMimeType**: `string` #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/types/UserPortal/CommentCard/interface/interfaces/InterfaceCommentCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCommentCardProps Defined in: [src/types/UserPortal/CommentCard/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L6) Props for CommentCard component. ## Properties ### creator > **creator**: `object` Defined in: [src/types/UserPortal/CommentCard/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L15) The creator of the comment, including their ID, name, and optional avatar URL. #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### hasUserVoted? > `optional` **hasUserVoted**: `object` Defined in: [src/types/UserPortal/CommentCard/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L24) Object indicating if current user has voted and the vote type. #### voteType > **voteType**: [`VoteType`](../../../../../utils/interfaces/type-aliases/VoteType.md) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/CommentCard/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L10) The unique identifier of the comment. *** ### refetchComments()? > `optional` **refetchComments**: () => `void` Defined in: [src/types/UserPortal/CommentCard/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L39) Optional callback to refresh comments after modifications. #### Returns `void` *** ### text > **text**: `string` Defined in: [src/types/UserPortal/CommentCard/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L34) The text content of the comment. *** ### upVoteCount > **upVoteCount**: `number` Defined in: [src/types/UserPortal/CommentCard/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L29) The number of upvotes (likes) on the comment. ================================================ FILE: docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/interfaces/InterfaceCreateDirectChatProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreateDirectChatProps Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L40) Props for the CreateDirectChat modal. ## Properties ### chats > **chats**: [`Chat`](../../../Chat/interface/type-aliases/Chat.md)[] Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L44) *** ### chatsListRefetch > **chatsListRefetch**: [`ChatsListRefetch`](../type-aliases/ChatsListRefetch.md) Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L43) *** ### createDirectChatModalisOpen > **createDirectChatModalisOpen**: `boolean` Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L42) *** ### toggleCreateDirectChatModal() > **toggleCreateDirectChatModal**: () => `void` Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L41) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/type-aliases/ChatsListRefetch.md ================================================ [Admin Docs](/) *** # Type Alias: ChatsListRefetch() > **ChatsListRefetch** = (`variables?`) => `Promise`\<`ApolloQueryResult`\<`unknown`\>\> Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L11) ## Parameters ### variables? `Partial`\<\{ `id`: `string`; \}\> ## Returns `Promise`\<`ApolloQueryResult`\<`unknown`\>\> ================================================ FILE: docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/type-aliases/CreateChatMembershipMutation.md ================================================ [Admin Docs](/) *** # Type Alias: CreateChatMembershipMutation() > **CreateChatMembershipMutation** = (`options?`) => `Promise`\<`FetchResult`\<`unknown`\>\> Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L26) ## Parameters ### options? `MutationFunctionOptions`\<`unknown`, `OperationVariables`, `DefaultContext`, `ApolloCache`\<`unknown`\>\> ## Returns `Promise`\<`FetchResult`\<`unknown`\>\> ================================================ FILE: docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/type-aliases/CreateChatMutation.md ================================================ [Admin Docs](/) *** # Type Alias: CreateChatMutation() > **CreateChatMutation** = (`options?`) => `Promise`\<`FetchResult`\<`unknown`\>\> Defined in: [src/types/UserPortal/CreateDirectChat/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L15) ## Parameters ### options? `MutationFunctionOptions`\<`unknown`, `OperationVariables`, `DefaultContext`, `ApolloCache`\<`unknown`\>\> ## Returns `Promise`\<`FetchResult`\<`unknown`\>\> ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Donation/interface/interfaces/InterfaceDonation.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDonation Defined in: [src/types/UserPortal/Donation/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L1) ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L2) *** ### amount > **amount**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L4) *** ### nameOfUser > **nameOfUser**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L3) *** ### payPalId > **payPalId**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L6) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L7) *** ### userId > **userId**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L5) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/Donation/interface/interfaces/InterfaceDonationCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDonationCardProps Defined in: [src/types/UserPortal/Donation/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L10) ## Properties ### amount > **amount**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L13) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L11) *** ### name > **name**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L12) *** ### payPalId > **payPalId**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L15) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L16) *** ### userId > **userId**: `string` Defined in: [src/types/UserPortal/Donation/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L14) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/EmptyChatState/interface/interfaces/InterfaceEmptyChatStateProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEmptyChatStateProps Defined in: [src/types/UserPortal/EmptyChatState/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EmptyChatState/interface.ts#L4) Props interface for the EmptyChatState component. ## Properties ### message > **message**: `string` Defined in: [src/types/UserPortal/EmptyChatState/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EmptyChatState/interface.ts#L5) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/EventCard/interface/interfaces/InterfaceEventCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventCardProps Defined in: [src/types/UserPortal/EventCard/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L6) Interface for EventCard component props. ## Properties ### attendees > **attendees**: `Partial`\<[`User`](../../../../Event/type/type-aliases/User.md)\>[] Defined in: [src/types/UserPortal/EventCard/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L26) List of users attending the event *** ### creator > **creator**: `Partial`\<[`User`](../../../../Event/type/type-aliases/User.md)\> Defined in: [src/types/UserPortal/EventCard/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L24) Information about the user who created the event *** ### description > **description**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L12) Detailed description of the event *** ### endAt > **endAt**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L18) ISO string for the event end date/time *** ### endTime? > `optional` **endTime**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L22) formatted end time string (optional) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L8) Unique identifier for the event *** ### isInviteOnly > **isInviteOnly**: `boolean` Defined in: [src/types/UserPortal/EventCard/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L31) Determines if the event is restricted to invited participants only. When true, only invited users can see and access the event. *** ### location > **location**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L14) Physical or virtual location of the event *** ### name > **name**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L10) Name or title of the event *** ### startAt > **startAt**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L16) ISO string for the event start date/time *** ### startTime? > `optional` **startTime**: `string` Defined in: [src/types/UserPortal/EventCard/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L20) formatted start time string (optional) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/GroupModal/interface/interfaces/InterfaceGroupModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceGroupModalProps Defined in: [src/types/UserPortal/GroupModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L7) Props for GroupModal component. ## Properties ### eventId > **eventId**: `string` Defined in: [src/types/UserPortal/GroupModal/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L10) *** ### group > **group**: [`InterfaceVolunteerGroupInfo`](../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md) Defined in: [src/types/UserPortal/GroupModal/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L11) *** ### hide() > **hide**: () => `void` Defined in: [src/types/UserPortal/GroupModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L9) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined in: [src/types/UserPortal/GroupModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L8) *** ### refetchGroups() > **refetchGroups**: () => `void` Defined in: [src/types/UserPortal/GroupModal/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L12) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/UserPortal/RecurringEventVolunteerModal/interface/interfaces/InterfaceRecurringEventVolunteerModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurringEventVolunteerModalProps Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L4) Interface for RecurringEventVolunteerModal component props ## Properties ### eventDate > **eventDate**: `string` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L23) Date of the event instance (ISO string format) *** ### eventName > **eventName**: `string` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L18) Name of the event *** ### groupName? > `optional` **groupName**: `string` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L43) Name of the volunteer group (required when isForGroup is true) *** ### isForGroup? > `optional` **isForGroup**: `boolean` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L38) Whether this is for joining a volunteer group (vs individual volunteering) *** ### onHide() > **onHide**: () => `void` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L13) Callback function to hide/close the modal #### Returns `void` *** ### onSelectInstance() > **onSelectInstance**: () => `void` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L33) Callback when user selects to volunteer for a single instance #### Returns `void` *** ### onSelectSeries() > **onSelectSeries**: () => `void` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L28) Callback when user selects to volunteer for the entire series #### Returns `void` *** ### show > **show**: `boolean` Defined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L8) Whether the modal is visible ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalCard/interface/interfaces/InterfaceUserPortalCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserPortalCardProps Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L12) Props for UserPortalCard — a flexible layout wrapper for User Portal cards. Layout: [ imageSlot ] [ children / content ] [ actionsSlot ] This component centralizes layout, spacing, and density while keeping all content and text controlled by consuming components. ## Properties ### actionsSlot? > `optional` **actionsSlot**: `ReactNode` Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L18) (Optional) Right section (buttons, badges, counters) *** ### ariaLabel? > `optional` **ariaLabel**: `string` Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L26) (Optional) Accessible label for the card container (i18n required) *** ### children > **children**: `ReactNode` Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L16) Main content area (required) *** ### className? > `optional` **className**: `string` Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L22) (Optional) Additional class for the outer container *** ### dataTestId? > `optional` **dataTestId**: `string` Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L24) (Optional) Test id prefix for unit/e2e testing *** ### imageSlot? > `optional` **imageSlot**: `ReactNode` Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L14) (Optional) Left section (avatar, logo, thumbnail, icon) *** ### variant? > `optional` **variant**: `"compact"` \| `"standard"` \| `"expanded"` Defined in: [src/types/UserPortal/UserPortalCard/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L20) Visual density preset controlling padding and spacing ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/interfaces/InterfaceLanguageSelectorProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceLanguageSelectorProps Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L173) Props interface for LanguageSelector subcomponent Defines properties for the language selection dropdown that allows users to switch between available interface languages (en, fr, hi, es, zh). ## Properties ### currentLanguageCode? > `optional` **currentLanguageCode**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L197) Current selected language code *** ### dropDirection? > `optional` **dropDirection**: `"start"` \| `"end"` \| `"up"` \| `"down"` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L187) Dropdown menu direction *** ### handleLanguageChange() > **handleLanguageChange**: (`languageCode`) => `void` \| `Promise`\<`void`\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L192) Handler called when a language is selected #### Parameters ##### languageCode `string` #### Returns `void` \| `Promise`\<`void`\> *** ### showLanguageSelector? > `optional` **showLanguageSelector**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L177) Whether to display the language selector dropdown *** ### testIdPrefix? > `optional` **testIdPrefix**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L182) Prefix for test IDs ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/interfaces/InterfaceUserDropdownProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserDropdownProps Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L203) Props interface for UserDropdown subcomponent ## Properties ### dropDirection > **dropDirection**: `"start"` \| `"end"` \| `"up"` \| `"down"` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L217) Dropdown menu direction *** ### finalUserName > **finalUserName**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:227](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L227) Final resolved user name to display *** ### handleLogout() > **handleLogout**: () => `void` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:222](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L222) User profile menu items #### Returns `void` *** ### navigate > **navigate**: `NavigateFunction` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L232) Navigation function from react-router *** ### PermIdentityIcon > **PermIdentityIcon**: `OverridableComponent`\<`SvgIconTypeMap`\<`object`, `"svg"`\>\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L247) Material UI icon component for profile display *** ### showUserProfile > **showUserProfile**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L207) Whether to display the user profile dropdown *** ### styles > **styles**: `CSSModuleClasses` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L242) CSS module classes *** ### tCommon > **tCommon**: `TFunction` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:237](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L237) i18next translation function *** ### testIdPrefix > **testIdPrefix**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L212) Prefix for test IDs ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/interfaces/InterfaceUserPortalNavbarProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserPortalNavbarProps Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L54) Main component props interface ## Properties ### branding? > `optional` **branding**: [`BrandingConfig`](../../types/type-aliases/BrandingConfig.md) Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L64) Branding configuration for logo and brand name *** ### className? > `optional` **className**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L153) Additional CSS class names *** ### currentPage? > `optional` **currentPage**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L76) Current active page identifier (matches NavigationLink.id) Used to highlight the active navigation link *** ### customStyles? > `optional` **customStyles**: `CSSProperties` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L158) Inline styles *** ### expandBreakpoint? > `optional` **expandBreakpoint**: `"sm"` \| `"md"` \| `"lg"` \| `"xl"` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L124) Breakpoint at which navbar expands default 'md' *** ### fetchOrganizationData? > `optional` **fetchOrganizationData**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L94) Whether to fetch organization data via GraphQL default true when mode === 'organization' *** ### mobileLayout? > `optional` **mobileLayout**: `"collapse"` \| `"offcanvas"` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L130) Mobile layout style default 'collapse' for user mode, 'offcanvas' for organization mode *** ### mode? > `optional` **mode**: `"organization"` \| `"user"` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L59) Navigation mode - determines default behavior and styling default 'user' *** ### navigationLinks? > `optional` **navigationLinks**: [`NavigationLink`](../../types/type-aliases/NavigationLink.md)[] Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L70) Array of navigation links to display in the navbar Only shown in organization mode or when explicitly provided *** ### onLanguageChange()? > `optional` **onLanguageChange**: (`languageCode`) => `void` \| `Promise`\<`void`\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L142) Custom language change handler If not provided, uses default i18next language change #### Parameters ##### languageCode `string` #### Returns `void` \| `Promise`\<`void`\> *** ### onLogout()? > `optional` **onLogout**: () => `void` \| `Promise`\<`void`\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L136) Custom logout handler If not provided, uses default logout behavior based on mode #### Returns `void` \| `Promise`\<`void`\> *** ### onNavigation()? > `optional` **onNavigation**: (`link`) => `void` \| `Promise`\<`void`\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L148) Custom navigation handler If not provided, uses react-router navigation #### Parameters ##### link [`NavigationLink`](../../types/type-aliases/NavigationLink.md) #### Returns `void` \| `Promise`\<`void`\> *** ### organizationId? > `optional` **organizationId**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L82) Organization ID - required for organization mode Used for GraphQL queries and navigation *** ### organizationName? > `optional` **organizationName**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L88) Organization name - can be provided directly or fetched via GraphQL If not provided and fetchOrganizationData is true, will be fetched *** ### showLanguageSelector? > `optional` **showLanguageSelector**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L106) Show language selector dropdown default true *** ### showNotifications? > `optional` **showNotifications**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L100) Show notification icon component default true when mode === 'user', false when mode === 'organization' *** ### showUserProfile? > `optional` **showUserProfile**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L112) Show user profile dropdown default true *** ### userName? > `optional` **userName**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L164) Override user name (for testing or external state management) If not provided, reads from localStorage *** ### variant? > `optional` **variant**: `"dark"` \| `"light"` Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L118) Navbar color variant default 'dark' ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/variables/DEFAULT_ORGANIZATION_MODE_PROPS.md ================================================ [Admin Docs](/) *** # Variable: DEFAULT\_ORGANIZATION\_MODE\_PROPS > `const` **DEFAULT\_ORGANIZATION\_MODE\_PROPS**: `Partial`\<[`InterfaceUserPortalNavbarProps`](../interfaces/InterfaceUserPortalNavbarProps.md)\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L267) Default props for organization mode ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/variables/DEFAULT_USER_MODE_PROPS.md ================================================ [Admin Docs](/) *** # Variable: DEFAULT\_USER\_MODE\_PROPS > `const` **DEFAULT\_USER\_MODE\_PROPS**: `Partial`\<[`InterfaceUserPortalNavbarProps`](../interfaces/InterfaceUserPortalNavbarProps.md)\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L252) Default props for user mode ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/BrandingConfig.md ================================================ [Admin Docs](/) *** # Type Alias: BrandingConfig > **BrandingConfig** = `object` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L74) Branding configuration for the navbar ## Properties ### brandName? > `optional` **brandName**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L85) Brand name to display next to logo #### Default Value ```ts 'Talawa' for user mode, organization name for organization mode ``` *** ### logo? > `optional` **logo**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L79) Logo image source URL or path #### Default Value ```ts Talawa logo from assets/images/talawa-logo-600x600.png ``` *** ### logoAltText? > `optional` **logoAltText**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L91) Alt text for logo image #### Default Value ```ts Translation key 'userNavbar.talawaBranding' ``` *** ### onBrandClick()? > `optional` **onBrandClick**: () => `void` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L97) Click handler for brand/logo #### Returns `void` #### Default Value ```ts undefined (no action) ``` ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/Language.md ================================================ [Admin Docs](/) *** # Type Alias: Language > **Language** = `object` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L66) Language configuration (from utils/languages) ## Properties ### code > **code**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L67) *** ### country\_code > **country\_code**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L69) *** ### name > **name**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L68) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/NavigationLink.md ================================================ [Admin Docs](/) *** # Type Alias: NavigationLink > **NavigationLink** = `object` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L103) Navigation link configuration ## Properties ### icon? > `optional` **icon**: `React.ComponentType`\<\{ `className?`: `string`; \}\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L128) Icon component (optional) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L107) Unique identifier for the link (used for active state) *** ### isActive? > `optional` **isActive**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L134) Whether this link is currently active #### Default Value ```ts false (will be determined by comparing id with currentPage) ``` *** ### label > **label**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L112) Display text for the link *** ### onClick()? > `optional` **onClick**: () => `void` \| `Promise`\<`void`\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L139) Click handler (optional, overrides #### Returns `void` \| `Promise`\<`void`\> #### Default Value ```ts navigation) ``` *** ### path > **path**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L117) URL path or route *** ### testId? > `optional` **testId**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L144) Additional data attributes for testing *** ### translationKey? > `optional` **translationKey**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L123) Translation key (optional, overrides label if provided) Should be in format 'namespace:key' or just 'key' (uses default namespace) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/OrganizationData.md ================================================ [Admin Docs](/) *** # Type Alias: OrganizationData > **OrganizationData** = `object` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:181](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L181) Organization data structure (from GraphQL ORGANIZATION_LIST query) ## Properties ### addressLine1? > `optional` **addressLine1**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L184) *** ### adminsCount? > `optional` **adminsCount**: `number` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L188) *** ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L186) *** ### createdAt? > `optional` **createdAt**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L189) *** ### description? > `optional` **description**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L185) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L182) *** ### membersCount? > `optional` **membersCount**: `number` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L187) *** ### name > **name**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L183) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/OrganizationListQueryResponse.md ================================================ [Admin Docs](/) *** # Type Alias: OrganizationListQueryResponse > **OrganizationListQueryResponse** = `object` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L149) GraphQL query response structure for organization list ## Properties ### organizations > **organizations**: [`OrganizationData`](OrganizationData.md)[] Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L150) ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/UserPortalNavbarState.md ================================================ [Admin Docs](/) *** # Type Alias: UserPortalNavbarState > **UserPortalNavbarState** = `object` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L156) Internal component state ## Properties ### currentLanguageCode > **currentLanguageCode**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L160) Current selected language code *** ### isMobileMenuOpen > **isMobileMenuOpen**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L170) Whether mobile menu is open *** ### organizationDetails > **organizationDetails**: [`OrganizationData`](OrganizationData.md) \| `null` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L165) Organization details (null for user mode or when not fetched) *** ### userName > **userName**: `string` \| `null` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L175) User name from localStorage ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/UserProfileMenuItem.md ================================================ [Admin Docs](/) *** # Type Alias: UserProfileMenuItem > **UserProfileMenuItem** = `object` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L26) User profile menu item configuration ## Properties ### icon? > `optional` **icon**: `React.ComponentType`\<\{ `className?`: `string`; \}\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L46) Icon component (optional) *** ### id > **id**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L30) Unique identifier *** ### isDivider? > `optional` **isDivider**: `boolean` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L56) Whether this is a divider item (renders as Dropdown.Divider) *** ### label > **label**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L35) Display label or translation key *** ### onClick() > **onClick**: () => `void` \| `Promise`\<`void`\> Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L51) Click handler #### Returns `void` \| `Promise`\<`void`\> *** ### testId? > `optional` **testId**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L61) Test ID for testing *** ### translationKey? > `optional` **translationKey**: `string` Defined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L41) Translation key prefix (optional) #### Default Value ```ts 'common' ``` ================================================ FILE: docs/docs/auto-docs/types/UserPortal/UserProfile/interface/type-aliases/InterfaceUserProfileProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceUserProfileProps > **InterfaceUserProfileProps** = `Partial`\<[`InterfaceUser`](../../../../shared-components/User/interface/interfaces/InterfaceUser.md)\> Defined in: [src/types/UserPortal/UserProfile/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserProfile/interface.ts#L6) Props for UserProfile component. ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceCreateVolunteerGroupData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreateVolunteerGroupData Defined in: [src/types/Volunteer/interface.ts:312](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L312) Defines the structure for create volunteer group mutation data. ## Properties ### description? > `optional` **description**: `string` Defined in: [src/types/Volunteer/interface.ts:320](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L320) (Optional) The description of the volunteer group. *** ### eventId > **eventId**: `string` Defined in: [src/types/Volunteer/interface.ts:314](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L314) The event ID. *** ### leaderId? > `optional` **leaderId**: `string` Defined in: [src/types/Volunteer/interface.ts:316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L316) (Optional) The ID of the group leader. *** ### name > **name**: `string` Defined in: [src/types/Volunteer/interface.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L318) The name of the volunteer group. *** ### recurringEventInstanceId? > `optional` **recurringEventInstanceId**: `string` Defined in: [src/types/Volunteer/interface.ts:328](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L328) (Optional) Instance ID for recurring events. *** ### scope? > `optional` **scope**: `"ENTIRE_SERIES"` \| `"THIS_INSTANCE_ONLY"` Defined in: [src/types/Volunteer/interface.ts:326](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L326) (Optional) Scope for recurring events. *** ### volunteersRequired? > `optional` **volunteersRequired**: `number` Defined in: [src/types/Volunteer/interface.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L322) (Optional) Number of volunteers required. *** ### volunteerUserIds > **volunteerUserIds**: `string`[] Defined in: [src/types/Volunteer/interface.ts:324](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L324) Array of volunteer user IDs. ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceEventEdge.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventEdge Defined in: [src/types/Volunteer/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L44) Defines the structure for GraphQL event edge from queries. ## Properties ### node > **node**: `object` Defined in: [src/types/Volunteer/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L46) The event node containing all event data. #### allDay > **allDay**: `boolean` #### baseEvent? > `optional` **baseEvent**: `object` ##### baseEvent.id > **id**: `string` ##### baseEvent.isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` ##### baseEvent.name > **name**: `string` #### description > **description**: `string` #### endAt > **endAt**: `string` #### id > **id**: `string` #### isRecurringEventTemplate > **isRecurringEventTemplate**: `boolean` #### location > **location**: `string` #### name > **name**: `string` #### recurrenceRule? > `optional` **recurrenceRule**: `object` ##### recurrenceRule.frequency > **frequency**: `string` ##### recurrenceRule.id > **id**: `string` #### startAt > **startAt**: `string` #### volunteerGroups > **volunteerGroups**: `object`[] #### volunteers > **volunteers**: `object`[] ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceEventVolunteerInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventVolunteerInfo Defined in: [src/types/Volunteer/interface.ts:243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L243) Defines the structure for event volunteer information. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/types/Volunteer/interface.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L259) The creation date of the volunteer record. *** ### creator > **creator**: `object` Defined in: [src/types/Volunteer/interface.ts:285](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L285) The user object who created this volunteer record. #### id > **id**: `string` The unique identifier of the creator #### name > **name**: `string` The name of the creator *** ### event > **event**: `object` Defined in: [src/types/Volunteer/interface.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L272) The event object associated with the volunteer. #### baseEvent? > `optional` **baseEvent**: `object` ##### baseEvent.id > **id**: `string` #### id > **id**: `string` The unique identifier of the event #### name > **name**: `string` The name of the event #### recurrenceRule? > `optional` **recurrenceRule**: `object` ##### recurrenceRule.id > **id**: `string` *** ### groups > **groups**: `object`[] Defined in: [src/types/Volunteer/interface.ts:299](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L299) Array of groups associated with the volunteer. #### description > **description**: `string` #### id > **id**: `string` #### name > **name**: `string` #### volunteers > **volunteers**: `object`[] *** ### hasAccepted > **hasAccepted**: `boolean` Defined in: [src/types/Volunteer/interface.ts:247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L247) Indicates if the volunteer has accepted. *** ### hoursVolunteered > **hoursVolunteered**: `number` Defined in: [src/types/Volunteer/interface.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L251) The number of hours volunteered. *** ### id > **id**: `string` Defined in: [src/types/Volunteer/interface.ts:245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L245) The unique identifier of the event volunteer. *** ### isInstanceException > **isInstanceException**: `boolean` Defined in: [src/types/Volunteer/interface.ts:257](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L257) Indicates if this is an exception to a recurring instance. *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Volunteer/interface.ts:253](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L253) Indicates if the volunteer profile is public. *** ### isTemplate > **isTemplate**: `boolean` Defined in: [src/types/Volunteer/interface.ts:255](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L255) Indicates if this is a template volunteer record. *** ### updatedAt > **updatedAt**: `string` Defined in: [src/types/Volunteer/interface.ts:261](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L261) The last update date of the volunteer record. *** ### updater > **updater**: `object` Defined in: [src/types/Volunteer/interface.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L292) The user object who last updated this volunteer record. #### id > **id**: `string` The unique identifier of the updater #### name > **name**: `string` The name of the updater *** ### user > **user**: `object` Defined in: [src/types/Volunteer/interface.ts:263](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L263) The user object information of the volunteer. #### avatarURL? > `optional` **avatarURL**: `string` The avatar URL of the user (optional) #### id > **id**: `string` The unique identifier of the user #### name > **name**: `string` The name of the user *** ### volunteerStatus > **volunteerStatus**: `"accepted"` \| `"rejected"` \| `"pending"` Defined in: [src/types/Volunteer/interface.ts:249](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L249) The status of the volunteer. ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceMappedEvent.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMappedEvent Defined in: [src/types/Volunteer/interface.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L93) Defines the structure for mapped event objects used in the UI. ## Properties ### \_id > **\_id**: `string` Defined in: [src/types/Volunteer/interface.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L95) Legacy ID format. *** ### baseEventId > **baseEventId**: `string` Defined in: [src/types/Volunteer/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L119) The base event ID for recurring events. *** ### description > **description**: `string` Defined in: [src/types/Volunteer/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L103) The description of the event. *** ### endAt > **endAt**: `string` Defined in: [src/types/Volunteer/interface.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L111) The original endAt field. *** ### endDate > **endDate**: `string` Defined in: [src/types/Volunteer/interface.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L107) The end date (mapped from endAt). *** ### id > **id**: `string` Defined in: [src/types/Volunteer/interface.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L97) The unique identifier of the event. *** ### isRecurringInstance > **isRecurringInstance**: `boolean` Defined in: [src/types/Volunteer/interface.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L117) Indicates if this is a recurring instance. *** ### location > **location**: `string` Defined in: [src/types/Volunteer/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L113) The location of the event. *** ### name > **name**: `string` Defined in: [src/types/Volunteer/interface.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L99) The name of the event. *** ### recurrenceRule? > `optional` **recurrenceRule**: `object` Defined in: [src/types/Volunteer/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L121) (Optional) The recurrence rule for recurring events. #### frequency > **frequency**: `string` #### id > **id**: `string` *** ### recurring > **recurring**: `boolean` Defined in: [src/types/Volunteer/interface.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L115) Indicates if the event is recurring. *** ### startAt > **startAt**: `string` Defined in: [src/types/Volunteer/interface.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L109) The original startAt field. *** ### startDate > **startDate**: `string` Defined in: [src/types/Volunteer/interface.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L105) The start date (mapped from startAt). *** ### title > **title**: `string` Defined in: [src/types/Volunteer/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L101) The title of the event (mapped from name). *** ### volunteerGroups > **volunteerGroups**: `object`[] Defined in: [src/types/Volunteer/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L126) Array of volunteer groups with mapped structure. #### \_id > **\_id**: `string` #### description > **description**: `string` #### name > **name**: `string` #### volunteers > **volunteers**: `object`[] #### volunteersRequired > **volunteersRequired**: `number` *** ### volunteers > **volunteers**: `object`[] Defined in: [src/types/Volunteer/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L141) Array of volunteers. #### hasAccepted > **hasAccepted**: `boolean` #### id > **id**: `string` #### user > **user**: `object` ##### user.id > **id**: `string` ##### user.name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerData Defined in: [src/types/Volunteer/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L4) Defines the structure for volunteer data used in mutations. ## Properties ### event > **event**: `string` Defined in: [src/types/Volunteer/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L6) The event ID. *** ### group > **group**: `string` Defined in: [src/types/Volunteer/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L8) The group ID, or null for individual volunteering. *** ### recurringEventInstanceId? > `optional` **recurringEventInstanceId**: `string` Defined in: [src/types/Volunteer/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L16) (Optional) Instance ID for recurring events. *** ### scope? > `optional` **scope**: `"ENTIRE_SERIES"` \| `"THIS_INSTANCE_ONLY"` Defined in: [src/types/Volunteer/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L14) (Optional) Scope for recurring events. *** ### status > **status**: `string` Defined in: [src/types/Volunteer/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L10) The status of the volunteer request. *** ### userId > **userId**: `string` Defined in: [src/types/Volunteer/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L12) The user ID of the volunteer. ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerGroupData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerGroupData Defined in: [src/types/Volunteer/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L22) Defines the structure for volunteer group data used in mutations. ## Properties ### description > **description**: `string` Defined in: [src/types/Volunteer/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L30) The description of the volunteer group. *** ### eventId > **eventId**: `string` Defined in: [src/types/Volunteer/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L24) The event ID, can be undefined for recurring events when baseEvent is used. *** ### leaderId? > `optional` **leaderId**: `string` Defined in: [src/types/Volunteer/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L26) (Optional) leader ID for the volunteer group. *** ### name > **name**: `string` Defined in: [src/types/Volunteer/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L28) The name of the volunteer group. *** ### recurringEventInstanceId? > `optional` **recurringEventInstanceId**: `string` Defined in: [src/types/Volunteer/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L38) (Optional) instance ID for recurring events. *** ### scope? > `optional` **scope**: `"ENTIRE_SERIES"` \| `"THIS_INSTANCE_ONLY"` Defined in: [src/types/Volunteer/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L36) (Optional) scope for recurring events. *** ### volunteersRequired > **volunteersRequired**: `number` Defined in: [src/types/Volunteer/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L32) The number of volunteers required, or null if not specified. *** ### volunteerUserIds > **volunteerUserIds**: `string`[] Defined in: [src/types/Volunteer/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L34) Array of user IDs for volunteer group members. ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerMembership.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerMembership Defined in: [src/types/Volunteer/interface.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L174) Defines the structure for volunteer membership information. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/types/Volunteer/interface.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L180) The creation date of the volunteer membership record. *** ### createdBy > **createdBy**: `object` Defined in: [src/types/Volunteer/interface.ts:225](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L225) The user object who created this membership. #### id > **id**: `string` The unique identifier of the creator #### name > **name**: `string` The name of the creator *** ### event > **event**: `object` Defined in: [src/types/Volunteer/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L184) The event object associated with the volunteer membership. #### endAt > **endAt**: `string` The end of the event #### id > **id**: `string` The unique identifier of the event #### name > **name**: `string` The name of the event #### recurrenceRule? > `optional` **recurrenceRule**: `object` ##### recurrenceRule.id > **id**: `string` #### startAt > **startAt**: `string` The start of the event *** ### group? > `optional` **group**: `object` Defined in: [src/types/Volunteer/interface.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L218) (Optional) The group object associated with the membership. #### id > **id**: `string` The unique identifier of the group #### name > **name**: `string` The name of the group *** ### id > **id**: `string` Defined in: [src/types/Volunteer/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L176) The unique identifier of the volunteer membership. *** ### status > **status**: `string` Defined in: [src/types/Volunteer/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L178) The status of the volunteer membership. *** ### updatedAt > **updatedAt**: `string` Defined in: [src/types/Volunteer/interface.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L182) The last update date of the volunteer membership record. *** ### updatedBy > **updatedBy**: `object` Defined in: [src/types/Volunteer/interface.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L232) The user object who last updated this membership. #### id > **id**: `string` The unique identifier of the updater #### name > **name**: `string` The name of the updater *** ### volunteer > **volunteer**: `object` Defined in: [src/types/Volunteer/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L198) The volunteer object associated with the membership. #### hasAccepted > **hasAccepted**: `boolean` Whether the volunteer has accepted #### hoursVolunteered > **hoursVolunteered**: `number` Hours volunteered #### id > **id**: `string` The unique identifier of the volunteer #### user > **user**: `object` The user information of the volunteer ##### user.avatarURL? > `optional` **avatarURL**: `string` The avatar URL of the user (optional) ##### user.emailAddress > **emailAddress**: `string` The email address of the user ##### user.id > **id**: `string` The unique identifier of the user ##### user.name > **name**: `string` The name of the user ================================================ FILE: docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerStatus.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerStatus Defined in: [src/types/Volunteer/interface.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L154) Defines the structure for volunteer status button configuration. ## Properties ### buttonText > **buttonText**: `string` Defined in: [src/types/Volunteer/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L158) The text to display on the button. *** ### buttonVariant > **buttonVariant**: `"outline-secondary"` \| `"outline-success"` \| `"outline-danger"` \| `"outline-warning"` Defined in: [src/types/Volunteer/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L160) The Bootstrap variant for the button. *** ### disabled > **disabled**: `boolean` Defined in: [src/types/Volunteer/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L166) Whether the button should be disabled. *** ### icon > **icon**: `ComponentType`\<\{ `className?`: `string`; `size?`: `number`; \}\> Defined in: [src/types/Volunteer/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L168) The icon component to display. *** ### status > **status**: `string` Defined in: [src/types/Volunteer/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L156) The status of the volunteer membership. ================================================ FILE: docs/docs/auto-docs/types/docker/type-aliases/DockerMode.md ================================================ [Admin Docs](/) *** # Type Alias: DockerMode > **DockerMode** = `"ROOTFUL"` \| `"ROOTLESS"` Defined in: [src/types/docker.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/docker.ts#L4) Docker daemon mode options ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/Element.md ================================================ [Admin Docs](/) *** # Type Alias: Element > **Element** = `ReactSource.Element` Defined in: [src/types/jsx.d.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L9) ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/ElementAttributesProperty.md ================================================ [Admin Docs](/) *** # Type Alias: ElementAttributesProperty > **ElementAttributesProperty** = `ReactSource.ElementAttributesProperty` Defined in: [src/types/jsx.d.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L11) ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/ElementChildrenAttribute.md ================================================ [Admin Docs](/) *** # Type Alias: ElementChildrenAttribute > **ElementChildrenAttribute** = `ReactSource.ElementChildrenAttribute` Defined in: [src/types/jsx.d.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L12) ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/ElementClass.md ================================================ [Admin Docs](/) *** # Type Alias: ElementClass > **ElementClass** = `ReactSource.ElementClass` Defined in: [src/types/jsx.d.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L10) ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/IntrinsicAttributes.md ================================================ [Admin Docs](/) *** # Type Alias: IntrinsicAttributes > **IntrinsicAttributes** = `ReactSource.IntrinsicAttributes` Defined in: [src/types/jsx.d.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L13) ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/IntrinsicClassAttributes.md ================================================ [Admin Docs](/) *** # Type Alias: IntrinsicClassAttributes\ > **IntrinsicClassAttributes**\<`T`\> = `ReactSource.IntrinsicClassAttributes`\<`T`\> Defined in: [src/types/jsx.d.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L15) ## Type Parameters ### T `T` ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/IntrinsicElements.md ================================================ [Admin Docs](/) *** # Type Alias: IntrinsicElements > **IntrinsicElements** = `ReactSource.IntrinsicElements` Defined in: [src/types/jsx.d.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L17) ================================================ FILE: docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/LibraryManagedAttributes.md ================================================ [Admin Docs](/) *** # Type Alias: LibraryManagedAttributes\ > **LibraryManagedAttributes**\<`TComponent`, `TProps`\> = `ReactSource.LibraryManagedAttributes`\<`TComponent`, `TProps`\> Defined in: [src/types/jsx.d.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L18) ## Type Parameters ### TComponent `TComponent` ### TProps `TProps` ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryInfo.md ================================================ [Admin Docs](/) *** # Interface: IActionItemCategoryInfo Defined 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) ## Properties ### createdAt > **createdAt**: `string` Defined 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) *** ### creatorId? > `optional` **creatorId**: `string` Defined 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) *** ### description > **description**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isDisabled > **isDisabled**: `boolean` Defined 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) *** ### name > **name**: `string` Defined 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) *** ### organizationId > **organizationId**: `string` Defined 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) *** ### updatedAt? > `optional` **updatedAt**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryList.md ================================================ [Admin Docs](/) *** # Interface: IActionItemCategoryList Defined 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) ## Properties ### actionItemCategoriesByOrganization > **actionItemCategoriesByOrganization**: [`IActionItemCategoryInfo`](IActionItemCategoryInfo.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemInfo.md ================================================ [Admin Docs](/) *** # Interface: IActionItemInfo Defined 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) ## Properties ### assignedAt > **assignedAt**: `Date` Defined 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) *** ### avatarURL? > `optional` **avatarURL**: `string` Defined 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) *** ### category > **category**: [`IActionItemCategoryInfo`](IActionItemCategoryInfo.md) Defined 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) *** ### categoryId > **categoryId**: `string` Defined 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) *** ### completionAt > **completionAt**: `Date` Defined 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) *** ### createdAt > **createdAt**: `Date` Defined 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) *** ### creator > **creator**: `IActionUserInfo` Defined 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) *** ### creatorId > **creatorId**: `string` Defined 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) *** ### event > **event**: [`IEvent`](../../../../Event/interface/interfaces/IEvent.md) Defined 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) *** ### eventId > **eventId**: `string` Defined 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) *** ### hasExceptions? > `optional` **hasExceptions**: `boolean` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isCompleted > **isCompleted**: `boolean` Defined 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) *** ### isInstanceException? > `optional` **isInstanceException**: `boolean` Defined 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) *** ### isTemplate? > `optional` **isTemplate**: `boolean` Defined 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) *** ### organizationId > **organizationId**: `string` Defined 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) *** ### postCompletionNotes > **postCompletionNotes**: `string` Defined 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) *** ### preCompletionNotes > **preCompletionNotes**: `string` Defined 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) *** ### recurringEventInstance > **recurringEventInstance**: [`IEvent`](../../../../Event/interface/interfaces/IEvent.md) Defined 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) *** ### recurringEventInstanceId > **recurringEventInstanceId**: `string` Defined 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) *** ### updatedAt > **updatedAt**: `Date` Defined 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) *** ### updaterId > **updaterId**: `string` Defined 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) *** ### volunteer > **volunteer**: `object` Defined 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) #### hasAccepted > **hasAccepted**: `boolean` #### hoursVolunteered > **hoursVolunteered**: `number` #### id > **id**: `string` #### isPublic > **isPublic**: `boolean` #### user > **user**: `object` ##### user.avatarURL? > `optional` **avatarURL**: `string` ##### user.id > **id**: `string` ##### user.name > **name**: `string` *** ### volunteerGroup > **volunteerGroup**: `object` Defined 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) #### description > **description**: `string` #### id > **id**: `string` #### leader > **leader**: `object` ##### leader.avatarURL? > `optional` **avatarURL**: `string` ##### leader.id > **id**: `string` ##### leader.name > **name**: `string` #### name > **name**: `string` #### volunteers? > `optional` **volunteers**: `object`[] #### volunteersRequired > **volunteersRequired**: `number` *** ### volunteerGroupId > **volunteerGroupId**: `string` Defined 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) *** ### volunteerId > **volunteerId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemList.md ================================================ [Admin Docs](/) *** # Interface: IActionItemList Defined 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) ## Properties ### actionItemsByOrganization > **actionItemsByOrganization**: [`IActionItemInfo`](IActionItemInfo.md)[] Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/ICreateActionItemInput.md ================================================ [Admin Docs](/) *** # Interface: ICreateActionItemInput Defined 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) ## Properties ### assignedAt? > `optional` **assignedAt**: `string` Defined 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) *** ### categoryId > **categoryId**: `string` Defined 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) *** ### eventId? > `optional` **eventId**: `string` Defined 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) *** ### isTemplate? > `optional` **isTemplate**: `boolean` Defined 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) *** ### organizationId > **organizationId**: `string` Defined 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) *** ### preCompletionNotes? > `optional` **preCompletionNotes**: `string` Defined 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) *** ### recurringEventInstanceId? > `optional` **recurringEventInstanceId**: `string` Defined 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) *** ### volunteerGroupId? > `optional` **volunteerGroupId**: `string` Defined 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) *** ### volunteerId? > `optional` **volunteerId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/ICreateActionItemVariables.md ================================================ [Admin Docs](/) *** # Interface: ICreateActionItemVariables Defined 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) ## Properties ### input > **input**: [`ICreateActionItemInput`](ICreateActionItemInput.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IDeleteActionItemInput.md ================================================ [Admin Docs](/) *** # Interface: IDeleteActionItemInput Defined 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) ## Properties ### id > **id**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IEventVolunteerGroup.md ================================================ [Admin Docs](/) *** # Interface: IEventVolunteerGroup Defined 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) ## Properties ### createdAt > **createdAt**: `string` Defined 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) *** ### creator > **creator**: `object` Defined 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) #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### description > **description**: `string` Defined 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) *** ### event > **event**: `object` Defined 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) #### id > **id**: `string` *** ### id > **id**: `string` Defined 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) *** ### isInstanceException > **isInstanceException**: `boolean` Defined 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) *** ### isTemplate > **isTemplate**: `boolean` Defined 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) *** ### leader > **leader**: `object` Defined 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) #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### name > **name**: `string` Defined 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) *** ### volunteers > **volunteers**: `object`[] Defined 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) #### hasAccepted > **hasAccepted**: `boolean` #### id > **id**: `string` #### user > **user**: `object` ##### user.avatarURL? > `optional` **avatarURL**: `string` ##### user.id > **id**: `string` ##### user.name > **name**: `string` *** ### volunteersRequired > **volunteersRequired**: `number` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IFormStateType.md ================================================ [Admin Docs](/) *** # Interface: IFormStateType Defined 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) ## Properties ### assignedAt > **assignedAt**: `Date` Defined 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) *** ### categoryId > **categoryId**: `string` Defined 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) *** ### eventId? > `optional` **eventId**: `string` Defined 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) *** ### isCompleted > **isCompleted**: `boolean` Defined 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) *** ### postCompletionNotes > **postCompletionNotes**: `string` Defined 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) *** ### preCompletionNotes > **preCompletionNotes**: `string` Defined 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) *** ### volunteerGroupId > **volunteerGroupId**: `string` Defined 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) *** ### volunteerId > **volunteerId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IItemModalProps.md ================================================ [Admin Docs](/) *** # Interface: IItemModalProps Defined 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) ## Properties ### actionItem > **actionItem**: [`IActionItemInfo`](IActionItemInfo.md) Defined 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) *** ### actionItemsRefetch() > **actionItemsRefetch**: () => `void` Defined 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) #### Returns `void` *** ### baseEvent? > `optional` **baseEvent**: `object` Defined 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) #### id > **id**: `string` *** ### editMode > **editMode**: `boolean` Defined 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) *** ### eventId > **eventId**: `string` Defined 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) *** ### hide() > **hide**: () => `void` Defined 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) #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined 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) *** ### isRecurring? > `optional` **isRecurring**: `boolean` Defined 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) *** ### orgActionItemsRefetch()? > `optional` **orgActionItemsRefetch**: () => `void` Defined 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) #### Returns `void` *** ### orgId > **orgId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IMarkActionItemAsPendingInput.md ================================================ [Admin Docs](/) *** # Interface: IMarkActionItemAsPendingInput Defined 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) ## Properties ### id > **id**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionForInstanceInput.md ================================================ [Admin Docs](/) *** # Interface: IUpdateActionForInstanceInput Defined 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) ## Properties ### actionId > **actionId**: `string` Defined 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) *** ### assignedAt? > `optional` **assignedAt**: `string` Defined 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) *** ### categoryId? > `optional` **categoryId**: `string` Defined 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) *** ### eventId? > `optional` **eventId**: `string` Defined 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) *** ### preCompletionNotes? > `optional` **preCompletionNotes**: `string` Defined 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) *** ### volunteerGroupId? > `optional` **volunteerGroupId**: `string` Defined 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) *** ### volunteerId? > `optional` **volunteerId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionItemForInstanceInput.md ================================================ [Admin Docs](/) *** # Interface: IUpdateActionItemForInstanceInput Defined 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) ## Properties ### actionId > **actionId**: `string` Defined 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) *** ### assignedAt? > `optional` **assignedAt**: `string` Defined 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) *** ### categoryId? > `optional` **categoryId**: `string` Defined 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) *** ### eventId? > `optional` **eventId**: `string` Defined 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) *** ### isCompleted? > `optional` **isCompleted**: `boolean` Defined 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) *** ### postCompletionNotes? > `optional` **postCompletionNotes**: `string` Defined 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) *** ### preCompletionNotes? > `optional` **preCompletionNotes**: `string` Defined 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) *** ### volunteerGroupId? > `optional` **volunteerGroupId**: `string` Defined 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) *** ### volunteerId? > `optional` **volunteerId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionItemForInstanceVariables.md ================================================ [Admin Docs](/) *** # Interface: IUpdateActionItemForInstanceVariables Defined 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) ## Properties ### input > **input**: [`IUpdateActionItemForInstanceInput`](IUpdateActionItemForInstanceInput.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionItemInput.md ================================================ [Admin Docs](/) *** # Interface: IUpdateActionItemInput Defined 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) ## Properties ### categoryId? > `optional` **categoryId**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isCompleted > **isCompleted**: `boolean` Defined 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) *** ### postCompletionNotes? > `optional` **postCompletionNotes**: `string` Defined 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) *** ### preCompletionNotes? > `optional` **preCompletionNotes**: `string` Defined 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) *** ### volunteerGroupId? > `optional` **volunteerGroupId**: `string` Defined 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) *** ### volunteerId? > `optional` **volunteerId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ActionsCell/interface/interfaces/InterfaceActionsCellProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceActionsCellProps\ Defined 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) Props for the ActionsCell component. Used to render per-row action buttons in a DataTable. ## Type Parameters ### T `T` The type of the row data ## Properties ### actions > **actions**: readonly [`IRowAction`](../../../DataTable/hooks/interfaces/IRowAction.md)\<`T`\>[] Defined 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) Array of action definitions *** ### row > **row**: `T` Defined 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) The row data object ================================================ FILE: docs/docs/auto-docs/types/shared-components/Auth/EmailField/interface/interfaces/InterfaceEmailFieldProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEmailFieldProps Defined 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) Props for the EmailField component. ## Remarks A specialized field for email input that composes FormField with email-specific defaults. Supports optional validator callbacks via the error prop, which accepts string or null. ## Properties ### dataCy? > `optional` **dataCy**: `string` Defined 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) Optional data-cy for e2e (Cypress) selectors *** ### error? > `optional` **error**: `string` Defined 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) Error message to display - null or undefined means no error *** ### label? > `optional` **label**: `string` Defined 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) Optional label text displayed above the input - defaults to "Email" *** ### name? > `optional` **name**: `string` Defined 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) Name attribute for the input field - defaults to "email" *** ### onChange() > **onChange**: (`e`) => `void` Defined 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) Change handler called when input value changes #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### placeholder? > `optional` **placeholder**: `string` Defined 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) Placeholder text for the input - defaults to "name@example.com" *** ### testId? > `optional` **testId**: `string` Defined 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) Test ID for testing purposes *** ### value > **value**: `string` Defined 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) Current email input value ================================================ FILE: docs/docs/auto-docs/types/shared-components/Auth/FormField/interface/interfaces/InterfaceFormFieldProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormFieldProps Defined 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) Props for the FormField component. ## Remarks Supports optional validator callbacks and aria-live behaviors for accessibility. ## Properties ### ariaLive? > `optional` **ariaLive**: `boolean` Defined 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) Whether to use aria-live for dynamic error announcements. When true, error messages are announced to screen readers. Defaults to true. *** ### dataCy? > `optional` **dataCy**: `string` Defined 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) Optional data-cy for e2e (Cypress) selectors *** ### disabled? > `optional` **disabled**: `boolean` Defined 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) Whether the input is disabled *** ### error? > `optional` **error**: `string` Defined 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) Error message to display - null or undefined means no error *** ### helperText? > `optional` **helperText**: `string` Defined 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) Helper text to display below the input when no error *** ### label? > `optional` **label**: `string` Defined 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) Optional label text displayed above the input *** ### name > **name**: `string` Defined 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) Name attribute for the input field (required for form handling) *** ### onBlur()? > `optional` **onBlur**: (`e`) => `void` Defined 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) Blur handler called when input loses focus #### Parameters ##### e `FocusEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### onChange() > **onChange**: (`e`) => `void` Defined 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) Change handler called when input value changes #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### placeholder? > `optional` **placeholder**: `string` Defined 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) Placeholder text for the input *** ### required? > `optional` **required**: `boolean` Defined 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) Whether the field is required - shows asterisk if true *** ### testId? > `optional` **testId**: `string` Defined 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) Test ID for testing purposes *** ### type? > `optional` **type**: `"text"` \| `"email"` \| `"password"` \| `"tel"` Defined 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) Input type - defaults to 'text' *** ### value > **value**: `string` Defined 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) Current input value ================================================ FILE: docs/docs/auto-docs/types/shared-components/Auth/PasswordField/interface/interfaces/InterfacePasswordFieldProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePasswordFieldProps Defined 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) Props interface for the PasswordField component. Extends basic form field functionality with password visibility toggle features. ## Properties ### dataCy? > `optional` **dataCy**: `string` Defined 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) Optional data-cy for e2e (Cypress) selectors *** ### error? > `optional` **error**: `string` Defined 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) *** ### label? > `optional` **label**: `string` Defined 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) *** ### name? > `optional` **name**: `string` Defined 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) *** ### onChange() > **onChange**: (`e`) => `void` Defined 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) #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### onToggleVisibility()? > `optional` **onToggleVisibility**: () => `void` Defined 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) #### Returns `void` *** ### placeholder? > `optional` **placeholder**: `string` Defined 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) *** ### showPassword? > `optional` **showPassword**: `boolean` Defined 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) *** ### testId? > `optional` **testId**: `string` Defined 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) *** ### value > **value**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/Avatar/interface/interfaces/InterfaceAvatarProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAvatarProps Defined 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) ## Properties ### alt? > `optional` **alt**: `string` Defined 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) *** ### avatarStyle? > `optional` **avatarStyle**: `string` Defined 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) *** ### containerStyle? > `optional` **containerStyle**: `string` Defined 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) *** ### dataTestId? > `optional` **dataTestId**: `string` Defined 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) *** ### name? > `optional` **name**: `string` Defined 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) *** ### radius? > `optional` **radius**: `number` Defined 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) *** ### size? > `optional` **size**: `number` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/BaseModal/interface/interfaces/IBaseModalProps.md ================================================ [Admin Docs](/) *** # Interface: IBaseModalProps Defined 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) BaseModal component props. A reusable modal wrapper component that standardizes modal structure across the Talawa Admin application. Provides consistent header, body, and footer layouts while reducing boilerplate code. ## Remarks Props: - show: Controls modal visibility. - onHide: Callback when modal is closed via X button, backdrop click, or Escape key. - title: Modal title displayed in header (uses i18n keys). - headerContent: Custom header content that overrides the default title and close button. - children: Modal body content. - footer: Optional footer content with action buttons. - size: Modal size variant: sm, lg, xl. - centered: Whether to vertically center the modal. - backdrop: Backdrop behavior: static prevents close on click, true allows it, false hides backdrop. - keyboard: Whether the modal can be closed by pressing the Escape key. - className: Additional CSS classes for the modal container. - showCloseButton: Whether to show the close button in the header. - closeButtonVariant: Bootstrap button variant for the close button. - headerClassName: Additional CSS classes for the modal header. - headerTestId: Test ID for the modal header. - bodyClassName: Additional CSS classes for the modal body. - footerClassName: Additional CSS classes for the modal footer. - dataTestId: Test ID for automated testing. - id: Optional HTML id attribute for the modal container element. ## Properties ### backdrop? > `optional` **backdrop**: `boolean` \| `"static"` Defined 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) *** ### bodyClassName? > `optional` **bodyClassName**: `string` Defined 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) *** ### centered? > `optional` **centered**: `boolean` Defined 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) *** ### children > **children**: `ReactNode` Defined 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) *** ### className? > `optional` **className**: `string` Defined 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) *** ### closeButtonVariant? > `optional` **closeButtonVariant**: `string` Defined 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) *** ### dataTestId? > `optional` **dataTestId**: `string` Defined 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) *** ### footer? > `optional` **footer**: `ReactNode` Defined 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) *** ### footerClassName? > `optional` **footerClassName**: `string` Defined 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) *** ### headerClassName? > `optional` **headerClassName**: `string` Defined 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) *** ### headerContent? > `optional` **headerContent**: `ReactNode` Defined 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) *** ### headerTestId? > `optional` **headerTestId**: `string` Defined 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) *** ### id? > `optional` **id**: `string` Defined 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) *** ### keyboard? > `optional` **keyboard**: `boolean` Defined 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) *** ### onHide() > **onHide**: () => `void` Defined 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) #### Returns `void` *** ### show > **show**: `boolean` Defined 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) *** ### showCloseButton? > `optional` **showCloseButton**: `boolean` Defined 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) *** ### size? > `optional` **size**: `"sm"` \| `"lg"` \| `"xl"` Defined 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) *** ### title? > `optional` **title**: `ReactNode` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/BreadcrumbsComponent/interface/interfaces/IBreadcrumbItem.md ================================================ [Admin Docs](/) *** # Interface: IBreadcrumbItem Defined 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) Interface for individual breadcrumb items. Supports i18n via translation keys, optional navigation, and current page marking for accessibility. ## Properties ### isCurrent? > `optional` **isCurrent**: `boolean` Defined 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) Marks the breadcrumb as the current page. #### Remarks - This flag is optional and evaluated at runtime by the BreadcrumbsComponent. - If omitted, the component treats the last breadcrumb item as current by convention. - If multiple items are marked `isCurrent: true`, the first encountered item will be rendered as the active breadcrumb. Applies `aria-current="page"` for accessibility. *** ### label? > `optional` **label**: `string` Defined 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) Fallback label when no translation key is provided. *** ### to? > `optional` **to**: `string` Defined 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) Navigation path for React Router `Link`. If omitted, breadcrumb is rendered as plain text. *** ### translationKey? > `optional` **translationKey**: `string` Defined 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) i18n translation key for the breadcrumb label. Takes precedence over `label` if provided. ================================================ FILE: docs/docs/auto-docs/types/shared-components/BreadcrumbsComponent/interface/interfaces/IBreadcrumbsComponentProps.md ================================================ [Admin Docs](/) *** # Interface: IBreadcrumbsComponentProps Defined 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) Props for the BreadcrumbsComponent. ## Properties ### ariaLabelTranslationKey? > `optional` **ariaLabelTranslationKey**: `string` Defined 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) Optional aria-label translation key for the navigation landmark. #### Remarks - Key is resolved from the `common` i18n namespace. - Defaults to `'breadcrumbs'` (i.e., `common.breadcrumbs`). *** ### items > **items**: [`IBreadcrumbItem`](IBreadcrumbItem.md)[] Defined 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) List of breadcrumb items to render. ================================================ FILE: docs/docs/auto-docs/types/shared-components/BulkActionsBar/interface/interfaces/InterfaceBulkActionsBarProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceBulkActionsBarProps Defined 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) Props for the BulkActionsBar component. Used to display a toolbar when rows are selected in a DataTable. ## Properties ### children > **children**: `ReactNode` Defined 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) Bulk action buttons to render *** ### count > **count**: `number` Defined 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) Number of selected rows *** ### onClear() > **onClear**: () => `void` Defined 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) Callback to clear selection #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceCRUDModalTemplateProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCRUDModalTemplateProps Defined 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) Props for the base CRUDModalTemplate component This is the foundation component that all specialized modal templates build upon. ## Extends - [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md) ## Properties ### centered? > `optional` **centered**: `boolean` Defined 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) Whether to center the modal vertically on the page #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered) *** ### children? > `optional` **children**: `ReactNode` Defined 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) Content to render inside the modal body *** ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name for the modal #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname) *** ### customFooter? > `optional` **customFooter**: `ReactNode` Defined 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) Custom footer content to replace the default action buttons When provided, primaryText, secondaryText, and onPrimary are ignored *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for the modal container (useful for testing) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid) *** ### error? > `optional` **error**: `string` Defined 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) Error message to display in the modal body When provided, shows an Alert component with the error #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error) *** ### hideSecondary? > `optional` **hideSecondary**: `boolean` Defined 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) Whether to hide the secondary (cancel) button *** ### loading? > `optional` **loading**: `boolean` Defined 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) Indicates whether an async operation is in progress When true, displays a loading spinner and disables action buttons #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading) *** ### onClose() > **onClose**: () => `void` Defined 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) Callback function invoked when the modal is closed Triggered by close button, backdrop click, or Escape key #### Returns `void` #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose) *** ### onPrimary()? > `optional` **onPrimary**: () => `void` Defined 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) Callback function for the primary action button If not provided, the primary button will not be rendered #### Returns `void` *** ### open? > `optional` **open**: `boolean` Defined 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) Controls whether the modal is visible (defaults to false) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open) *** ### primaryDisabled? > `optional` **primaryDisabled**: `boolean` Defined 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) Whether to disable the primary button Automatically disabled when loading is true *** ### primaryText? > `optional` **primaryText**: `string` Defined 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) Text for the primary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext) *** ### primaryVariant? > `optional` **primaryVariant**: `"primary"` \| `"success"` \| `"danger"` Defined 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) Variant style for the primary button *** ### secondaryText? > `optional` **secondaryText**: `string` Defined 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) Text for the secondary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext) *** ### showFooter? > `optional` **showFooter**: `boolean` Defined 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) Whether to show the modal footer at all *** ### size? > `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md) Defined 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) Modal size variant #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size) *** ### title > **title**: `string` Defined 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) Modal title displayed in the header #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceCreateModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreateModalProps Defined 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) Props for CreateModal template Specialized template for creating new entities with form submission. ## Extends - [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md) ## Properties ### centered? > `optional` **centered**: `boolean` Defined 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) Whether to center the modal vertically on the page #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered) *** ### children > **children**: `ReactNode` Defined 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) Form content to render inside the modal body *** ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name for the modal #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname) *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for the modal container (useful for testing) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid) *** ### error? > `optional` **error**: `string` Defined 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) Error message to display in the modal body When provided, shows an Alert component with the error #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error) *** ### loading? > `optional` **loading**: `boolean` Defined 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) Indicates whether an async operation is in progress When true, displays a loading spinner and disables action buttons #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading) *** ### onClose() > **onClose**: () => `void` Defined 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) Callback function invoked when the modal is closed Triggered by close button, backdrop click, or Escape key #### Returns `void` #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose) *** ### onSubmit() > **onSubmit**: (`event`) => `void` \| `Promise`\<`void`\> Defined 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) Callback function invoked when the form is submitted Should handle the creation logic and return a Promise #### Parameters ##### event `FormEvent`\<`HTMLFormElement`\> #### Returns `void` \| `Promise`\<`void`\> *** ### open? > `optional` **open**: `boolean` Defined 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) Controls whether the modal is visible (defaults to false) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open) *** ### primaryText? > `optional` **primaryText**: `string` Defined 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) Text for the primary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext) *** ### secondaryText? > `optional` **secondaryText**: `string` Defined 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) Text for the secondary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext) *** ### size? > `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md) Defined 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) Modal size variant #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size) *** ### submitDisabled? > `optional` **submitDisabled**: `boolean` Defined 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) Whether the submit button should be disabled Useful for form validation *** ### title > **title**: `string` Defined 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) Modal title displayed in the header #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceCrudModalBaseProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCrudModalBaseProps Defined 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) Base props shared by all CRUD modal templates These properties are common across all modal types and provide the fundamental functionality for opening, closing, and displaying modals. ## Extended by - [`InterfaceCRUDModalTemplateProps`](InterfaceCRUDModalTemplateProps.md) - [`InterfaceCreateModalProps`](InterfaceCreateModalProps.md) - [`InterfaceEditModalProps`](InterfaceEditModalProps.md) - [`InterfaceDeleteModalProps`](InterfaceDeleteModalProps.md) - [`InterfaceViewModalProps`](InterfaceViewModalProps.md) ## Properties ### centered? > `optional` **centered**: `boolean` Defined 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) Whether to center the modal vertically on the page *** ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name for the modal *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for the modal container (useful for testing) *** ### error? > `optional` **error**: `string` Defined 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) Error message to display in the modal body When provided, shows an Alert component with the error *** ### loading? > `optional` **loading**: `boolean` Defined 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) Indicates whether an async operation is in progress When true, displays a loading spinner and disables action buttons *** ### onClose() > **onClose**: () => `void` Defined 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) Callback function invoked when the modal is closed Triggered by close button, backdrop click, or Escape key #### Returns `void` *** ### open? > `optional` **open**: `boolean` Defined 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) Controls whether the modal is visible (defaults to false) *** ### primaryText? > `optional` **primaryText**: `string` Defined 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) Text for the primary action button *** ### secondaryText? > `optional` **secondaryText**: `string` Defined 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) Text for the secondary action button *** ### size? > `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md) Defined 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) Modal size variant *** ### title > **title**: `string` Defined 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) Modal title displayed in the header ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceDeleteModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDeleteModalProps Defined 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) Props for DeleteModal template Specialized template for delete confirmation dialogs. ## Extends - [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md) ## Properties ### centered? > `optional` **centered**: `boolean` Defined 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) Whether to center the modal vertically on the page #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered) *** ### children? > `optional` **children**: `ReactNode` Defined 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) Optional custom content to display in the modal body If not provided, shows the confirmationMessage *** ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name for the modal #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname) *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for the modal container (useful for testing) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid) *** ### entityName? > `optional` **entityName**: `string` Defined 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) Name of the entity being deleted (for display purposes) When provided, will be shown in the confirmation message *** ### error? > `optional` **error**: `string` Defined 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) Error message to display in the modal body When provided, shows an Alert component with the error #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error) *** ### loading? > `optional` **loading**: `boolean` Defined 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) Indicates whether an async operation is in progress When true, displays a loading spinner and disables action buttons #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading) *** ### onClose() > **onClose**: () => `void` Defined 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) Callback function invoked when the modal is closed Triggered by close button, backdrop click, or Escape key #### Returns `void` #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose) *** ### onDelete() > **onDelete**: () => `void` \| `Promise`\<`void`\> Defined 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) Callback function invoked when deletion is confirmed Should handle the delete logic and return a Promise #### Returns `void` \| `Promise`\<`void`\> *** ### open? > `optional` **open**: `boolean` Defined 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) Controls whether the modal is visible (defaults to false) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open) *** ### primaryText? > `optional` **primaryText**: `string` Defined 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) Text for the primary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext) *** ### recurringEventContent? > `optional` **recurringEventContent**: `ReactNode` Defined 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) Optional content to display for recurring event support Allows users to choose between deleting series or single instance *** ### secondaryText? > `optional` **secondaryText**: `string` Defined 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) Text for the secondary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext) *** ### showWarning? > `optional` **showWarning**: `boolean` Defined 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) Whether to show warning styling (danger variant) *** ### size? > `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md) Defined 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) Modal size variant #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size) *** ### title > **title**: `string` Defined 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) Modal title displayed in the header #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceEditModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEditModalProps Defined 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) Props for EditModal template Specialized template for editing existing entities. Parent component handles data fetching and passes pre-populated form fields as children. ## Extends - [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md) ## Properties ### centered? > `optional` **centered**: `boolean` Defined 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) Whether to center the modal vertically on the page #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered) *** ### children > **children**: `ReactNode` Defined 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) Form content to render inside the modal body Parent should pass form fields pre-populated with entity data *** ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name for the modal #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname) *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for the modal container (useful for testing) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid) *** ### error? > `optional` **error**: `string` Defined 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) Error message to display in the modal body When provided, shows an Alert component with the error #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error) *** ### loading? > `optional` **loading**: `boolean` Defined 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) Indicates whether an async operation is in progress When true, displays a loading spinner and disables action buttons #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading) *** ### loadingData? > `optional` **loadingData**: `boolean` Defined 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) Whether data is currently being loaded Shows a loading state while fetching entity data *** ### onClose() > **onClose**: () => `void` Defined 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) Callback function invoked when the modal is closed Triggered by close button, backdrop click, or Escape key #### Returns `void` #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose) *** ### onSubmit() > **onSubmit**: (`event`) => `void` \| `Promise`\<`void`\> Defined 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) Callback function invoked when the form is submitted Should handle the update logic and return a Promise #### Parameters ##### event `FormEvent`\<`HTMLFormElement`\> #### Returns `void` \| `Promise`\<`void`\> *** ### open? > `optional` **open**: `boolean` Defined 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) Controls whether the modal is visible (defaults to false) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open) *** ### primaryText? > `optional` **primaryText**: `string` Defined 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) Text for the primary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext) *** ### secondaryText? > `optional` **secondaryText**: `string` Defined 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) Text for the secondary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext) *** ### size? > `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md) Defined 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) Modal size variant #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size) *** ### submitDisabled? > `optional` **submitDisabled**: `boolean` Defined 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) Whether the submit button should be disabled Useful for dirty form checking *** ### title > **title**: `string` Defined 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) Modal title displayed in the header #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceModalFormState.md ================================================ [Admin Docs](/) *** # Interface: InterfaceModalFormState Defined 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) Common form state for modals Helper type for managing form state in modal components ## Properties ### errors? > `optional` **errors**: `Record`\<`string`, `string`\> Defined 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) Form validation errors *** ### isDirty? > `optional` **isDirty**: `boolean` Defined 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) Whether the form has unsaved changes *** ### isSubmitting? > `optional` **isSubmitting**: `boolean` Defined 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) Whether the form is currently being submitted ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceRecurringEventProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurringEventProps Defined 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) Props for recurring event pattern support Common pattern for modals that handle recurring events ## Properties ### applyTo? > `optional` **applyTo**: `"series"` \| `"instance"` Defined 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) Current selection: apply to entire series or single instance *** ### baseEventId? > `optional` **baseEventId**: `string` Defined 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) Base event ID for recurring series *** ### isRecurring? > `optional` **isRecurring**: `boolean` Defined 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) Whether the event is recurring *** ### onApplyToChange()? > `optional` **onApplyToChange**: (`value`) => `void` Defined 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) Callback when applyTo selection changes #### Parameters ##### value `"series"` | `"instance"` #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseFormModalReturn.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUseFormModalReturn\ Defined 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) Return type for useFormModal hook ## Extends - [`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md) ## Extended by - [`InterfaceUseMutationModalReturn`](InterfaceUseMutationModalReturn.md) ## Type Parameters ### T `T` ## Properties ### close() > **close**: () => `void` Defined 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) Closes the modal #### Returns `void` #### Inherited from [`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`close`](InterfaceUseModalStateReturn.md#close) *** ### formData > **formData**: `T` Defined 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) Form data being edited *** ### isOpen > **isOpen**: `boolean` Defined 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) Whether the modal is currently open #### Inherited from [`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`isOpen`](InterfaceUseModalStateReturn.md#isopen) *** ### isSubmitting > **isSubmitting**: `boolean` Defined 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) Whether the form is currently submitting *** ### open() > **open**: () => `void` Defined 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) Opens the modal #### Returns `void` #### Inherited from [`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`open`](InterfaceUseModalStateReturn.md#open) *** ### openWithData() > **openWithData**: (`data`) => `void` Defined 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) Sets the form data and opens the modal #### Parameters ##### data `T` #### Returns `void` *** ### reset() > **reset**: () => `void` Defined 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) Resets form data and closes the modal #### Returns `void` *** ### setIsSubmitting() > **setIsSubmitting**: (`value`) => `void` Defined 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) Sets the submitting state #### Parameters ##### value `boolean` #### Returns `void` *** ### toggle() > **toggle**: () => `void` Defined 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) Toggles the modal open/close state #### Returns `void` #### Inherited from [`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`toggle`](InterfaceUseModalStateReturn.md#toggle) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseModalStateReturn.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUseModalStateReturn Defined 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) Return type for useModalState hook ## Extended by - [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md) ## Properties ### close() > **close**: () => `void` Defined 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) Closes the modal #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined 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) Whether the modal is currently open *** ### open() > **open**: () => `void` Defined 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) Opens the modal #### Returns `void` *** ### toggle() > **toggle**: () => `void` Defined 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) Toggles the modal open/close state #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseMutationModalReturn.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUseMutationModalReturn\ Defined 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) Return type for useMutationModal hook ## Extends - [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md)\<`TData`\> ## Type Parameters ### TData `TData` ### TResult `TResult` = `unknown` ## Properties ### clearError() > **clearError**: () => `void` Defined 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) Clears the error state #### Returns `void` *** ### close() > **close**: () => `void` Defined 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) Closes the modal #### Returns `void` #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`close`](InterfaceUseFormModalReturn.md#close) *** ### error > **error**: `Error` Defined 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) Error from the last mutation attempt *** ### execute() > **execute**: (`data?`) => `Promise`\<`TResult`\> Defined 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) Executes the mutation with current form data #### Parameters ##### data? `TData` #### Returns `Promise`\<`TResult`\> *** ### formData > **formData**: `TData` Defined 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) Form data being edited #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`formData`](InterfaceUseFormModalReturn.md#formdata) *** ### isOpen > **isOpen**: `boolean` Defined 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) Whether the modal is currently open #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`isOpen`](InterfaceUseFormModalReturn.md#isopen) *** ### isSubmitting > **isSubmitting**: `boolean` Defined 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) Whether the form is currently submitting #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`isSubmitting`](InterfaceUseFormModalReturn.md#issubmitting) *** ### open() > **open**: () => `void` Defined 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) Opens the modal #### Returns `void` #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`open`](InterfaceUseFormModalReturn.md#open) *** ### openWithData() > **openWithData**: (`data`) => `void` Defined 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) Sets the form data and opens the modal #### Parameters ##### data `TData` #### Returns `void` #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`openWithData`](InterfaceUseFormModalReturn.md#openwithdata) *** ### reset() > **reset**: () => `void` Defined 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) Resets form data and closes the modal #### Returns `void` #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`reset`](InterfaceUseFormModalReturn.md#reset) *** ### setIsSubmitting() > **setIsSubmitting**: (`value`) => `void` Defined 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) Sets the submitting state #### Parameters ##### value `boolean` #### Returns `void` #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`setIsSubmitting`](InterfaceUseFormModalReturn.md#setissubmitting) *** ### toggle() > **toggle**: () => `void` Defined 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) Toggles the modal open/close state #### Returns `void` #### Inherited from [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`toggle`](InterfaceUseFormModalReturn.md#toggle) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceViewModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceViewModalProps Defined 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) Props for ViewModal template Specialized template for read-only entity display. Parent component handles data fetching and passes formatted content as children. ## Extends - [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md) ## Properties ### centered? > `optional` **centered**: `boolean` Defined 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) Whether to center the modal vertically on the page #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered) *** ### children > **children**: `ReactNode` Defined 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) Content to display in the modal body Parent should pass formatted data display as children *** ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name for the modal #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname) *** ### customActions? > `optional` **customActions**: `ReactNode` Defined 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) Optional custom action buttons to display in the footer Useful for actions like "Edit" or "Delete" from the view modal *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for the modal container (useful for testing) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid) *** ### error? > `optional` **error**: `string` Defined 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) Error message to display in the modal body When provided, shows an Alert component with the error #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error) *** ### loading? > `optional` **loading**: `boolean` Defined 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) Indicates whether an async operation is in progress When true, displays a loading spinner and disables action buttons #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading) *** ### loadingData? > `optional` **loadingData**: `boolean` Defined 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) Whether data is currently being loaded *** ### onClose() > **onClose**: () => `void` Defined 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) Callback function invoked when the modal is closed Triggered by close button, backdrop click, or Escape key #### Returns `void` #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose) *** ### open? > `optional` **open**: `boolean` Defined 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) Controls whether the modal is visible (defaults to false) #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open) *** ### primaryText? > `optional` **primaryText**: `string` Defined 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) Text for the primary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext) *** ### secondaryText? > `optional` **secondaryText**: `string` Defined 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) Text for the secondary action button #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext) *** ### size? > `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md) Defined 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) Modal size variant #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size) *** ### title > **title**: `string` Defined 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) Modal title displayed in the header #### Inherited from [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/type-aliases/ModalSize.md ================================================ [Admin Docs](/) *** # Type Alias: ModalSize > **ModalSize** = `"sm"` \| `"lg"` \| `"xl"` Defined 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) Size variants for modals ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceAttendeeCheckIn.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAttendeeCheckIn Defined 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) ## Properties ### checkInTime > **checkInTime**: `string` Defined 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) *** ### checkOutTime > **checkOutTime**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isCheckedIn > **isCheckedIn**: `boolean` Defined 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) *** ### isCheckedOut > **isCheckedOut**: `boolean` Defined 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) *** ### user > **user**: [`InterfaceUser`](InterfaceUser.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceAttendeeQueryResponse.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAttendeeQueryResponse Defined 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) ## Properties ### event > **event**: `object` Defined 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) #### attendeesCheckInStatus > **attendeesCheckInStatus**: [`InterfaceAttendeeCheckIn`](InterfaceAttendeeCheckIn.md)[] #### id > **id**: `string` ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceModalProp.md ================================================ [Admin Docs](/) *** # Interface: InterfaceModalProp Defined 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) ## Properties ### eventId > **eventId**: `string` Defined 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) *** ### handleClose() > **handleClose**: () => `void` Defined 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) #### Returns `void` *** ### onCheckInUpdate()? > `optional` **onCheckInUpdate**: () => `void` Defined 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) #### Returns `void` *** ### show > **show**: `boolean` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceTableCheckIn.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTableCheckIn Defined 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) ## Properties ### checkInTime > **checkInTime**: `string` Defined 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) *** ### checkOutTime > **checkOutTime**: `string` Defined 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) *** ### eventId > **eventId**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isCheckedIn > **isCheckedIn**: `boolean` Defined 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) *** ### isCheckedOut > **isCheckedOut**: `boolean` Defined 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) *** ### isRecurring? > `optional` **isRecurring**: `boolean` Defined 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) *** ### name > **name**: `string` Defined 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) *** ### userId > **userId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceTableData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTableData Defined 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) ## Properties ### checkInData > **checkInData**: [`InterfaceTableCheckIn`](InterfaceTableCheckIn.md) Defined 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) *** ### id > **id**: `string` Defined 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) *** ### userName > **userName**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceUser.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUser Defined 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) ## Properties ### emailAddress > **emailAddress**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/type/type-aliases/CheckIn.md ================================================ [Admin Docs](/) *** # Type Alias: CheckIn > **CheckIn** = `object` Defined 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) ## Properties ### \_id > **\_id**: `string` Defined 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) *** ### allotedRoom? > `optional` **allotedRoom**: `string` Defined 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) *** ### allotedSeat? > `optional` **allotedSeat**: `string` Defined 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) *** ### createdAt > **createdAt**: `Date` Defined 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) *** ### event > **event**: [`Event`](../../../../Event/type/type-aliases/Event.md) Defined 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) *** ### feedbackSubmitted > **feedbackSubmitted**: `boolean` Defined 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) *** ### time > **time**: `Date` Defined 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) *** ### updatedAt > **updatedAt**: `Date` Defined 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) *** ### user > **user**: [`User`](../../../User/type/type-aliases/User.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/type/type-aliases/CheckInInput.md ================================================ [Admin Docs](/) *** # Type Alias: CheckInInput > **CheckInInput** = `object` Defined 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) ## Properties ### allotedRoom? > `optional` **allotedRoom**: `string` Defined 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) *** ### allotedSeat? > `optional` **allotedSeat**: `string` Defined 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) *** ### eventId > **eventId**: `string` Defined 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) *** ### userId > **userId**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckIn/type/type-aliases/CheckInStatus.md ================================================ [Admin Docs](/) *** # Type Alias: CheckInStatus > **CheckInStatus** = `object` Defined 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) ## Properties ### \_id > **\_id**: `string` Defined 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) *** ### checkIn? > `optional` **checkIn**: [`CheckIn`](CheckIn.md) Defined 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) *** ### user > **user**: [`User`](../../../User/type/type-aliases/User.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/CheckInWrapper/interface/interfaces/InterfaceCheckInWrapperProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCheckInWrapperProps Defined 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) Props for CheckInWrapper component. ## Properties ### eventId > **eventId**: `string` Defined 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) The unique identifier of the event for which members are being checked in. *** ### onCheckInUpdate()? > `optional` **onCheckInUpdate**: () => `void` Defined 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) Optional callback invoked after check-in updates. #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/column/interfaces/IColumnDef.md ================================================ [Admin Docs](/) *** # Interface: IColumnDef\ Defined 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) Column definition for DataTable. Specifies how a column should render, behave, and interact with sorting, filtering, and searching. Each column maps to a specific property or accessor within row data. ## Type Parameters ### T `T` The type of data for each row in the table ### TValue `TValue` = `unknown` The type of the value extracted by the accessor (defaults to unknown) ## Properties ### accessor > **accessor**: [`Accessor`](../../types/type-aliases/Accessor.md)\<`T`, `TValue`\> Defined 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) Accessor function or key to extract the value from row data *** ### header > **header**: [`HeaderRender`](../../types/type-aliases/HeaderRender.md) Defined 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) Column header text or React component to render *** ### id > **id**: `string` Defined 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) Unique identifier for this column *** ### meta? > `optional` **meta**: `object` Defined 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) Metadata and configuration for column behavior. #### align? > `optional` **align**: `"left"` \| `"right"` \| `"center"` Text alignment for cell content ('left', 'center', or 'right') #### ariaLabel? > `optional` **ariaLabel**: `string` ARIA label for accessibility when header content is not descriptive #### filterable? > `optional` **filterable**: `boolean` Whether this column supports filtering (default: false) #### filterFn()? > `optional` **filterFn**: (`row`, `value`) => `boolean` Custom filter predicate to match rows against a filter value. ##### Parameters ###### row `T` Row to evaluate ###### value `unknown` Filter value to match against ##### Returns `boolean` true if row matches the filter #### getSearchValue()? > `optional` **getSearchValue**: (`row`) => `string` Custom function to extract searchable text from a row. Used when performing global search on this column. ##### Parameters ###### row `T` Row data to extract search value from ##### Returns `string` String representation for search matching #### searchable? > `optional` **searchable**: `boolean` Whether this column is included in global search (default: false) #### sortable? > `optional` **sortable**: `boolean` Whether this column supports sorting (default: true) #### sortFn()? > `optional` **sortFn**: (`a`, `b`) => `number` Custom comparator function for sorting this column. ##### Parameters ###### a `T` First row for comparison ###### b `T` Second row for comparison ##### Returns `number` Negative if a \< b, 0 if equal, positive if a \> b #### width? > `optional` **width**: `string` \| `number` CSS width for this column (e.g., '100px', '20%') *** ### render()? > `optional` **render**: (`value`, `row`) => `ReactNode` Defined 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) Optional custom render function for cell values. Receives the extracted value and the full row data. #### Parameters ##### value `TValue` The value extracted by the accessor ##### row `T` The complete row data object #### Returns `ReactNode` React node to render in the cell ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IBulkAction.md ================================================ [Admin Docs](/) *** # Interface: IBulkAction\ Defined 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) Configuration for an action available on bulk-selected rows. Bulk actions operate on multiple selected rows at once and typically involve server mutations or data processing. ## Type Parameters ### T `T` The type of row data this action operates on ## Properties ### confirm? > `optional` **confirm**: `string` Defined 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) Optional confirmation message to display before executing the action *** ### disabled? > `optional` **disabled**: `boolean` \| (`rows`, `keys`) => `boolean` Defined 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) Whether this action is disabled for the current selection. Can be a boolean or a function that evaluates the selection. #### Param Array of selected rows #### Param Array of keys for the selected rows *** ### id > **id**: `string` Defined 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) Unique identifier for this action *** ### label > **label**: `string` Defined 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) Display label for the bulk action button *** ### onClick() > **onClick**: (`rows`, `keys`) => `void` \| `Promise`\<`void`\> Defined 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) Callback fired when the bulk action is triggered. Can be async to support server operations. #### Parameters ##### rows `T`[] Array of selected rows ##### keys [`Key`](../../types/type-aliases/Key.md)[] Array of keys for the selected rows #### Returns `void` \| `Promise`\<`void`\> `void` or `Promise` if async ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IRowAction.md ================================================ [Admin Docs](/) *** # Interface: IRowAction\ Defined 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) Configuration for an action available on individual table rows. Row actions appear as contextual buttons or menu items for each row, allowing users to perform operations on specific row data. ## Type Parameters ### T `T` The type of row data this action operates on ## Properties ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) ARIA label for accessibility when label alone is not descriptive *** ### disabled? > `optional` **disabled**: `boolean` \| (`row`) => `boolean` Defined 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) Whether this action is disabled. Can be a boolean or a function that evaluates the row to determine disabled state. *** ### id > **id**: `string` Defined 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) Unique identifier for this action *** ### label > **label**: `string` Defined 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) Display label for the action button or menu item *** ### onClick() > **onClick**: (`row`) => `void` Defined 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) Callback fired when the action is triggered on a row. #### Parameters ##### row `T` The row data the action was triggered for #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseDataTableFilteringOptions.md ================================================ [Admin Docs](/) *** # Interface: IUseDataTableFilteringOptions\ Defined 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) Configuration options for table data filtering and search functionality. Provides comprehensive filtering capabilities including global search across all rows, per-column filtering, and control over client-side vs server-side filtering behavior. Supports pagination mode detection to manage page reset behavior during filtering. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### columnFilters? > `optional` **columnFilters**: `Record`\<`string`, `unknown`\> Defined 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) Record of column-specific filter values, keyed by column ID *** ### columns > **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\>[] Defined 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) Column definitions that determine which columns are searchable or filterable *** ### data? > `optional` **data**: `T`[] Defined 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) Array of row data to filter and search *** ### globalSearch? > `optional` **globalSearch**: `string` Defined 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) Current global search query string to match against row data *** ### initialGlobalSearch? > `optional` **initialGlobalSearch**: `string` Defined 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) Initial value for global search query, used on mount *** ### onColumnFiltersChange()? > `optional` **onColumnFiltersChange**: (`filters`) => `void` Defined 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) Callback fired when column filters change, receives updated filter record #### Parameters ##### filters `Record`\<`string`, `unknown`\> #### Returns `void` *** ### onGlobalSearchChange()? > `optional` **onGlobalSearchChange**: (`q`) => `void` Defined 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) Callback fired when global search query changes, receives new query string #### Parameters ##### q `string` #### Returns `void` *** ### onPageReset()? > `optional` **onPageReset**: () => `void` Defined 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) Callback to reset pagination to first page when filters change #### Returns `void` *** ### paginationMode? > `optional` **paginationMode**: `"client"` \| `"server"` \| `"none"` Defined 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) Current pagination mode: 'client' for local paging, 'server' for remote paging, 'none' for no pagination *** ### serverFilter? > `optional` **serverFilter**: `boolean` Defined 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) Whether column filtering is handled server-side instead of client-side *** ### serverSearch? > `optional` **serverSearch**: `boolean` Defined 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) Whether search functionality is handled server-side instead of client-side ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseDataTableSelectionOptions.md ================================================ [Admin Docs](/) *** # Interface: IUseDataTableSelectionOptions\ Defined 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) Configuration options for row selection in a DataTable. Controls how rows can be selected, which rows are selectable, and provides callbacks for selection changes and bulk actions. ## Type Parameters ### T `T` The type of row data in the table ## Properties ### bulkActions? > `optional` **bulkActions**: readonly [`IBulkAction`](IBulkAction.md)\<`T`\>[] Defined 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) Array of bulk actions available for selected rows *** ### initialSelectedKeys? > `optional` **initialSelectedKeys**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) Initial set of selected rows on component mount *** ### keysOnPage > **keysOnPage**: [`Key`](../../types/type-aliases/Key.md)[] Defined 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) Array of keys for rows on the current page *** ### onSelectionChange()? > `optional` **onSelectionChange**: (`next`) => `void` Defined 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) Callback fired when the selection changes. Receives a new immutable set of selected keys. #### Parameters ##### next `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> #### Returns `void` *** ### paginatedData > **paginatedData**: readonly `T`[] Defined 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) Array of rows currently shown on the page *** ### selectable? > `optional` **selectable**: `boolean` Defined 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) Whether row selection is enabled for this table *** ### selectedKeys? > `optional` **selectedKeys**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) Set of currently selected row keys ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseTableDataOptions.md ================================================ [Admin Docs](/) *** # Interface: IUseTableDataOptions\ Defined 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) Configuration options for fetching table data from a GraphQL connection. Supports extracting rows from GraphQL Relay connection patterns and transforming nodes into the desired row format. Integrates with Apollo Client for query management. ## Type Parameters ### TNode `TNode` The raw node type from the GraphQL connection ### TRow `TRow` The transformed row type after processing (may differ from TNode) ### TData `TData` = `unknown` The complete GraphQL query result data shape ## Properties ### deps? > `optional` **deps**: `DependencyList` Defined 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) React dependency array to control when the data fetching updates *** ### path > **path**: `DataPath`\<`TNode`, `TData`\> Defined 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) Path to the connection data within the query result. Can be a function that extracts the connection from data, or an array of keys/indices. *** ### transformNode()? > `optional` **transformNode**: (`node`) => `TRow` Defined 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) Optional transform function to convert raw node data into row format. Called for each node in the connection. #### Parameters ##### node `TNode` The raw node from the connection #### Returns `TRow` Transformed row data, or null/undefined to exclude the node ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseTableDataResult.md ================================================ [Admin Docs](/) *** # Interface: IUseTableDataResult\ Defined 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) Result object from a table data fetching hook. Contains the processed rows, loading states, error information, and methods to refetch data or fetch additional pages in a paginated result set. ## Type Parameters ### TRow `TRow` The type of data for each row ### TData `TData` = `unknown` The shape of the complete GraphQL query result ## Properties ### error > **error**: `Error` Defined 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) Error from the most recent query or fetch operation *** ### fetchMore() > **fetchMore**: \<`TFetchData`, `TFetchVars`\>(`fetchMoreOptions`) => `Promise`\<`ApolloQueryResult`\<`TFetchData`\>\> Defined 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) Function to fetch additional pages or update pagination cursors. Follows Apollo Client's fetchMore signature. #### Type Parameters ##### TFetchData `TFetchData` = `TData` ##### TFetchVars `TFetchVars` *extends* `OperationVariables` = `OperationVariables` #### Parameters ##### fetchMoreOptions `FetchMoreQueryOptions`\<`TFetchVars`, `TFetchData`\> & `object` #### Returns `Promise`\<`ApolloQueryResult`\<`TFetchData`\>\> *** ### loading > **loading**: `boolean` Defined 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) Whether the initial data fetch is in progress *** ### loadingMore > **loadingMore**: `boolean` Defined 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) Whether additional pages are currently being fetched *** ### networkStatus > **networkStatus**: `NetworkStatus` Defined 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) Apollo Client network status code. 1 = loading, 4 = setVariables, 6 = refetch, 7 = poll, 8 = ready, etc. *** ### pageInfo > **pageInfo**: [`InterfacePageInfo`](../../pagination/interfaces/InterfacePageInfo.md) Defined 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) Pagination state including cursors and next/previous page availability *** ### refetch() > **refetch**: (`variables?`) => `Promise`\<`ApolloQueryResult`\<`TData`\>\> Defined 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) Function to refetch the query with fresh data. Typically used to refresh after mutations. #### Parameters ##### variables? `Partial`\<`TVariables`\> #### Returns `Promise`\<`ApolloQueryResult`\<`TData`\>\> *** ### rows > **rows**: `TRow`[] Defined 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) Array of processed rows ready for display in the table ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/pagination/interfaces/InterfacePageInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfacePageInfo Defined 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) Pagination state information for cursor-based pagination. Used in GraphQL Relay connection pattern to track pagination cursors and availability of next/previous pages. ## Properties ### endCursor? > `optional` **endCursor**: `string` Defined 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) Cursor pointing to the end of the current result set *** ### hasNextPage > **hasNextPage**: `boolean` Defined 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) Whether more items exist after the current set (has next page) *** ### hasPreviousPage > **hasPreviousPage**: `boolean` Defined 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) Whether items existed before the current set (has previous page) *** ### startCursor? > `optional` **startCursor**: `string` Defined 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) Cursor pointing to the start of the current result set ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/pagination/interfaces/InterfacePaginationControlsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePaginationControlsProps Defined 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) Props for a pagination controls component. Displays pagination UI with page indicators and navigation buttons allowing users to move between pages of data. ## Properties ### onPageChange() > **onPageChange**: (`page`) => `void` Defined 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) Callback fired when user navigates to a different page. #### Parameters ##### page `number` The new page number #### Returns `void` *** ### page > **page**: `number` Defined 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) Current page number (typically 1-indexed) *** ### pageSize > **pageSize**: `number` Defined 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) Number of items per page *** ### totalItems > **totalItems**: `number` Defined 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) Total number of items across all pages ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/pagination/type-aliases/Connection.md ================================================ [Admin Docs](/) *** # Type Alias: Connection\ > **Connection**\<`TNode`\> = \{ `edges?`: [`Edge`](Edge.md)\<`TNode`\>[] \| `null`; `pageInfo?`: [`PageInfo`](PageInfo.md) \| `null`; \} \| `null` \| `undefined` Defined 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) GraphQL Relay connection pattern for paginated data. Contains an array of edges (each wrapping a node or null) and pagination metadata. Consumers should iterate the edges array and safely access node values (which may be null), then use pageInfo to determine pagination state. ## Type Parameters ### TNode `TNode` The type of node data in the edges ## Type Declaration \{ `edges?`: [`Edge`](Edge.md)\<`TNode`\>[] \| `null`; `pageInfo?`: [`PageInfo`](PageInfo.md) \| `null`; \} ### edges? > `optional` **edges**: [`Edge`](Edge.md)\<`TNode`\>[] \| `null` Array of edges, each optionally containing a node ### pageInfo? > `optional` **pageInfo**: [`PageInfo`](PageInfo.md) \| `null` Pagination state (cursors and next/previous availability) `null` `undefined` ## Example ``` connection?.edges?.forEach(edge => { if (edge?.node) { // Process non-null node } }); ``` ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/pagination/type-aliases/Edge.md ================================================ [Admin Docs](/) *** # Type Alias: Edge\ > **Edge**\<`TNode`\> = \{ `node`: `TNode` \| `null`; \} \| `null` Defined 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) A single edge in a GraphQL Relay connection. Wraps a node (or null) and can be null itself, representing a single item in a paginated result set. ## Type Parameters ### TNode `TNode` The type of node data wrapped by this edge ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/pagination/type-aliases/PageInfo.md ================================================ [Admin Docs](/) *** # Type Alias: PageInfo > **PageInfo** = [`InterfacePageInfo`](../interfaces/InterfacePageInfo.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceBaseDataTableProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceBaseDataTableProps\ Defined 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) Base props for DataTable component configuration. Provides core table configuration including column definitions, row data, sizing, and sorting behavior. Extended by InterfaceDataTableProps for full functionality. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### columns > **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\>[] Defined 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) Array of column definitions specifying how to render each column *** ### keysToShowRows? > `optional` **keysToShowRows**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) Set of row keys to display; if provided, only these rows are shown *** ### onSortChange()? > `optional` **onSortChange**: (`event`) => `void` Defined 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) Callback fired when sort state changes #### Parameters ##### event [`ISortChangeEvent`](../../types/interfaces/ISortChangeEvent.md)\<`T`\> #### Returns `void` *** ### rowKey? > `optional` **rowKey**: keyof `T` \| (`row`) => [`Key`](../../types/type-aliases/Key.md) Defined 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) Key or property name or function to extract unique identifier for each row *** ### rows? > `optional` **rows**: `T`[] Defined 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) Array of row data to display in the table *** ### sortable? > `optional` **sortable**: `boolean` Defined 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) Whether columns are sortable (default: true) *** ### sortState? > `optional` **sortState**: [`ISortState`](../../types/interfaces/ISortState.md) Defined 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) Current sort state specifying column and direction ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceDataTableSkeletonProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDataTableSkeletonProps\ Defined 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) Props for the DataTableSkeleton loading placeholder component. Configures a skeleton table that animates while data is loading, providing visual feedback of expected table structure. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) ARIA label for the skeleton table *** ### columns > **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\>[] Defined 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) Array of column definitions to match skeleton structure *** ### effectiveSelectable? > `optional` **effectiveSelectable**: `boolean` Defined 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) Whether to show selection checkbox column *** ### hasRowActions? > `optional` **hasRowActions**: `boolean` Defined 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) Whether to show actions column *** ### skeletonRows > **skeletonRows**: `number` Defined 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) Number of skeleton rows to display *** ### tableClassNames? > `optional` **tableClassNames**: `string` Defined 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) CSS class names for the table ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceDataTableTableProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDataTableTableProps\ Defined 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) Props for the DataTableTable component that renders table rows. Provides data and configuration for rendering paginated table content, including row selection, actions, and custom empty states. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### activeSortBy? > `optional` **activeSortBy**: `string` Defined 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) ID of the currently sorted column *** ### activeSortDir? > `optional` **activeSortDir**: [`SortDirection`](../../types/type-aliases/SortDirection.md) Defined 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) Current sort direction *** ### allSelectedOnPage? > `optional` **allSelectedOnPage**: `boolean` Defined 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) Whether all rows on page are selected *** ### ariaBusy? > `optional` **ariaBusy**: `boolean` Defined 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) ARIA busy state for the table *** ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) ARIA label for the table element *** ### columns > **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\>[] Defined 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) Array of column definitions specifying how to render each column *** ### currentSelection > **currentSelection**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) Current selection state *** ### effectiveRowActions > **effectiveRowActions**: readonly [`IRowAction`](../../hooks/interfaces/IRowAction.md)\<`T`\>[] Defined 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) Array of effective row actions *** ### effectiveSelectable? > `optional` **effectiveSelectable**: `boolean` Defined 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) Whether selection is enabled *** ### getKey() > **getKey**: (`row`, `idx`) => `string` \| `number` Defined 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) Function to get unique key for a row #### Parameters ##### row `T` ##### idx `number` #### Returns `string` \| `number` *** ### handleHeaderClick() > **handleHeaderClick**: (`col`) => `void` Defined 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) Callback when header is clicked for sorting #### Parameters ##### col [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\> #### Returns `void` *** ### hasRowActions? > `optional` **hasRowActions**: `boolean` Defined 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) Whether row actions are present *** ### headerCheckboxRef? > `optional` **headerCheckboxRef**: `RefObject`\<`HTMLInputElement`\> Defined 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) Ref to the header checkbox for select all *** ### keysToShowRows? > `optional` **keysToShowRows**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) Set of row keys to display; if provided, only these rows are shown *** ### loadingMore? > `optional` **loadingMore**: `boolean` Defined 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) Whether more rows are loading *** ### renderRow()? > `optional` **renderRow**: (`row`, `index`) => `ReactNode` Defined 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) Custom function to render each row #### Parameters ##### row `T` ##### index `number` #### Returns `ReactNode` *** ### selectAllOnPage() > **selectAllOnPage**: (`checked`) => `void` Defined 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) Callback to select/deselect all rows on page #### Parameters ##### checked `boolean` #### Returns `void` *** ### skeletonRows? > `optional` **skeletonRows**: `number` Defined 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) Number of skeleton rows to show *** ### someSelectedOnPage? > `optional` **someSelectedOnPage**: `boolean` Defined 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) Whether some rows on page are selected *** ### sortable? > `optional` **sortable**: `boolean` Defined 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) Whether columns are sortable (default: true) *** ### sortedRows > **sortedRows**: readonly `T`[] Defined 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) Array of sorted rows to display *** ### sortState? > `optional` **sortState**: [`ISortState`](../../types/interfaces/ISortState.md) Defined 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) Current sort state specifying column and direction *** ### startIndex > **startIndex**: `number` Defined 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) Starting index for row numbering *** ### tableClassNames? > `optional` **tableClassNames**: `string` Defined 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) CSS classes to apply to the table *** ### tCommon() > **tCommon**: (`key`, `options?`) => `string` Defined 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) Translation function for common strings #### Parameters ##### key `string` ##### options? `Record`\<`string`, `unknown`\> #### Returns `string` *** ### toggleRowSelection() > **toggleRowSelection**: (`key`) => `void` Defined 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) Callback to toggle row selection #### Parameters ##### key [`Key`](../../types/type-aliases/Key.md) #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceLoadingMoreRowsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceLoadingMoreRowsProps\ Defined 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) Props for the LoadingMoreRows component. Manages UI state when loading additional pages in infinite-scroll scenarios, including error recovery with retry capability. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### columns > **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\>[] Defined 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) Array of column definitions to match row structure *** ### columnsCount? > `optional` **columnsCount**: `number` Defined 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) Number of columns in the table (for colspan) *** ### effectiveSelectable? > `optional` **effectiveSelectable**: `boolean` Defined 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) Whether to show selection checkbox column *** ### error? > `optional` **error**: `Error` Defined 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) Error from the most recent load attempt *** ### hasRowActions? > `optional` **hasRowActions**: `boolean` Defined 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) Whether to show actions column *** ### loading? > `optional` **loading**: `boolean` Defined 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) Whether more rows are currently loading *** ### retry()? > `optional` **retry**: () => `void` Defined 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) Callback to retry loading after an error #### Returns `void` *** ### skeletonRows? > `optional` **skeletonRows**: `number` Defined 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) Number of skeleton rows to display ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceSearchBarProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchBarProps Defined 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) Props for a searchable input/search bar component. Configures search input behavior including value synchronization, change callbacks, debouncing, and accessibility attributes. ## Properties ### aria? > `optional` **aria**: `object` Defined 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) ARIA accessibility attributes for the search input #### label? > `optional` **label**: `string` ARIA label for the search input #### labelledBy? > `optional` **labelledBy**: `string` ARIA labelledBy for linking to external labels *** ### aria-label? > `optional` **aria-label**: `string` Defined 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) ARIA label for the search input *** ### clear-aria-label? > `optional` **clear-aria-label**: `string` Defined 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) ARIA label for the clear button *** ### debounceDelay? > `optional` **debounceDelay**: `number` Defined 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) Milliseconds to debounce search input changes *** ### onChange() > **onChange**: (`q`) => `void` Defined 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) Callback fired when search value changes #### Parameters ##### q `string` #### Returns `void` *** ### onClear()? > `optional` **onClear**: () => `void` Defined 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) Callback fired when search is cleared #### Returns `void` *** ### placeholder? > `optional` **placeholder**: `string` Defined 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) Placeholder text to display in the search input *** ### value? > `optional` **value**: `string` Defined 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) Current search input value ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceTableLoaderProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTableLoaderProps\ Defined 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) Props for table loading states and error/empty conditions. Provides UI customization and state management for loading indicators, error messages, and empty state displays. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) ARIA label for the loading state *** ### asOverlay? > `optional` **asOverlay**: `boolean` Defined 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) Whether to render as an overlay *** ### columns > **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\>[] Defined 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) Array of column definitions to match table structure *** ### emptyComponent? > `optional` **emptyComponent**: `ReactNode` Defined 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) Custom React component to display when no rows are present *** ### error? > `optional` **error**: `Error` Defined 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) Error from the last data fetch operation *** ### errorComponent? > `optional` **errorComponent**: `ReactNode` Defined 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) Custom React component to display when an error occurs *** ### loading? > `optional` **loading**: `boolean` Defined 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) Whether the table is loading initial data *** ### loadingMore? > `optional` **loadingMore**: `boolean` Defined 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) Whether additional data is currently loading *** ### rows? > `optional` **rows**: `number` Defined 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) Number of skeleton rows to display ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/props/type-aliases/InterfaceDataTableProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceDataTableProps\ > **InterfaceDataTableProps**\<`T`\> = `object` Defined 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) Complete props for the DataTable component. Extends base configuration with pagination, filtering, searching, selection, and bulk actions. Supports both client-side and server-side data handling. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### actionableRows? > `optional` **actionableRows**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) *** ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) ARIA label for the table element *** ### bulkActions? > `optional` **bulkActions**: `ReadonlyArray`\<[`IBulkAction`](../../hooks/interfaces/IBulkAction.md)\<`T`\>\> Defined 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) *** ### className? > `optional` **className**: `string` Defined 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) CSS class to apply to the table element *** ### columnFilter? > `optional` **columnFilter**: `Record`\<`string`, `unknown`\> Defined 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) *** ### columnFilters? > `optional` **columnFilters**: `Record`\<`string`, `unknown`\> Defined 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) *** ### columns > **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\>[] Defined 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) Array of column definitions specifying how to render each column *** ### currentPage? > `optional` **currentPage**: `number` Defined 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) *** ### data > **data**: `T`[] Defined 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) For backward compatibility: use rows instead *** ### disableSort? > `optional` **disableSort**: `boolean` Defined 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) *** ### emptyMessage? > `optional` **emptyMessage**: `string` Defined 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) Message to display when table is empty *** ### error? > `optional` **error**: `Error` \| `null` Defined 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) Error from the last data fetch operation *** ### globalSearch? > `optional` **globalSearch**: `string` Defined 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) *** ### initialGlobalSearch? > `optional` **initialGlobalSearch**: `string` Defined 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) Initial global search value *** ### initialSelectedKeys? > `optional` **initialSelectedKeys**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) *** ### initialSortBy? > `optional` **initialSortBy**: `string` Defined 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) Initial sort property *** ### initialSortDirection? > `optional` **initialSortDirection**: [`SortDirection`](../../types/type-aliases/SortDirection.md) Defined 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) *** ### keysToShowRows? > `optional` **keysToShowRows**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) Set of row keys to display; if provided, only these rows are shown *** ### loading? > `optional` **loading**: `boolean` Defined 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) Whether the table is loading initial data *** ### loadingMore? > `optional` **loadingMore**: `boolean` Defined 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) Whether additional data is currently loading *** ### loadingOverlay? > `optional` **loadingOverlay**: `boolean` Defined 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) Whether to show a loading overlay during pagination *** ### noHeader? > `optional` **noHeader**: `boolean` Defined 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) Whether to hide the header row *** ### onColumnFilterChange()? > `optional` **onColumnFilterChange**: (`filters`) => `void` Defined 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) #### Parameters ##### filters `Record`\<`string`, `unknown`\> #### Returns `void` *** ### onColumnFiltersChange()? > `optional` **onColumnFiltersChange**: (`filters`) => `void` Defined 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) #### Parameters ##### filters `Record`\<`string`, `unknown`\> #### Returns `void` *** ### onGlobalSearchChange()? > `optional` **onGlobalSearchChange**: (`q`) => `void` Defined 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) #### Parameters ##### q `string` #### Returns `void` *** ### onLoadMore()? > `optional` **onLoadMore**: () => `void` Defined 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) #### Returns `void` *** ### onPageChange()? > `optional` **onPageChange**: (`page`) => `void` Defined 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) #### Parameters ##### page `number` #### Returns `void` *** ### onSelectedRowsChange()? > `optional` **onSelectedRowsChange**: (`next`) => `void` Defined 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) #### Parameters ##### next `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> #### Returns `void` *** ### onSelectionChange()? > `optional` **onSelectionChange**: (`next`) => `void` Defined 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) #### Parameters ##### next `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> #### Returns `void` *** ### onSortChange()? > `optional` **onSortChange**: (`event`) => `void` Defined 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) Callback fired when sort state changes #### Parameters ##### event [`ISortChangeEvent`](../../types/interfaces/ISortChangeEvent.md)\<`T`\> #### Returns `void` *** ### page? > `optional` **page**: `number` Defined 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) *** ### pageInfo? > `optional` **pageInfo**: [`InterfacePageInfo`](../../pagination/interfaces/InterfacePageInfo.md) \| `null` Defined 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) *** ### pageSize? > `optional` **pageSize**: `number` Defined 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) *** ### paginationMode? > `optional` **paginationMode**: `"client"` \| `"server"` \| `"none"` Defined 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) *** ### refetch? > `optional` **refetch**: `QueryResult`\<`unknown`\>\[`"refetch"`\] Defined 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) *** ### renderError()? > `optional` **renderError**: (`error`) => `ReactNode` Defined 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) Custom function to render error state #### Parameters ##### error `Error` #### Returns `ReactNode` *** ### renderRow()? > `optional` **renderRow**: (`row`, `index`) => `ReactNode` Defined 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) Custom function to render each row #### Parameters ##### row `T` ##### index `number` #### Returns `ReactNode` *** ### rowActions? > `optional` **rowActions**: `ReadonlyArray`\<[`IRowAction`](../../hooks/interfaces/IRowAction.md)\<`T`\>\> Defined 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) *** ### rowKey? > `optional` **rowKey**: keyof `T` \| (`row`) => [`Key`](../../types/type-aliases/Key.md) Defined 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) Key or property name or function to extract unique identifier for each row *** ### rows? > `optional` **rows**: `T`[] Defined 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) Array of row data to display in the table *** ### searchBarProps? > `optional` **searchBarProps**: `Omit`\<[`InterfaceSearchBarProps`](../interfaces/InterfaceSearchBarProps.md), `"value"` \| `"onChange"`\> Defined 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) *** ### searchPlaceholder? > `optional` **searchPlaceholder**: `string` Defined 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) Search placeholder text *** ### selectable? > `optional` **selectable**: `boolean` Defined 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) *** ### selectedKeys? > `optional` **selectedKeys**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) *** ### selectedRows? > `optional` **selectedRows**: `ReadonlySet`\<[`Key`](../../types/type-aliases/Key.md)\> Defined 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) *** ### serverFilter? > `optional` **serverFilter**: `boolean` Defined 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) *** ### serverSearch? > `optional` **serverSearch**: `boolean` Defined 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) *** ### serverSort? > `optional` **serverSort**: `boolean` Defined 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) Whether sorting is handled server-side *** ### showSearch? > `optional` **showSearch**: `boolean` Defined 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) Whether to show search bar *** ### showViewMoreButton? > `optional` **showViewMoreButton**: `boolean` Defined 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) *** ### size? > `optional` **size**: `"sm"` \| `"lg"` Defined 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) Bootstrap size variant: 'sm' for small or 'lg' for large *** ### skeletonRows? > `optional` **skeletonRows**: `number` Defined 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) Number of skeleton rows to show during loading *** ### sortable? > `optional` **sortable**: `boolean` Defined 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) Whether columns are sortable (default: true) *** ### sortBy? > `optional` **sortBy**: [`ISortState`](../../types/interfaces/ISortState.md)[] Defined 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) Current sort state as array (controlled sorting) *** ### sortState? > `optional` **sortState**: [`ISortState`](../../types/interfaces/ISortState.md) Defined 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) Current sort state specifying column and direction *** ### striped? > `optional` **striped**: `boolean` Defined 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) Whether to apply striped styling to rows *** ### tableBodyClassName? > `optional` **tableBodyClassName**: `string` Defined 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) *** ### tableClassName? > `optional` **tableClassName**: `string` Defined 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) *** ### totalItems? > `optional` **totalItems**: `number` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/IFilterState.md ================================================ [Admin Docs](/) *** # Interface: IFilterState Defined 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) Represents a single column filter. Pairs a column ID with a filter value to be applied when filtering table rows. ## Properties ### columnId > **columnId**: `string` Defined 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) ID of the column being filtered *** ### value > **value**: `unknown` Defined 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) The filter value to match against rows (type depends on column) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/ISortChangeEvent.md ================================================ [Admin Docs](/) *** # Interface: ISortChangeEvent\ Defined 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) Event object passed to onSortChange callback when sort state changes. Provides complete information about the sort change including the new sort state array, the primary sort direction, and the column definition that triggered the change. ## Type Parameters ### T `T` The type of data for each row in the table ## Properties ### column > **column**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\<`T`, `unknown`\> Defined 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) Column definition that triggered the sort change *** ### sortBy > **sortBy**: [`ISortState`](ISortState.md)[] Defined 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) Array of sort states (primary sort first, can include multiple columns) *** ### sortDirection > **sortDirection**: [`SortDirection`](../type-aliases/SortDirection.md) Defined 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) Direction of the primary sort ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/ISortState.md ================================================ [Admin Docs](/) *** # Interface: ISortState Defined 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) Represents the current sort state of a table column. Tracks which column is sorted and in which direction (ascending or descending). ## Properties ### columnId > **columnId**: `string` Defined 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) ID of the column being sorted *** ### direction > **direction**: [`SortDirection`](../type-aliases/SortDirection.md) Defined 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) Sort direction: 'asc' for ascending or 'desc' for descending ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/ITableState.md ================================================ [Admin Docs](/) *** # Interface: ITableState Defined 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) Complete state of a table including sorting, filtering, and selection. Represents the combined state of all table operations for persistence or state management. ## Properties ### filters? > `optional` **filters**: [`IFilterState`](IFilterState.md)[] Defined 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) Array of active column filters *** ### globalSearch? > `optional` **globalSearch**: `string` Defined 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) Global search query string applied across all searchable columns *** ### selectedRows? > `optional` **selectedRows**: `ReadonlySet`\<[`Key`](../type-aliases/Key.md)\> Defined 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) Immutable set of currently selected row keys *** ### sorting? > `optional` **sorting**: [`ISortState`](ISortState.md)[] Defined 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) Array of active sort states (primary sort first) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/Accessor.md ================================================ [Admin Docs](/) *** # Type Alias: Accessor\ > **Accessor**\<`T`, `TValue`\> = keyof `T` \| (`row`) => `TValue` Defined 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) ## Type Parameters ### T `T` ### TValue `TValue` = `unknown` ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/HeaderRender.md ================================================ [Admin Docs](/) *** # Type Alias: HeaderRender > **HeaderRender** = `string` \| `ReactNode` \| () => `ReactNode` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/Key.md ================================================ [Admin Docs](/) *** # Type Alias: Key > **Key** = `string` \| `number` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/SortDirection.md ================================================ [Admin Docs](/) *** # Type Alias: SortDirection > **SortDirection** = `"asc"` \| `"desc"` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DatePicker/interface/interfaces/InterfaceDatePickerProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDatePickerProps Defined 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) Component Props for DatePicker ## Properties ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name to be applied to the root element *** ### data-cy? > `optional` **data-cy**: `string` Defined 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) Test ID for Cypress testing purposes *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for testing purposes, applied to the underlying input *** ### disabled? > `optional` **disabled**: `boolean` Defined 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) Whether the date picker is disabled *** ### error? > `optional` **error**: `string` Defined 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) Error message to display when validation fails *** ### format? > `optional` **format**: `string` Defined 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) Format of the date displayed in the input (e.g., "MM/DD/YYYY", "YYYY-MM-DD") *** ### helpText? > `optional` **helpText**: `string` Defined 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) Additional help text displayed below the field *** ### label? > `optional` **label**: `string` Defined 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) Label displayed for the date picker *** ### maxDate? > `optional` **maxDate**: `Dayjs` Defined 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) Maximum selectable date constraint *** ### minDate? > `optional` **minDate**: `Dayjs` Defined 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) Minimum selectable date constraint *** ### name? > `optional` **name**: `string` Defined 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) Unique name identifier for the field *** ### onBlur()? > `optional` **onBlur**: () => `void` Defined 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) Callback fired when the field is blurred (for touch tracking) #### Returns `void` *** ### onChange() > **onChange**: (`date`) => `void` Defined 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) Callback fired when the date changes. #### Parameters ##### date `Dayjs` The new date value. #### Returns `void` *** ### required? > `optional` **required**: `boolean` Defined 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) Whether the field is required *** ### slotProps? > `optional` **slotProps**: `Partial`\<`DatePickerSlotProps`\<`false`\>\> Defined 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) Additional props passed to MUI DatePicker slots (e.g., actionBar, layout) *** ### slots? > `optional` **slots**: `Record`\<`string`, `React.ElementType`\> Defined 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) Custom slot component overrides (e.g., openPickerIcon, leftArrowIcon) *** ### touched? > `optional` **touched**: `boolean` Defined 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) Whether the field has been touched (for validation UX) *** ### value? > `optional` **value**: `Dayjs` Defined 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) Current date value. Represented as a Dayjs object or null if no date is selected. ================================================ FILE: docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/interfaces/IDateRangePreset.md ================================================ [Admin Docs](/) *** # Interface: IDateRangePreset Defined 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) IDateRangePreset Configuration for a preset date range button. ## Param Optional reference date for relative presets. Defaults to the current date if not provided. ## Example ```ts { key: 'last7days', label: 'Last 7 Days', getRange: (refDate = new Date()) => ({ startDate: dayjs(refDate).subtract(7, 'day').toDate(), endDate: refDate, }), } ``` ## Properties ### getRange() > **getRange**: (`refDate?`) => [`IDateRangeValue`](IDateRangeValue.md) Defined 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) #### Parameters ##### refDate? `Date` #### Returns [`IDateRangeValue`](IDateRangeValue.md) *** ### key > **key**: `string` Defined 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) *** ### label > **label**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/interfaces/IDateRangeValue.md ================================================ [Admin Docs](/) *** # Interface: IDateRangeValue Defined 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) IDateRangeValue Represents a controlled date range. ## Properties ### endDate > **endDate**: `Date` Defined 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) *** ### startDate > **startDate**: `Date` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/interfaces/InterfaceDateRangePickerProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDateRangePickerProps Defined 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) InterfaceDateRangePickerProps Controlled props for the DateRangePicker component. ## Properties ### className? > `optional` **className**: `string` Defined 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) *** ### dataTestId? > `optional` **dataTestId**: `string` Defined 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) *** ### disabled? > `optional` **disabled**: `boolean` Defined 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) *** ### error? > `optional` **error**: `boolean` Defined 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) *** ### helperText? > `optional` **helperText**: `string` Defined 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) *** ### onChange() > **onChange**: (`val`) => `void` Defined 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) #### Parameters ##### val [`IDateRangeValue`](IDateRangeValue.md) #### Returns `void` *** ### presets? > `optional` **presets**: [`IDateRangePreset`](IDateRangePreset.md)[] Defined 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) *** ### showPresets? > `optional` **showPresets**: `boolean` Defined 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) *** ### value > **value**: [`IDateRangeValue`](IDateRangeValue.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/type-aliases/DateOrNull.md ================================================ [Admin Docs](/) *** # Type Alias: DateOrNull > **DateOrNull** = `Date` \| `null` Defined 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) DateRangePicker shared types ## Remarks All date values are local `Date` objects. Timezone conversion and serialization (ISO strings, server formats) must be handled by GraphQL middleware or API adapters. ## Example ```tsx const [range, setRange] = useState({ startDate: null, endDate: null, }); ``` ================================================ FILE: docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDropDownButtonProps Defined 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) Interface for dropdown button component props. ## Extends - [`InterfaceDropDownProps`](InterfaceDropDownProps.md) ## Properties ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) ARIA label for accessibility. *** ### btnStyle? > `optional` **btnStyle**: `string` Defined 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) Base class(es) for the toggle button. Applied first; often set by the wrapping component. Use this for default button layout/theme. #### Inherited from [`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`btnStyle`](InterfaceDropDownProps.md#btnstyle) *** ### buttonLabel? > `optional` **buttonLabel**: `string` Defined 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) The label of the button. *** ### containerClassName? > `optional` **containerClassName**: `string` Defined 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) Consumer override: extra class name(s) for the dropdown container, merged with parentContainerStyle. Use from parent screens (e.g. CSS module classes) to style the container without coupling to test IDs. #### Inherited from [`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`containerClassName`](InterfaceDropDownProps.md#containerclassname) *** ### dataTestIdPrefix? > `optional` **dataTestIdPrefix**: `string` Defined 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) Data test id prefix for testing purposes. *** ### disabled? > `optional` **disabled**: `boolean` Defined 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) Whether the dropdown button is disabled. *** ### drop? > `optional` **drop**: `"start"` \| `"end"` \| `"up"` \| `"down"` Defined 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) Direction the dropdown menu opens. *** ### icon? > `optional` **icon**: `ReactNode` Defined 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) The icon to be displayed on the button. *** ### id? > `optional` **id**: `string` Defined 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) The id of the dropdown button. *** ### menuClassName? > `optional` **menuClassName**: `string` Defined 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) Custom class name for the dropdown menu. #### Inherited from [`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`menuClassName`](InterfaceDropDownProps.md#menuclassname) *** ### onSelect() > **onSelect**: (`value`) => `void` Defined 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) Callback function when an option is selected. #### Parameters ##### value `string` #### Returns `void` *** ### options > **options**: [`InterfaceDropDownOption`](InterfaceDropDownOption.md)[] Defined 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) The options to be displayed in the dropdown. *** ### parentContainerStyle? > `optional` **parentContainerStyle**: `string` Defined 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) Base class(es) for the dropdown container. Applied first; often set by the wrapping component (e.g. SortingButton, Navbar). Use this for default layout/theme. #### Inherited from [`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`parentContainerStyle`](InterfaceDropDownProps.md#parentcontainerstyle) *** ### placeholder? > `optional` **placeholder**: `string` Defined 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) Placeholder text when no option is selected. *** ### searchable? > `optional` **searchable**: `boolean` Defined 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) Whether the dropdown should be searchable. *** ### searchPlaceholder? > `optional` **searchPlaceholder**: `string` Defined 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) Placeholder text for the search input. *** ### selectedValue? > `optional` **selectedValue**: `string` Defined 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) The currently selected value. *** ### showCaret? > `optional` **showCaret**: `boolean` Defined 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) Whether to show the caret icon on the dropdown button. #### Default Value ```ts true ``` *** ### toggleClassName? > `optional` **toggleClassName**: `string` Defined 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) Consumer override: extra class name(s) for the toggle button, merged with btnStyle. Use from parent screens (e.g. CSS module classes) to style the toggle without coupling to test IDs. #### Inherited from [`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`toggleClassName`](InterfaceDropDownProps.md#toggleclassname) *** ### variant? > `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"` Defined 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) The variant/style of the button. ================================================ FILE: docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDropDownOption Defined 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) Interface for a single dropdown option. ## Properties ### disabled? > `optional` **disabled**: `boolean` Defined 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) Whether the option is disabled. *** ### label > **label**: `ReactNode` Defined 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) The label of the option. *** ### value > **value**: `string` Defined 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) The value of the option. ================================================ FILE: docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDropDownProps Defined 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) Interface for dropdown component props. Styling props: - **Base (component/default layout):** `parentContainerStyle` and `btnStyle` are applied first (e.g. from SortingButton or Navbar defaults). - **Consumer overrides:** `containerClassName` and `toggleClassName` are merged with the base so parent screens can add their own CSS module classes without replacing defaults. ## Extended by - [`InterfaceDropDownButtonProps`](InterfaceDropDownButtonProps.md) ## Properties ### btnStyle? > `optional` **btnStyle**: `string` Defined 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) Base class(es) for the toggle button. Applied first; often set by the wrapping component. Use this for default button layout/theme. *** ### containerClassName? > `optional` **containerClassName**: `string` Defined 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) Consumer override: extra class name(s) for the dropdown container, merged with parentContainerStyle. Use from parent screens (e.g. CSS module classes) to style the container without coupling to test IDs. *** ### menuClassName? > `optional` **menuClassName**: `string` Defined 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) Custom class name for the dropdown menu. *** ### parentContainerStyle? > `optional` **parentContainerStyle**: `string` Defined 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) Base class(es) for the dropdown container. Applied first; often set by the wrapping component (e.g. SortingButton, Navbar). Use this for default layout/theme. *** ### toggleClassName? > `optional` **toggleClassName**: `string` Defined 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) Consumer override: extra class name(s) for the toggle button, merged with btnStyle. Use from parent screens (e.g. CSS module classes) to style the toggle without coupling to test IDs. ================================================ FILE: docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceSearchToggleProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchToggleProps Defined 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) Interface for SearchToggle component props. ## Properties ### className? > `optional` **className**: `string` Defined 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) *** ### dataTestIdPrefix > **dataTestIdPrefix**: `string` Defined 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) *** ### icon? > `optional` **icon**: `ReactNode` Defined 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) *** ### onChange() > **onChange**: (`e`) => `void` Defined 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) #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### onClick() > **onClick**: (`e`) => `void` Defined 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) #### Parameters ##### e `MouseEvent` #### Returns `void` *** ### onInputClick() > **onInputClick**: (`e`) => `void` Defined 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) #### Parameters ##### e `MouseEvent` #### Returns `void` *** ### placeholder? > `optional` **placeholder**: `string` Defined 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) *** ### value > **value**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEmptyStateProps Defined 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) Props interface for the EmptyState component. ## Properties ### action? > `optional` **action**: `object` Defined 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) Action button configuration. #### label > **label**: `string` #### onClick() > **onClick**: () => `void` ##### Returns `void` #### variant? > `optional` **variant**: `"primary"` \| `"secondary"` \| `"outlined"` *** ### className? > `optional` **className**: `string` Defined 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) Custom CSS class name. *** ### dataTestId? > `optional` **dataTestId**: `string` Defined 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) Test identifier. *** ### description? > `optional` **description**: `string` Defined 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) (Optional) Secondary description text. *** ### icon? > `optional` **icon**: `ReactNode` Defined 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) Icon to display above the message. *** ### message > **message**: `string` Defined 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) Primary message to display (i18n key or plain string) (Required). ================================================ FILE: docs/docs/auto-docs/types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceErrorBoundaryWrapperProps Defined 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) Props for ErrorBoundaryWrapper component ErrorBoundaryWrapper catches JavaScript errors anywhere in the child component tree, logs those errors, and displays a fallback UI instead of crashing the entire app. **Key Features:** - Catches render errors that try-catch cannot handle - Provides default and custom fallback UI options - Integrates with toast notification system - Supports error recovery via reset mechanism - Allows error logging/tracking integration ## Example ```tsx logToService(error, info)} onReset={() => navigate('/dashboard')} > ``` ## Properties ### children > **children**: `ReactNode` Defined 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) Child components to wrap with error boundary *** ### errorMessage? > `optional` **errorMessage**: `string` Defined 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) Custom error message to display in toast notification. Falls back to error.message or 'An unexpected error occurred' if not provided. *** ### fallback? > `optional` **fallback**: `ReactNode` Defined 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) Custom fallback UI (JSX element) to display when an error occurs. Takes precedence over default fallback but not over fallbackComponent. *** ### fallbackComponent? > `optional` **fallbackComponent**: `ComponentType`\<[`InterfaceErrorFallbackProps`](InterfaceErrorFallbackProps.md)\> Defined 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) Custom fallback component that receives error details and reset function. Takes precedence over both default fallback and custom JSX fallback. Receives error and onReset as props. *** ### fallbackErrorMessage > **fallbackErrorMessage**: `string` Defined 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) Translated fallback error message when error.message is unavailable. *** ### fallbackTitle > **fallbackTitle**: `string` Defined 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) Translated title text for default fallback UI. *** ### onError()? > `optional` **onError**: (`error`, `errorInfo`) => `void` Defined 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) Callback invoked when an error is caught. Useful for logging errors to external services (e.g., Sentry, LogRocket). Receives the Error object and ErrorInfo containing component stack trace. #### Parameters ##### error `Error` ##### errorInfo `ErrorInfo` #### Returns `void` *** ### onReset()? > `optional` **onReset**: () => `void` Defined 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) Callback invoked when user attempts to reset error state via the reset button. Can be used to navigate away, refresh data, or perform cleanup operations. #### Returns `void` *** ### resetButtonAriaLabel > **resetButtonAriaLabel**: `string` Defined 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) Translated aria-label for reset button (accessibility). *** ### resetButtonText > **resetButtonText**: `string` Defined 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) Translated reset button text. *** ### showToast? > `optional` **showToast**: `boolean` Defined 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) Whether to show toast notification on error. #### Default Value ```ts true ``` ================================================ FILE: docs/docs/auto-docs/types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md ================================================ [Admin Docs](/) *** # Interface: InterfaceErrorBoundaryWrapperState Defined 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) Internal state for ErrorBoundaryWrapper component. Tracks whether an error has occurred and stores error details for rendering in the fallback UI. ## Properties ### error > `readonly` **error**: `Error` Defined 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) The error that was caught *** ### errorInfo > `readonly` **errorInfo**: `ErrorInfo` Defined 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) Additional error information including component stack. *** ### hasError > `readonly` **hasError**: `boolean` Defined 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) Whether an error has been caught ================================================ FILE: docs/docs/auto-docs/types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorFallbackProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceErrorFallbackProps Defined 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) Props passed to custom fallback components. When using `fallbackComponent`, the component will receive these props to render a custom error UI with access to error details and reset functionality. ## Example ```tsx const CustomErrorFallback = ({ error, onReset }: InterfaceErrorFallbackProps) => (

Custom Error UI

{error?.message}

); ``` ## Properties ### error > **error**: `Error` Defined 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) The error that was caught by the error boundary *** ### onReset() > **onReset**: () => `void` Defined 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) Function to reset the error boundary state and attempt to re-render children #### Returns `void` ================================================ FILE: docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceEventListCard.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventListCard Defined 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) Event list card props extending InterfaceEvent. ## Remarks refetchEvents is optional and triggers a refresh when provided. ## Extends - [`InterfaceEvent`](../../../../Event/interface/type-aliases/InterfaceEvent.md) ## Properties ### allDay > **allDay**: `boolean` Defined in: [src/types/Event/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L51) #### Inherited from `InterfaceEvent.allDay` *** ### attendees > **attendees**: `Partial`\<[`User`](../../../../Event/type/type-aliases/User.md)\>[] Defined in: [src/types/Event/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L64) #### Inherited from `InterfaceEvent.attendees` *** ### averageFeedbackScore? > `optional` **averageFeedbackScore**: `number` Defined in: [src/types/Event/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L66) #### Inherited from `InterfaceEvent.averageFeedbackScore` *** ### baseEvent? > `optional` **baseEvent**: `object` Defined in: [src/types/Event/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L70) #### id > **id**: `string` #### Inherited from `InterfaceEvent.baseEvent` *** ### creator > **creator**: `Partial`\<[`User`](../../../../Event/type/type-aliases/User.md)\> Defined in: [src/types/Event/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L65) #### Inherited from `InterfaceEvent.creator` *** ### description > **description**: `string` Defined in: [src/types/Event/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L46) #### Inherited from `InterfaceEvent.description` *** ### endAt > **endAt**: `string` Defined in: [src/types/Event/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L48) #### Inherited from `InterfaceEvent.endAt` *** ### endTime? > `optional` **endTime**: `string` Defined in: [src/types/Event/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L50) #### Inherited from `InterfaceEvent.endTime` *** ### feedback? > `optional` **feedback**: [`Feedback`](../../../../Event/type/type-aliases/Feedback.md)[] Defined in: [src/types/Event/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L67) #### Inherited from `InterfaceEvent.feedback` *** ### hasExceptions? > `optional` **hasExceptions**: `boolean` Defined in: [src/types/Event/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L75) #### Inherited from `InterfaceEvent.hasExceptions` *** ### id > **id**: `string` Defined in: [src/types/Event/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L43) #### Inherited from `InterfaceEvent.id` *** ### isInviteOnly > **isInviteOnly**: `boolean` Defined in: [src/types/Event/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L63) Determines if the event is restricted to invited participants only. When true, only invited users can see and access the event. #### Inherited from `InterfaceEvent.isInviteOnly` *** ### isPublic > **isPublic**: `boolean` Defined in: [src/types/Event/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L57) Determines if the event is visible to the entire community. Often referred to as "Community Visible" in the UI. #### Inherited from `InterfaceEvent.isPublic` *** ### isRecurringEventTemplate? > `optional` **isRecurringEventTemplate**: `boolean` Defined in: [src/types/Event/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L69) #### Inherited from `InterfaceEvent.isRecurringEventTemplate` *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/types/Event/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L58) #### Inherited from `InterfaceEvent.isRegisterable` *** ### key? > `optional` **key**: `string` Defined in: [src/types/Event/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L42) #### Inherited from `InterfaceEvent.key` *** ### location > **location**: `string` Defined in: [src/types/Event/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L44) #### Inherited from `InterfaceEvent.location` *** ### name > **name**: `string` Defined in: [src/types/Event/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L45) #### Inherited from `InterfaceEvent.name` *** ### progressLabel? > `optional` **progressLabel**: `string` Defined in: [src/types/Event/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L76) #### Inherited from `InterfaceEvent.progressLabel` *** ### recurrenceDescription? > `optional` **recurrenceDescription**: `string` Defined in: [src/types/Event/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L78) #### Inherited from `InterfaceEvent.recurrenceDescription` *** ### recurrenceRule? > `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/types/Event/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L79) #### Inherited from `InterfaceEvent.recurrenceRule` *** ### refetchEvents()? > `optional` **refetchEvents**: () => `void` Defined 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) #### Returns `void` *** ### sequenceNumber? > `optional` **sequenceNumber**: `number` Defined in: [src/types/Event/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L73) #### Inherited from `InterfaceEvent.sequenceNumber` *** ### startAt > **startAt**: `string` Defined in: [src/types/Event/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L47) #### Inherited from `InterfaceEvent.startAt` *** ### startTime? > `optional` **startTime**: `string` Defined in: [src/types/Event/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L49) #### Inherited from `InterfaceEvent.startTime` *** ### totalCount? > `optional` **totalCount**: `number` Defined in: [src/types/Event/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L74) #### Inherited from `InterfaceEvent.totalCount` *** ### userId? > `optional` **userId**: `string` Defined in: [src/types/Event/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L52) #### Inherited from `InterfaceEvent.userId` *** ### userRole? > `optional` **userRole**: `string` Defined in: [src/types/Event/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L41) #### Inherited from `InterfaceEvent.userRole` ================================================ FILE: docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceEventListCardModalsProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventListCardModalsProps Defined 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) Props for EventListCardModals component. ## Param The event card properties including event details. ## Param Whether the modal is currently visible. ## Param Callback to close the modal. ## Param Translation function scoped to 'translation' namespace. ## Param Translation function for common strings. ## Properties ### eventListCardProps > **eventListCardProps**: [`InterfaceEventListCard`](InterfaceEventListCard.md) Defined 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) *** ### eventModalIsOpen > **eventModalIsOpen**: `boolean` Defined 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) *** ### hideViewModal() > **hideViewModal**: () => `void` Defined 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) #### Returns `void` *** ### t > **t**: `TFunction`\<`"translation"`, `undefined`\> Defined 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) *** ### tCommon > **tCommon**: `TFunction`\<`"translation"`, `undefined`\> Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceEventUpdateInput.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventUpdateInput Defined 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) Input payload for updating an event. Optional fields are included only when changed. ## Properties ### allDay? > `optional` **allDay**: `boolean` Defined 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) *** ### description? > `optional` **description**: `string` Defined 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) *** ### endAt? > `optional` **endAt**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isInviteOnly? > `optional` **isInviteOnly**: `boolean` Defined 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) *** ### isPublic? > `optional` **isPublic**: `boolean` Defined 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) *** ### isRegisterable? > `optional` **isRegisterable**: `boolean` Defined 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) *** ### location? > `optional` **location**: `string` Defined 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) *** ### name? > `optional` **name**: `string` Defined 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) *** ### recurrence? > `optional` **recurrence**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined 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) Recurrence rule for the event. This field is used for updating the recurrence pattern. *** ### startAt? > `optional` **startAt**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceFormState.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormState Defined 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) Form state captured from the EventListCard edit modal. ## Properties ### endTime > **endTime**: `string` Defined 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) *** ### eventDescription > **eventDescription**: `string` Defined 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) *** ### location > **location**: `string` Defined 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) *** ### name > **name**: `string` Defined 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) *** ### startTime > **startTime**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceUpdateEventHandlerProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUpdateEventHandlerProps Defined 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) Arguments for the updateEventHandler function. ## Properties ### allDayChecked > **allDayChecked**: `boolean` Defined 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) *** ### closeUpdateModal() > **closeUpdateModal**: () => `void` Defined 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) #### Returns `void` *** ### eventEndDate > **eventEndDate**: `Date` Defined 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) *** ### eventListCardProps > **eventListCardProps**: [`InterfaceEventListCard`](InterfaceEventListCard.md) Defined 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) *** ### eventStartDate > **eventStartDate**: `Date` Defined 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) *** ### eventUpdateModalIsOpen > **eventUpdateModalIsOpen**: `boolean` Defined 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) *** ### formState > **formState**: [`InterfaceFormState`](InterfaceFormState.md) Defined 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) *** ### hasRecurrenceChanged? > `optional` **hasRecurrenceChanged**: `boolean` Defined 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) *** ### hideViewModal() > **hideViewModal**: () => `void` Defined 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) #### Returns `void` *** ### inviteOnlyChecked > **inviteOnlyChecked**: `boolean` Defined 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) *** ### publicChecked > **publicChecked**: `boolean` Defined 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) *** ### recurrence > **recurrence**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined 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) *** ### refetchEvents()? > `optional` **refetchEvents**: () => `void` Defined 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) #### Returns `void` *** ### registerableChecked > **registerableChecked**: `boolean` Defined 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) *** ### t > **t**: `TFunction`\<`"translation"`, `undefined`\> Defined 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) *** ### updateOption > **updateOption**: `"single"` \| `"following"` \| `"entireSeries"` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormCheckFieldProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormCheckFieldProps Defined 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) Props for FormCheckField component. Used for checkbox, radio, and switch inputs. Supports standard form attributes like checked, onChange, disabled, etc. ## Extends - [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md) ## Properties ### checked? > `optional` **checked**: `boolean` Defined 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) *** ### className? > `optional` **className**: `string` Defined 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) #### Overrides [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`className`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#classname) *** ### data-testid? > `optional` **data-testid**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`data-testid`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#data-testid) *** ### disabled? > `optional` **disabled**: `boolean` Defined 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) #### Overrides [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`disabled`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#disabled) *** ### error? > `optional` **error**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`error`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#error) *** ### helpText? > `optional` **helpText**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`helpText`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#helptext) *** ### hideLabel? > `optional` **hideLabel**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`hideLabel`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#hidelabel) *** ### id? > `optional` **id**: `string` Defined 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) *** ### inline? > `optional` **inline**: `boolean` Defined 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) #### Overrides [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inline`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inline) *** ### inputId? > `optional` **inputId**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inputId`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inputid) *** ### label > **label**: `ReactNode` Defined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`label`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#label) *** ### labelClassName? > `optional` **labelClassName**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`labelClassName`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#labelclassname) *** ### name > **name**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`name`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#name) *** ### onChange()? > `optional` **onChange**: (`e`) => `void` Defined 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) #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### required? > `optional` **required**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`required`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#required) *** ### touched? > `optional` **touched**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`touched`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#touched) *** ### type? > `optional` **type**: `"switch"` \| `"checkbox"` \| `"radio"` Defined 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) *** ### value? > `optional` **value**: `string` \| `number` \| readonly `string`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormSelectFieldProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFormSelectFieldProps Defined 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) Props for FormSelectField component. ## Extends - [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md) ## Properties ### children > **children**: `ReactNode` Defined 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) *** ### className? > `optional` **className**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L17) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`className`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#classname) *** ### data-testid? > `optional` **data-testid**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`data-testid`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#data-testid) *** ### disabled? > `optional` **disabled**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L18) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`disabled`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#disabled) *** ### error? > `optional` **error**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`error`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#error) *** ### helpText? > `optional` **helpText**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`helpText`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#helptext) *** ### hideLabel? > `optional` **hideLabel**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`hideLabel`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#hidelabel) *** ### inline? > `optional` **inline**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L15) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inline`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inline) *** ### inputId? > `optional` **inputId**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inputId`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inputid) *** ### label > **label**: `ReactNode` Defined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`label`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#label) *** ### labelClassName? > `optional` **labelClassName**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`labelClassName`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#labelclassname) *** ### name > **name**: `string` Defined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`name`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#name) *** ### onChange() > **onChange**: (`v`) => `void` Defined 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) #### Parameters ##### v `string` #### Returns `void` *** ### required? > `optional` **required**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`required`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#required) *** ### touched? > `optional` **touched**: `boolean` Defined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12) #### Inherited from [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`touched`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#touched) *** ### value > **value**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/LoadingState/interface/type-aliases/InterfaceLoadingStateProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceLoadingStateProps > **InterfaceLoadingStateProps** = `WithCustomVariant` \| `WithoutCustomVariant` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/Navbar/interface/interfaces/InterfacePageHeaderProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePageHeaderProps Defined 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) Interface for PageHeader component props. ## Properties ### actions? > `optional` **actions**: `ReactNode` Defined 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) *** ### rootClassName? > `optional` **rootClassName**: `string` Defined 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) *** ### search? > `optional` **search**: `object` Defined 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) #### buttonTestId? > `optional` **buttonTestId**: `string` #### inputTestId? > `optional` **inputTestId**: `string` #### onSearch() > **onSearch**: (`value`) => `void` ##### Parameters ###### value `string` ##### Returns `void` #### placeholder > **placeholder**: `string` *** ### sorting? > `optional` **sorting**: `object`[] Defined 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) #### containerClassName? > `optional` **containerClassName**: `string` #### icon? > `optional` **icon**: `string` #### onChange() > **onChange**: (`value`) => `void` ##### Parameters ###### value `string` | `number` ##### Returns `void` #### options > **options**: `object`[] #### selected > **selected**: `string` \| `number` #### testIdPrefix > **testIdPrefix**: `string` #### title > **title**: `string` #### toggleClassName? > `optional` **toggleClassName**: `string` *** ### title? > `optional` **title**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/NotificationToast/interface/interfaces/InterfaceNotificationToastHelpers.md ================================================ [Admin Docs](/) *** # Interface: InterfaceNotificationToastHelpers Defined 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) Reusable helper API exposed by `NotificationToast`. ## Properties ### dismiss() > **dismiss**: () => `void` Defined 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) Dismiss all active toasts. #### Returns `void` *** ### error() > **error**: (`message`, `options?`) => `Id` Defined 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) Show an error toast. #### Parameters ##### message [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md) ##### options? `ToastOptions` #### Returns `Id` *** ### info() > **info**: (`message`, `options?`) => `Id` Defined 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) Show an info toast. #### Parameters ##### message [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md) ##### options? `ToastOptions` #### Returns `Id` *** ### promise() > **promise**: \<`T`\>(`promisifiedFunction`, `messages`, `options?`) => `Promise`\<`T`\> Defined 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) Show a promise toast with pending, success, and error states. #### Type Parameters ##### T `T` = `void` #### Parameters ##### promisifiedFunction [`PromiseFunction`](../type-aliases/PromiseFunction.md)\<`T`\> ##### messages [`InterfacePromiseMessages`](InterfacePromiseMessages.md) ##### options? `ToastOptions` #### Returns `Promise`\<`T`\> *** ### success() > **success**: (`message`, `options?`) => `Id` Defined 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) Show a success toast. #### Parameters ##### message [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md) ##### options? `ToastOptions` #### Returns `Id` *** ### warning() > **warning**: (`message`, `options?`) => `Id` Defined 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) Show a warning toast. #### Parameters ##### message [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md) ##### options? `ToastOptions` #### Returns `Id` ================================================ FILE: docs/docs/auto-docs/types/shared-components/NotificationToast/interface/interfaces/InterfaceNotificationToastI18nMessage.md ================================================ [Admin Docs](/) *** # Interface: InterfaceNotificationToastI18nMessage Defined 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) i18n-backed toast message definition. ## Properties ### key > **key**: `string` Defined 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) The i18next key to translate. #### Example ```ts 'sessionWarning' ``` *** ### namespace? > `optional` **namespace**: [`NotificationToastNamespace`](../type-aliases/NotificationToastNamespace.md) Defined 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) Optional i18next namespace to use for translation. Defaults to `'common'` when omitted. *** ### values? > `optional` **values**: `Record`\<`string`, `unknown`\> Defined 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) Optional interpolation values for i18next. ================================================ FILE: docs/docs/auto-docs/types/shared-components/NotificationToast/interface/interfaces/InterfacePromiseMessages.md ================================================ [Admin Docs](/) *** # Interface: InterfacePromiseMessages Defined 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) Promise toast messages for pending, success, and error states. ## Properties ### error > **error**: [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md) Defined 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) *** ### pending > **pending**: [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md) Defined 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) *** ### success > **success**: [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/NotificationToastContainerProps.md ================================================ [Admin Docs](/) *** # Type Alias: NotificationToastContainerProps > **NotificationToastContainerProps** = `ToastContainerProps` Defined 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) Props for the `NotificationToastContainer` wrapper component. ================================================ FILE: docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/NotificationToastMessage.md ================================================ [Admin Docs](/) *** # Type Alias: NotificationToastMessage > **NotificationToastMessage** = `string` \| [`InterfaceNotificationToastI18nMessage`](../interfaces/InterfaceNotificationToastI18nMessage.md) Defined 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) A toast message can be a plain string or a translatable i18n key. ================================================ FILE: docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/NotificationToastNamespace.md ================================================ [Admin Docs](/) *** # Type Alias: NotificationToastNamespace > **NotificationToastNamespace** = `"translation"` \| `"errors"` \| `"common"` \| `string` & `object` Defined 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) Supported i18next namespaces in Talawa Admin. The app initializes i18n with `translation`, `errors`, and `common`, but this type also allows custom namespaces for future expansion. ================================================ FILE: docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/PromiseFunction.md ================================================ [Admin Docs](/) *** # Type Alias: PromiseFunction()\ > **PromiseFunction**\<`T`\> = () => `Promise`\<`T`\> Defined 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) Promisified function type. ## Type Parameters ### T `T` = `void` ## Returns `Promise`\<`T`\> ================================================ FILE: docs/docs/auto-docs/types/shared-components/PaginationList/interface/interfaces/InterfacePaginationListProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePaginationListProps Defined 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) InterfacePaginationListProps Interface for PaginationList component props ## Properties ### count > **count**: `number` Defined 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) *** ### onPageChange() > **onPageChange**: (`event`, `newPage`) => `void` Defined 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) #### Parameters ##### event `MouseEvent`\<`HTMLButtonElement`, `MouseEvent`\> ##### newPage `number` #### Returns `void` *** ### onRowsPerPageChange() > **onRowsPerPageChange**: (`event`) => `void` Defined 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) #### Parameters ##### event `ChangeEvent`\<`HTMLInputElement` \| `HTMLTextAreaElement`\> #### Returns `void` *** ### page > **page**: `number` Defined 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) *** ### rowsPerPage > **rowsPerPage**: `number` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/PeopleTabNavbar/interface/interfaces/InterfacePeopleTabNavbarProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePeopleTabNavbarProps Defined 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) Props for PeopleTabNavbar component. ## Properties ### actions? > `optional` **actions**: `ReactNode` Defined 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) *** ### alignmentClassName? > `optional` **alignmentClassName**: `string` Defined 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) *** ### search? > `optional` **search**: `object` Defined 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) #### buttonTestId? > `optional` **buttonTestId**: `string` #### inputTestId? > `optional` **inputTestId**: `string` #### onSearch() > **onSearch**: (`value`) => `void` ##### Parameters ###### value `string` ##### Returns `void` #### placeholder > **placeholder**: `string` *** ### sorting? > `optional` **sorting**: `object`[] Defined 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) #### icon? > `optional` **icon**: `string` #### onChange() > **onChange**: (`value`) => `void` ##### Parameters ###### value `string` | `number` ##### Returns `void` #### options > **options**: `object`[] #### selected > **selected**: `string` \| `number` #### testIdPrefix > **testIdPrefix**: `string` #### title > **title**: `string` *** ### title? > `optional` **title**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/PluginRouteRenderer/interface/interfaces/InterfacePluginRouteRendererProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePluginRouteRendererProps Defined 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) Props for PluginRouteRenderer component. ## Properties ### fallback? > `optional` **fallback**: `ReactNode` Defined 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) *** ### route > **route**: [`IRouteExtension`](../../../../../plugin/types/interfaces/IRouteExtension.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/PluginRoutes/interface/interfaces/InterfacePluginRoutesProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePluginRoutesProps Defined 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) Props for PluginRoutes component. ## Properties ### fallback? > `optional` **fallback**: `ReactElement` Defined 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) *** ### isAdmin? > `optional` **isAdmin**: `boolean` Defined 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) *** ### userPermissions? > `optional` **userPermissions**: `string`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/PostViewModal/interface/interfaces/InterfacePostViewModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostViewModalProps Defined 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) Props for PostViewModal component. ## Param Controls the visibility of the modal. ## Param Callback invoked when the modal should close. ## Param The post data to display, or null if not loaded. ## Param Function to refresh post data after mutations. ## Properties ### onHide() > **onHide**: () => `void` Defined 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) #### Returns `void` *** ### post > **post**: [`InterfacePost`](../../../../Post/interface/interfaces/InterfacePost.md) Defined 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) *** ### refetch() > **refetch**: () => `Promise`\<`unknown`\> Defined 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) #### Returns `Promise`\<`unknown`\> *** ### show > **show**: `boolean` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/ProfileAvatarDisplay/interface/interfaces/InterfaceProfileAvatarDisplayProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceProfileAvatarDisplayProps Defined 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) Props for the ProfileAvatarDisplay component. ## Properties ### border? > `optional` **border**: `boolean` Defined 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) (Optional) Flag to add a border around the avatar. *** ### className? > `optional` **className**: `string` Defined 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) (Optional) Additional CSS class names. *** ### crossOrigin? > `optional` **crossOrigin**: `"anonymous"` \| `"use-credentials"` Defined 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) need to support other props which are in images *** ### customSize? > `optional` **customSize**: `number` Defined 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) (Optional) Custom size in pixels (used when size='custom'). *** ### dataTestId? > `optional` **dataTestId**: `string` Defined 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) (Optional) Test ID for testing purposes. *** ### decoding? > `optional` **decoding**: `"sync"` \| `"async"` \| `"auto"` Defined 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) (Optional) Decoding strategy for the image element. *** ### enableEnlarge? > `optional` **enableEnlarge**: `boolean` Defined 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) If true, clicking the avatar opens an enlarged modal view *** ### fallbackName > **fallbackName**: `string` Defined 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) Required name used for fallback avatar generation. *** ### imageUrl? > `optional` **imageUrl**: `string` Defined 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) (Optional) URL of the avatar image to display. *** ### loading? > `optional` **loading**: `"eager"` \| `"lazy"` Defined 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) (Optional) Loading strategy for the image element. *** ### objectFit? > `optional` **objectFit**: `"fill"` \| `"none"` \| `"cover"` \| `"contain"` \| `"scale-down"` Defined 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) (Optional) CSS object-fit value for the image. *** ### onClick()? > `optional` **onClick**: () => `void` Defined 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) (Optional) Click handler for the avatar. #### Returns `void` *** ### onError()? > `optional` **onError**: () => `void` Defined 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) Error handler for the image element. #### Returns `void` *** ### onLoad()? > `optional` **onLoad**: () => `void` Defined 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) Load handler for the image element. #### Returns `void` *** ### shape? > `optional` **shape**: `"circle"` \| `"square"` \| `"rounded"` Defined 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) (Optional) Shape: 'circle', 'square', or 'rounded'. *** ### size? > `optional` **size**: `"small"` \| `"custom"` \| `"medium"` \| `"large"` Defined 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) (Optional) Size preset: 'small', 'medium', 'large', or 'custom'. *** ### style? > `optional` **style**: `CSSProperties` Defined 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) (Optional) Inline React CSS properties. ================================================ FILE: docs/docs/auto-docs/types/shared-components/ProfileCard/interface/interfaces/InterfaceProfileCardProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceProfileCardProps Defined 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) ProfileCard component displays user profile information in a card format. It includes the user's name, role, and profile image. The component also provides navigation functionality based on the user's role and the specified portal. ## Properties ### portal? > `optional` **portal**: `"user"` \| `"admin"` Defined 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) The portal for which the profile card is being rendered. This determines the navigation behavior when the user clicks on the profile card. The default value is 'admin'. - 'admin': Navigates to the admin dashboard or relevant admin pages. - 'user': Navigates to the user dashboard or relevant user pages. #### Default Value ```ts 'admin' ``` ================================================ FILE: docs/docs/auto-docs/types/shared-components/ProfileDropdown/interface/interfaces/InterfaceProfileDropdownProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceProfileDropdownProps Defined 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) ProfileDropdown component interface definition This file defines the TypeScript interface for the ProfileDropdown component props. It ensures type safety and provides clear documentation for the expected props. ## Properties ### portal? > `optional` **portal**: `"user"` \| `"admin"` Defined 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) Optional prop to specify the portal type for navigation purposes. Acceptable values are 'admin' or 'user'. This prop is used to determine the navigation path when the user clicks on the profile or logout options. `@defaultValue` 'admin' ================================================ FILE: docs/docs/auto-docs/types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceEndOptionsSectionProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurrenceEndOptionsSectionProps Defined 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) Props for the RecurrenceEndOptionsSection component. ## Properties ### frequency > **frequency**: [`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md) Defined 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) The frequency of the recurrence (e.g., DAILY, WEEKLY). *** ### localCount > **localCount**: `string` \| `number` Defined 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) The local count value for "End after X occurrences". *** ### onCountChange() > **onCountChange**: (`e`) => `void` Defined 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) Callback when the occurrence count changes. #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### onRecurrenceEndOptionChange() > **onRecurrenceEndOptionChange**: (`e`) => `void` Defined 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) Callback when the end option selection changes. #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### recurrenceRuleState > **recurrenceRuleState**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined 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) The current state of the recurrence rule being built. *** ### selectedRecurrenceEndOption > **selectedRecurrenceEndOption**: [`RecurrenceEndOptionType`](../../../../../utils/recurrenceUtils/recurrenceTypes/type-aliases/RecurrenceEndOptionType.md) Defined 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) The currently selected end option (NEVER, ON_DATE, AFTER_OCCURRENCES). *** ### setRecurrenceRuleState() > **setRecurrenceRuleState**: (`state`) => `void` Defined 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) State setter for the recurrence rule. #### Parameters ##### state `SetStateAction`\<[`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\> #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined 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) Translation function. #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceFrequencySectionProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurrenceFrequencySectionProps Defined 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) Props for the RecurrenceFrequencySection component. ## Properties ### frequency > **frequency**: [`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md) Defined 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) The selected frequency usage. *** ### localInterval > **localInterval**: `string` \| `number` Defined 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) The interval value (e.g., every 2 weeks). *** ### onFrequencyChange() > **onFrequencyChange**: (`newFrequency`) => `void` Defined 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) Callback when the frequency changes. #### Parameters ##### newFrequency [`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md) #### Returns `void` *** ### onIntervalChange() > **onIntervalChange**: (`e`) => `void` Defined 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) Callback when the interval changes. #### Parameters ##### e `ChangeEvent`\<`HTMLInputElement`\> #### Returns `void` *** ### t() > **t**: (`key`) => `string` Defined 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) Translation function. #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceMonthlySectionProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurrenceMonthlySectionProps Defined 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) Props for the RecurrenceMonthlySection component. ## Properties ### frequency > **frequency**: [`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md) Defined 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) The selected frequency. *** ### recurrenceRuleState > **recurrenceRuleState**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined 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) The current state of the recurrence rule being built. *** ### setRecurrenceRuleState() > **setRecurrenceRuleState**: (`state`) => `void` Defined 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) State setter for the recurrence rule. #### Parameters ##### state `SetStateAction`\<[`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\> #### Returns `void` *** ### startDate > **startDate**: `Date` Defined 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) The start date of the recurrence. *** ### t() > **t**: (`key`) => `string` Defined 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) Translation function. #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/shared-components/RecurrenceDropdown/interface/interfaces/InterfaceRecurrenceDropdownProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurrenceDropdownProps Defined 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) Props for the RecurrenceDropdown component. ## Properties ### currentLabel > **currentLabel**: `string` Defined 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) *** ### onSelect() > **onSelect**: (`option`) => `void` Defined 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) #### Parameters ##### option [`InterfaceRecurrenceOption`](../../../../../shared-components/EventForm/utils/recurrenceOptions/interfaces/InterfaceRecurrenceOption.md) #### Returns `void` *** ### recurrenceOptions > **recurrenceOptions**: [`InterfaceRecurrenceOption`](../../../../../shared-components/EventForm/utils/recurrenceOptions/interfaces/InterfaceRecurrenceOption.md)[] Defined 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) *** ### t() > **t**: (`key`) => `string` Defined 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) #### Parameters ##### key `string` #### Returns `string` ================================================ FILE: docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceDropdownConfig.md ================================================ [Admin Docs](/) *** # Interface: InterfaceDropdownConfig Defined 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) Configuration for a single dropdown (sort or filter) in the SearchFilterBar. Each dropdown represents either a sorting control or a filter control, and is rendered using the SortingButton component. ## Properties ### containerClassName? > `optional` **containerClassName**: `string` Defined 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) Optional extra class for the dropdown container (e.g. from parent CSS module for styling). *** ### dataTestIdPrefix > **dataTestIdPrefix**: `string` Defined 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) The prefix used for generating data-testid attributes for testing. This is passed directly to the SortingButton component's `dataTestIdPrefix` prop. #### Example ```ts "sortTags", "filterPlugins", "timeFrame" ``` *** ### dropdownTestId? > `optional` **dropdownTestId**: `string` Defined 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) Optional data-testid for the dropdown element itself. **Job:** Enables testing frameworks to identify the entire dropdown component. #### Example ```ts "filter", "sort", "timeFrame" ``` *** ### id > **id**: `string` Defined 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) A unique identifier for this dropdown configuration. Used as the React key for stable rendering and should be unique across all dropdowns. #### Example ```ts "sort-by-date", "filter-by-status", "group-by-category" ``` *** ### label > **label**: `string` Defined 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) The label/title displayed on the dropdown button. This is typically a user-facing label like "Sort", "Filter", or "Time Frame". #### Example ```ts "Sort", "Filter plugins", "Time Frame" ``` *** ### onOptionChange() > **onOptionChange**: (`value`) => `void` Defined 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) Callback function triggered when the user selects a different option. **Trigger:** User clicks on a dropdown item in the menu. **Job:** Updates the parent component's state with the newly selected value. #### Parameters ##### value The `value` field of the selected option `string` | `number` #### Returns `void` #### Example ```ts onOptionChange={(value) => setSortOrder(value as SortedByType)} ``` *** ### options > **options**: [`InterfaceSortingOption`](InterfaceSortingOption.md)[] Defined 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) The list of available options for this dropdown. Each option contains a label (display text) and a value (underlying data). #### Example ```ts [ { label: 'Latest', value: 'DESCENDING' }, { label: 'Oldest', value: 'ASCENDING' } ] ``` *** ### selectedOption > **selectedOption**: `string` \| `number` Defined 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) The currently selected option value. This should match the `value` field of one of the options in the `options` array. #### Example ```ts "DESCENDING", "hours_DESC", "all", 0, 1, 2 ``` *** ### title? > `optional` **title**: `string` Defined 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) Optional title attribute for the dropdown element. **Job:** Provides tooltip text when hovering over the dropdown. #### Example ```ts "Filter plugins", "Sort options" ``` *** ### toggleClassName? > `optional` **toggleClassName**: `string` Defined 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) Optional extra class for the dropdown toggle button (e.g. from parent CSS module for styling). *** ### type > **type**: `"filter"` \| `"sort"` Defined 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) The type of dropdown control. - `'sort'`: Displays a sort icon and is used for ordering data - `'filter'`: Displays a filter icon and is used for filtering data ================================================ FILE: docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSearchFilterBarAdvanced.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchFilterBarAdvanced Defined 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) Configuration for SearchFilterBar with search and dropdown functionality. Use this variant when you need search capabilities combined with one or more sorting/filtering dropdowns. ## Examples ```tsx ``` ```tsx setSortBy(value as 'hours_DESC' | 'hours_ASC'), dataTestIdPrefix: 'sort' }, { label: 'Time Frame', type: 'filter', options: [ { label: 'All Time', value: 'allTime' }, { label: 'Weekly', value: 'weekly' } ], selectedOption: timeFrame, onOptionChange: (value) => setTimeFrame(value as TimeFrame), dataTestIdPrefix: 'timeFrame' } ]} /> ``` ## Extends - `InterfaceSearchFilterBarBase` ## Properties ### additionalButtons? > `optional` **additionalButtons**: `ReactNode` Defined 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) Optional additional React elements to render after the dropdowns. **Job:** Allows inserting custom buttons or components (e.g., "Upload Plugin" button). These elements are rendered inside the btnsBlockSearchBar container after all dropdowns. #### Example ```tsx additionalButtons={ } ``` *** ### containerClassName? > `optional` **containerClassName**: `string` Defined 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) Optional custom class name for the container div. **Job:** Allows overriding the default container styling for different screen layouts. default "btnsContainerSearchBar" #### Example ```ts "btnsContainer", "btnsContainerSearchBar" ``` #### Inherited from `InterfaceSearchFilterBarBase.containerClassName` *** ### debounceDelay? > `optional` **debounceDelay**: `number` Defined 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) Optional delay in milliseconds for debouncing search input changes. **Job:** Controls how long to wait after the user stops typing before calling onSearchChange. This prevents excessive API calls while the user is actively typing. default 300 #### Example ```ts 300, 500, 1000 ``` #### Inherited from `InterfaceSearchFilterBarBase.debounceDelay` *** ### dropdowns > **dropdowns**: [`InterfaceDropdownConfig`](InterfaceDropdownConfig.md)[] Defined 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) Array of dropdown configurations for sorting and filtering. **Job:** Defines all the dropdown controls that appear alongside the search bar. Each dropdown can be either a sort control or a filter control. The order of dropdowns in this array determines their visual order in the UI. #### Example ```ts dropdowns={[ { label: 'Sort', type: 'sort', options: [...], selectedOption: sortBy, onOptionChange: setSortBy, dataTestIdPrefix: 'sort' } ]} ``` *** ### hasDropdowns > **hasDropdowns**: `true` Defined 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) Discriminator property indicating this variant has dropdowns. **Job:** When `true`, the `dropdowns` property must be provided. *** ### onSearchChange() > **onSearchChange**: (`value`) => `void` Defined 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) Callback function triggered on every keystroke in the search input. **Trigger:** User types or deletes characters in the search field (onChange event). **Job:** Updates the parent component's search state immediately. Parent components should handle their own debouncing for expensive operations. #### Parameters ##### value `string` The current value of the search input field #### Returns `void` #### Example ```ts onSearchChange={(value) => setSearchTerm(value)} ``` #### Inherited from `InterfaceSearchFilterBarBase.onSearchChange` *** ### onSearchSubmit()? > `optional` **onSearchSubmit**: (`value`) => `void` Defined 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) Optional callback function triggered when the user explicitly submits the search. **Trigger:** User presses Enter key or clicks the search button. **Job:** Performs an immediate search action. Useful for triggering search on explicit user action vs typing. #### Parameters ##### value `string` The current value of the search input field #### Returns `void` #### Example ```ts onSearchSubmit={(value) => { console.log('User explicitly searched for:', value); performSearch(value); }} ``` #### Inherited from `InterfaceSearchFilterBarBase.onSearchSubmit` *** ### searchButtonTestId? > `optional` **searchButtonTestId**: `string` Defined 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) Optional data-testid for the search button. **Job:** Enables testing frameworks to identify the search button element. default "searchButton" #### Example ```ts "searchPluginsBtn", "searchBtn", "searchButton" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchButtonTestId` *** ### searchInputTestId? > `optional` **searchInputTestId**: `string` Defined 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) Optional data-testid for the search input field. **Job:** Enables testing frameworks to identify the search input element. default "searchInput" #### Example ```ts "searchPlugins", "searchBy", "searchRequests" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchInputTestId` *** ### searchPlaceholder > **searchPlaceholder**: `string` Defined 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) Placeholder text displayed in the search input field. **Job:** Provides guidance to users about what they can search for. #### Example ```ts "Search by volunteer", "Search requests", "Search plugins" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchPlaceholder` *** ### searchValue > **searchValue**: `string` Defined 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) The current search term value. **Job:** Controls the value of the search input field (controlled component pattern). This should be managed in the parent component's state. #### Example ```ts "John Doe", "authentication", "" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchValue` *** ### translations? > `optional` **translations**: [`InterfaceSearchFilterBarTranslations`](InterfaceSearchFilterBarTranslations.md) Defined 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) Optional translation overrides for accessibility and UI customization. **Job:** Allows customizing internal component translations while providing sensible defaults. #### Example ```ts translations: { searchButtonAriaLabel: "Search for volunteers", dropdownAriaLabel: "Toggle {label} options" } ``` #### Inherited from `InterfaceSearchFilterBarBase.translations` ================================================ FILE: docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSearchFilterBarSimple.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchFilterBarSimple Defined 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) Configuration for SearchFilterBar with only search functionality (no dropdowns). Use this variant when you only need search capabilities without any sorting or filtering dropdowns. ## Example ```tsx ``` ## Extends - `InterfaceSearchFilterBarBase` ## Properties ### containerClassName? > `optional` **containerClassName**: `string` Defined 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) Optional custom class name for the container div. **Job:** Allows overriding the default container styling for different screen layouts. default "btnsContainerSearchBar" #### Example ```ts "btnsContainer", "btnsContainerSearchBar" ``` #### Inherited from `InterfaceSearchFilterBarBase.containerClassName` *** ### debounceDelay? > `optional` **debounceDelay**: `number` Defined 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) Optional delay in milliseconds for debouncing search input changes. **Job:** Controls how long to wait after the user stops typing before calling onSearchChange. This prevents excessive API calls while the user is actively typing. default 300 #### Example ```ts 300, 500, 1000 ``` #### Inherited from `InterfaceSearchFilterBarBase.debounceDelay` *** ### hasDropdowns > **hasDropdowns**: `false` Defined 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) Discriminator property indicating this variant has no dropdowns. **Job:** When `false`, the `dropdowns` property must be omitted. *** ### onSearchChange() > **onSearchChange**: (`value`) => `void` Defined 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) Callback function triggered on every keystroke in the search input. **Trigger:** User types or deletes characters in the search field (onChange event). **Job:** Updates the parent component's search state immediately. Parent components should handle their own debouncing for expensive operations. #### Parameters ##### value `string` The current value of the search input field #### Returns `void` #### Example ```ts onSearchChange={(value) => setSearchTerm(value)} ``` #### Inherited from `InterfaceSearchFilterBarBase.onSearchChange` *** ### onSearchSubmit()? > `optional` **onSearchSubmit**: (`value`) => `void` Defined 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) Optional callback function triggered when the user explicitly submits the search. **Trigger:** User presses Enter key or clicks the search button. **Job:** Performs an immediate search action. Useful for triggering search on explicit user action vs typing. #### Parameters ##### value `string` The current value of the search input field #### Returns `void` #### Example ```ts onSearchSubmit={(value) => { console.log('User explicitly searched for:', value); performSearch(value); }} ``` #### Inherited from `InterfaceSearchFilterBarBase.onSearchSubmit` *** ### searchButtonTestId? > `optional` **searchButtonTestId**: `string` Defined 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) Optional data-testid for the search button. **Job:** Enables testing frameworks to identify the search button element. default "searchButton" #### Example ```ts "searchPluginsBtn", "searchBtn", "searchButton" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchButtonTestId` *** ### searchInputTestId? > `optional` **searchInputTestId**: `string` Defined 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) Optional data-testid for the search input field. **Job:** Enables testing frameworks to identify the search input element. default "searchInput" #### Example ```ts "searchPlugins", "searchBy", "searchRequests" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchInputTestId` *** ### searchPlaceholder > **searchPlaceholder**: `string` Defined 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) Placeholder text displayed in the search input field. **Job:** Provides guidance to users about what they can search for. #### Example ```ts "Search by volunteer", "Search requests", "Search plugins" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchPlaceholder` *** ### searchValue > **searchValue**: `string` Defined 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) The current search term value. **Job:** Controls the value of the search input field (controlled component pattern). This should be managed in the parent component's state. #### Example ```ts "John Doe", "authentication", "" ``` #### Inherited from `InterfaceSearchFilterBarBase.searchValue` *** ### translations? > `optional` **translations**: [`InterfaceSearchFilterBarTranslations`](InterfaceSearchFilterBarTranslations.md) Defined 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) Optional translation overrides for accessibility and UI customization. **Job:** Allows customizing internal component translations while providing sensible defaults. #### Example ```ts translations: { searchButtonAriaLabel: "Search for volunteers", dropdownAriaLabel: "Toggle {label} options" } ``` #### Inherited from `InterfaceSearchFilterBarBase.translations` ================================================ FILE: docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSearchFilterBarTranslations.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSearchFilterBarTranslations Defined 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) Optional translation overrides for SearchFilterBar component. Allows parent components to customize internal translations while providing sensible defaults for accessibility and common UI elements. ## Properties ### clearButtonAriaLabel? > `optional` **clearButtonAriaLabel**: `string` Defined 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) Clear button accessible label (screen readers) *** ### clearSearchLabel? > `optional` **clearSearchLabel**: `string` Defined 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) Clear search button text/label *** ### dropdownAriaLabel? > `optional` **dropdownAriaLabel**: `string` Defined 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) Dropdown toggle accessible label pattern *** ### filterAndSortOptionsLabel? > `optional` **filterAndSortOptionsLabel**: `string` Defined 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) Filter and sort options toolbar accessible label *** ### filterButtonAriaLabel? > `optional` **filterButtonAriaLabel**: `string` Defined 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) Filter button accessible label *** ### loadingLabel? > `optional` **loadingLabel**: `string` Defined 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) Loading state text *** ### noResultsLabel? > `optional` **noResultsLabel**: `string` Defined 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) No results found message *** ### searchButtonAriaLabel? > `optional` **searchButtonAriaLabel**: `string` Defined 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) Search button accessible label (screen readers) *** ### searchInputAriaDescription? > `optional` **searchInputAriaDescription**: `string` Defined 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) Search input accessible description *** ### sortButtonAriaLabel? > `optional` **sortButtonAriaLabel**: `string` Defined 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) Sort button accessible label ================================================ FILE: docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSortingOption.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSortingOption Defined 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) Represents a single option in a sorting or filtering dropdown. This interface is compatible with the SortingButton component's option format. ## Properties ### label > **label**: `string` Defined 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) The display text shown to the user in the dropdown menu. #### Example ```ts "Latest", "Oldest", "Most Hours" ``` *** ### value > **value**: `string` \| `number` Defined 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) The underlying value associated with this option. This value is passed to the onOptionChange callback when the option is selected. #### Example ```ts "DESCENDING", "hours_DESC", "all", 0, 1, 2 ``` ================================================ FILE: docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/type-aliases/InterfaceSearchFilterBarProps.md ================================================ [Admin Docs](/) *** # Type Alias: InterfaceSearchFilterBarProps > **InterfaceSearchFilterBarProps** = [`InterfaceSearchFilterBarSimple`](../interfaces/InterfaceSearchFilterBarSimple.md) \| [`InterfaceSearchFilterBarAdvanced`](../interfaces/InterfaceSearchFilterBarAdvanced.md) Defined 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) Main props interface for the SearchFilterBar component. This is a discriminated union type that ensures type safety: - When `hasDropdowns` is `false`, the `dropdowns` property cannot be provided - When `hasDropdowns` is `true`, the `dropdowns` property must be provided ## Examples ```tsx const props: InterfaceSearchFilterBarProps = { hasDropdowns: false, searchPlaceholder: "Search...", searchValue: searchTerm, onSearchChange: setSearchTerm }; ``` ```tsx const props: InterfaceSearchFilterBarProps = { hasDropdowns: true, searchPlaceholder: "Search...", searchValue: searchTerm, onSearchChange: setSearchTerm, dropdowns: [...] }; ``` ```tsx const props: InterfaceSearchFilterBarProps = { hasDropdowns: true, searchPlaceholder: "Search plugins...", searchValue: searchTerm, onSearchChange: setSearchTerm, dropdowns: [...], translations: { searchButtonAriaLabel: "Search for plugins", dropdownAriaLabel: "Toggle {label} filters" } }; ``` ================================================ FILE: docs/docs/auto-docs/types/shared-components/SidebarOrgSection/interface/interfaces/IOrganizationData.md ================================================ [Admin Docs](/) *** # Interface: IOrganizationData Defined 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) ## Properties ### addressLine1? > `optional` **addressLine1**: `string` Defined 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) Primary address line *** ### addressLine2? > `optional` **addressLine2**: `string` Defined 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) Secondary address line *** ### avatarURL? > `optional` **avatarURL**: `string` Defined 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) URL of the organization's avatar or logo image *** ### city? > `optional` **city**: `string` Defined 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) City where the organization is located *** ### countryCode? > `optional` **countryCode**: `string` Defined 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) ISO country code representing the organization's country *** ### createdAt > **createdAt**: `string` Defined 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) ISO timestamp string indicating when the organization was created *** ### description? > `optional` **description**: `string` Defined 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) Optional short description of the organization *** ### id > **id**: `string` Defined 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) Unique identifier of the organization *** ### isUserRegistrationRequired? > `optional` **isUserRegistrationRequired**: `boolean` Defined 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) Indicates whether user registration is required before accessing organization resources *** ### name > **name**: `string` Defined 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) Display name of the organization *** ### postalCode? > `optional` **postalCode**: `string` Defined 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) Postal or ZIP code *** ### state? > `optional` **state**: `string` Defined 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) State or province of the organization ================================================ FILE: docs/docs/auto-docs/types/shared-components/SidebarOrgSection/interface/interfaces/ISidebarOrgSectionProps.md ================================================ [Admin Docs](/) *** # Interface: ISidebarOrgSectionProps Defined 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) Props for the SidebarOrgSection component. ## Properties ### hideDrawer > **hideDrawer**: `boolean` Defined 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) Whether the drawer is hidden/collapsed. *** ### isProfilePage? > `optional` **isProfilePage**: `boolean` Defined 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) Whether current page is the profile page. *** ### orgId > **orgId**: `string` Defined 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) Organization ID to fetch and display. ================================================ FILE: docs/docs/auto-docs/types/shared-components/SortingButton/interface/interfaces/InterfaceSortingButtonProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSortingButtonProps Defined 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) Props for the SortingButton component. ## Properties ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) Accessible label for the dropdown button (screen readers) *** ### buttonLabel? > `optional` **buttonLabel**: `string` Defined 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) Optional prop for custom button label *** ### className? > `optional` **className**: `string` Defined 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) Custom class name for the Dropdown *** ### containerClassName? > `optional` **containerClassName**: `string` Defined 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) Optional extra class for the dropdown container (e.g. from parent CSS module) *** ### dataTestIdPrefix > **dataTestIdPrefix**: `string` Defined 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) The prefix for data-testid attributes for testing *** ### dropdownTestId? > `optional` **dropdownTestId**: `string` Defined 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) The data-testid attribute for the Dropdown *** ### icon? > `optional` **icon**: `string` Defined 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) Optional custom icon to display in the button *** ### onSortChange() > **onSortChange**: (`value`) => `void` Defined 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) Callback function to handle sorting option change #### Parameters ##### value `string` | `number` #### Returns `void` *** ### selectedOption? > `optional` **selectedOption**: `string` \| `number` Defined 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) The currently selected sorting option *** ### sortingOptions > **sortingOptions**: [`InterfaceSortingOption`](InterfaceSortingOption.md)[] Defined 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) The list of sorting options to display in the Dropdown *** ### title? > `optional` **title**: `string` Defined 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) The title attribute for the Dropdown *** ### toggleClassName? > `optional` **toggleClassName**: `string` Defined 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) Optional extra class for the toggle button (e.g. from parent CSS module) *** ### type? > `optional` **type**: `"filter"` \| `"sort"` Defined 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) Type to determine the icon to display: 'sort' or 'filter' ================================================ FILE: docs/docs/auto-docs/types/shared-components/SortingButton/interface/interfaces/InterfaceSortingOption.md ================================================ [Admin Docs](/) *** # Interface: InterfaceSortingOption Defined 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) Represents a single sorting option for the SortingButton dropdown. ## Properties ### label > **label**: `string` Defined 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) The label to display for the sorting option *** ### value > **value**: `string` \| `number` Defined 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) The value associated with the sorting option ================================================ FILE: docs/docs/auto-docs/types/shared-components/StatusBadge/interface/interfaces/InterfaceStatusBadgeProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceStatusBadgeProps Defined 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) Props interface for the StatusBadge component. ## Properties ### ariaLabel? > `optional` **ariaLabel**: `string` Defined 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) Custom aria-label for accessibility (optional, overrides default) *** ### className? > `optional` **className**: `string` Defined 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) Additional CSS classes to apply *** ### dataTestId? > `optional` **dataTestId**: `string` Defined 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) Test ID for component testing (forwarded as data-testid) *** ### icon? > `optional` **icon**: `ReactNode` Defined 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) Optional icon to display in the badge *** ### label? > `optional` **label**: `string` Defined 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) Custom label text (optional, overrides i18n) *** ### size? > `optional` **size**: [`StatusSize`](../type-aliases/StatusSize.md) Defined 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) The size of the badge (optional, defaults to 'md') *** ### variant > **variant**: [`StatusVariant`](../type-aliases/StatusVariant.md) Defined 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) The domain-specific status variant ================================================ FILE: docs/docs/auto-docs/types/shared-components/StatusBadge/interface/type-aliases/SemanticVariant.md ================================================ [Admin Docs](/) *** # Type Alias: SemanticVariant > **SemanticVariant** = `"success"` \| `"warning"` \| `"error"` \| `"info"` \| `"neutral"` Defined 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) Semantic variants for internal mapping. These represent the visual state of the badge. ================================================ FILE: docs/docs/auto-docs/types/shared-components/StatusBadge/interface/type-aliases/StatusSize.md ================================================ [Admin Docs](/) *** # Type Alias: StatusSize > **StatusSize** = `"sm"` \| `"md"` \| `"lg"` Defined 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) Size variants for the badge. Small (sm), Medium (md), and Large (lg) sizes are available. ================================================ FILE: docs/docs/auto-docs/types/shared-components/StatusBadge/interface/type-aliases/StatusVariant.md ================================================ [Admin Docs](/) *** # Type Alias: StatusVariant > **StatusVariant** = `"completed"` \| `"pending"` \| `"active"` \| `"inactive"` \| `"approved"` \| `"rejected"` \| `"disabled"` \| `"accepted"` \| `"declined"` \| `"no_response"` Defined 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) Domain-specific status variants that map to semantic meanings. These represent business logic states that are mapped to visual representations. ================================================ FILE: docs/docs/auto-docs/types/shared-components/TableLoader/interface/interfaces/InterfaceTableLoaderProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTableLoaderProps Defined 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) Props for the TableLoader component. `@property` noOfRows - The number of rows to render in the table body. `@property` headerTitles - An array of strings representing the titles for the table headers. `@property` noOfCols - The number of columns to render if headerTitles is not provided. `@property` data-testid - A custom data-testid attribute for testing purposes. ## Properties ### data-testid? > `optional` **data-testid**: `string` Defined 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) *** ### headerTitles? > `optional` **headerTitles**: `string`[] Defined 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) *** ### noOfCols? > `optional` **noOfCols**: `number` Defined 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) *** ### noOfRows > **noOfRows**: `number` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/TimePicker/interface/interfaces/InterfaceTimePickerProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTimePickerProps Defined 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) Component Props for TimePicker ## Properties ### className? > `optional` **className**: `string` Defined 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) Additional CSS class name to be applied to the root element *** ### data-testid? > `optional` **data-testid**: `string` Defined 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) Test ID for testing purposes, applied to the underlying input *** ### disabled? > `optional` **disabled**: `boolean` Defined 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) Whether the time picker is disabled *** ### disableOpenPicker? > `optional` **disableOpenPicker**: `boolean` Defined 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) Whether to disable the open picker button *** ### label? > `optional` **label**: `string` Defined 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) Label displayed for the time picker *** ### maxTime? > `optional` **maxTime**: `Dayjs` Defined 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) Maximum selectable time constraint *** ### minTime? > `optional` **minTime**: `Dayjs` Defined 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) Minimum selectable time constraint *** ### onChange() > **onChange**: (`date`) => `void` Defined 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) Callback fired when the time changes. #### Parameters ##### date `Dayjs` The new time value. #### Returns `void` *** ### slotProps? > `optional` **slotProps**: `Partial`\<`TimePickerSlotProps`\<`false`\>\> Defined 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) Additional props passed to MUI TimePicker slots (e.g., actionBar, layout) *** ### slots? > `optional` **slots**: `Record`\<`string`, `React.ElementType`\> Defined 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) Custom slot component overrides (e.g., openPickerIcon, leftArrowIcon) *** ### timeSteps? > `optional` **timeSteps**: `object` Defined 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) Step increments for time controls (hours, minutes, seconds) #### hours? > `optional` **hours**: `number` #### minutes? > `optional` **minutes**: `number` #### seconds? > `optional` **seconds**: `number` *** ### value? > `optional` **value**: `Dayjs` Defined 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) Current time value. Represented as a Dayjs object or null if no time is selected. ================================================ FILE: docs/docs/auto-docs/types/shared-components/TruncatedText/interface/interfaces/InterfaceTruncatedTextProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTruncatedTextProps Defined 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) Props for TruncatedText component. ## Properties ### maxWidthOverride? > `optional` **maxWidthOverride**: `number` Defined 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) Optional: Override for the maximum width for truncation. *** ### text > **text**: `string` Defined 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) The full text to display. It may be truncated if it exceeds the maximum width. ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/interface/interfaces/InterfaceUser.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUser Defined 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) ## Properties ### address? > `optional` **address**: [`Address`](../../type/type-aliases/Address.md) Defined 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) *** ### avatarURL? > `optional` **avatarURL**: `string` Defined 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) *** ### birthDate? > `optional` **birthDate**: `Date` Defined 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) *** ### createdAt? > `optional` **createdAt**: `string` \| `Date` Defined 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) *** ### email > **email**: `string` Defined 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) *** ### firstName > **firstName**: `string` Defined 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) *** ### gender? > `optional` **gender**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### image? > `optional` **image**: `string` Defined 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) *** ### lastName > **lastName**: `string` Defined 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) *** ### name? > `optional` **name**: `string` Defined 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) *** ### updatedAt? > `optional` **updatedAt**: `Date` Defined 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) *** ### userType? > `optional` **userType**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/interface/interfaces/InterfaceUserAttendee.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserAttendee Defined 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) Props for User in attendee context. ## Properties ### createdAt > **createdAt**: `string` Defined 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) *** ### id > **id**: `string` Defined 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) *** ### isRegistered > **isRegistered**: `boolean` Defined 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) *** ### time > **time**: `string` Defined 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) *** ### user > **user**: `object` Defined 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) #### avatarURL? > `optional` **avatarURL**: `string` #### emailAddress > **emailAddress**: `string` #### id > **id**: `string` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/type/type-aliases/Address.md ================================================ [Admin Docs](/) *** # Type Alias: Address > **Address** = `object` Defined 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) ## Properties ### city? > `optional` **city**: `string` Defined 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) *** ### countryCode? > `optional` **countryCode**: `string` Defined 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) *** ### dependentLocality? > `optional` **dependentLocality**: `string` Defined 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) *** ### line1? > `optional` **line1**: `string` Defined 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) *** ### line2? > `optional` **line2**: `string` Defined 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) *** ### postalCode? > `optional` **postalCode**: `string` Defined 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) *** ### sortingCode? > `optional` **sortingCode**: `string` Defined 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) *** ### state? > `optional` **state**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/type/type-aliases/AppUserProfile.md ================================================ [Admin Docs](/) *** # Type Alias: AppUserProfile > **AppUserProfile** = `object` Defined 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) ## Properties ### \_id > **\_id**: `string` Defined 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) *** ### adminFor > **adminFor**: [`Organization`](../../../../AdminPortal/Organization/type/type-aliases/Organization.md)[] Defined 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) *** ### appLanguageCode > **appLanguageCode**: `string` Defined 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) *** ### createdEvents > **createdEvents**: `Event`[] Defined 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) *** ### createdOrganizations > **createdOrganizations**: [`Organization`](../../../../AdminPortal/Organization/type/type-aliases/Organization.md)[] Defined 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) *** ### eventAdmin > **eventAdmin**: `Event`[] Defined 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) *** ### isSuperAdmin > **isSuperAdmin**: `boolean` Defined 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) *** ### userId > **userId**: [`User`](User.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/type/type-aliases/CreateUserFamilyInput.md ================================================ [Admin Docs](/) *** # Type Alias: CreateUserFamilyInput > **CreateUserFamilyInput** = `object` Defined 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) ## Properties ### title > **title**: `string` Defined 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) *** ### userIds > **userIds**: `string`[] Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/type/type-aliases/User.md ================================================ [Admin Docs](/) *** # Type Alias: User > **User** = `object` Defined 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) ## Properties ### \_id > **\_id**: `string` Defined 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) *** ### address? > `optional` **address**: [`Address`](Address.md) Defined 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) *** ### birthDate? > `optional` **birthDate**: `Date` Defined 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) *** ### createdAt > **createdAt**: `Date` Defined 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) *** ### email > **email**: `string` Defined 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) *** ### firstName > **firstName**: `string` Defined 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) *** ### gender? > `optional` **gender**: `string` Defined 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) *** ### image? > `optional` **image**: `string` Defined 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) *** ### lastName > **lastName**: `string` Defined 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) *** ### updatedAt? > `optional` **updatedAt**: `Date` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/type/type-aliases/UserInput.md ================================================ [Admin Docs](/) *** # Type Alias: UserInput > **UserInput** = `object` Defined 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) ## Properties ### appLanguageCode > **appLanguageCode**: `string` Defined 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) *** ### email > **email**: `string` Defined 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) *** ### firstName > **firstName**: `string` Defined 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) *** ### lastName > **lastName**: `string` Defined 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) *** ### password > **password**: `string` Defined 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) *** ### selectedOrganization > **selectedOrganization**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/User/type/type-aliases/UserPhone.md ================================================ [Admin Docs](/) *** # Type Alias: UserPhone > **UserPhone** = `object` Defined 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) ## Properties ### home? > `optional` **home**: `string` Defined 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) *** ### mobile? > `optional` **mobile**: `string` Defined 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) *** ### work? > `optional` **work**: `string` Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/VisibilitySelector/interface/interfaces/InterfaceVisibilitySelectorProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVisibilitySelectorProps Defined 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) Props for the VisibilitySelector component. ## Properties ### setVisibility() > **setVisibility**: (`visibility`) => `void` Defined 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) #### Parameters ##### visibility [`EventVisibility`](../../../../../shared-components/EventForm/utils/visibilityUtils/type-aliases/EventVisibility.md) #### Returns `void` *** ### tCommon() > **tCommon**: (`key`) => `string` Defined 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) #### Parameters ##### key `string` #### Returns `string` *** ### visibility > **visibility**: [`EventVisibility`](../../../../../shared-components/EventForm/utils/visibilityUtils/type-aliases/EventVisibility.md) Defined 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) ================================================ FILE: docs/docs/auto-docs/types/shared-components/VolunteerGroupViewModal/interface/interfaces/InterfaceVolunteerGroupViewModalProps.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerGroupViewModalProps Defined 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) Props for VolunteerGroupViewModal component. ## Properties ### group > **group**: [`InterfaceVolunteerGroupInfo`](../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md) Defined 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) The volunteer group information to display. *** ### hide() > **hide**: () => `void` Defined 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) Function to close the modal. #### Returns `void` *** ### isOpen > **isOpen**: `boolean` Defined 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) Indicates whether the modal is open. ================================================ FILE: docs/docs/auto-docs/utils/MinioDownload/functions/useMinioDownload.md ================================================ [Admin Docs](/) *** # Function: useMinioDownload() > **useMinioDownload**(): `InterfaceMinioDownload` Defined in: [src/utils/MinioDownload.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/MinioDownload.ts#L11) ## Returns `InterfaceMinioDownload` ================================================ FILE: docs/docs/auto-docs/utils/MinioUpload/functions/useMinioUpload.md ================================================ [Admin Docs](/) *** # Function: useMinioUpload() > **useMinioUpload**(): `InterfaceMinioUpload` Defined in: [src/utils/MinioUpload.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/MinioUpload.ts#L12) ## Returns `InterfaceMinioUpload` ================================================ FILE: docs/docs/auto-docs/utils/SanitizeInput/functions/sanitizeInput.md ================================================ [Admin Docs](/) *** # Function: sanitizeInput() > **sanitizeInput**(`input`): `string` Defined in: [src/utils/SanitizeInput.tsx:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/SanitizeInput.tsx#L8) Sanitizes user input to prevent XSS attacks Uses multiple passes and stricter pattern matching ## Parameters ### input `string` The string to sanitize ## Returns `string` The sanitized string with dangerous content removed ================================================ FILE: docs/docs/auto-docs/utils/StaticMockLink/classes/StaticMockLink.md ================================================ [Admin Docs](/) *** # Class: StaticMockLink Defined in: [src/utils/StaticMockLink.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L42) Similar to the standard Apollo MockLink, but doesn't consume a mock when it is used allowing it to be used in places like Storybook. ## Extends - `ApolloLink` ## Constructors ### Constructor > **new StaticMockLink**(`mockedResponses`, `addTypename`): `StaticMockLink` Defined in: [src/utils/StaticMockLink.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L47) #### Parameters ##### mockedResponses readonly `MockedResponse`\<`Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>[] ##### addTypename `boolean` = `true` #### Returns `StaticMockLink` #### Overrides `ApolloLink.constructor` ## Properties ### addTypename > **addTypename**: `boolean` = `true` Defined in: [src/utils/StaticMockLink.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L44) *** ### operation? > `optional` **operation**: `Operation` Defined in: [src/utils/StaticMockLink.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L43) ## Methods ### addMockedResponse() > **addMockedResponse**(`mockedResponse`): `void` Defined in: [src/utils/StaticMockLink.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L57) #### Parameters ##### mockedResponse `MockedResponse` #### Returns `void` *** ### request() > **request**(`operation`): `Observable`\<`FetchResult`\> Defined in: [src/utils/StaticMockLink.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L72) #### Parameters ##### operation `Operation` #### Returns `Observable`\<`FetchResult`\> #### Overrides `ApolloLink.request` ================================================ FILE: docs/docs/auto-docs/utils/StaticMockLink/functions/mockSingleLink.md ================================================ [Admin Docs](/) *** # Function: mockSingleLink() > **mockSingleLink**(...`mockedResponses`): [`InterfaceMockApolloLink`](../interfaces/InterfaceMockApolloLink.md) Defined in: [src/utils/StaticMockLink.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L195) ## Parameters ### mockedResponses ...(`boolean` \| `MockedResponse`\<`Record`\<`string`, `any`\>, `Record`\<`string`, `any`\>\>)[] ## Returns [`InterfaceMockApolloLink`](../interfaces/InterfaceMockApolloLink.md) ================================================ FILE: docs/docs/auto-docs/utils/StaticMockLink/interfaces/InterfaceMockApolloLink.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMockApolloLink Defined in: [src/utils/StaticMockLink.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L188) ## Extends - `ApolloLink` ## Properties ### operation? > `optional` **operation**: `Operation` Defined in: [src/utils/StaticMockLink.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L189) ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/functions/getInstalledAdminPlugins.md ================================================ [Admin Docs](/) *** # Function: getInstalledAdminPlugins() > **getInstalledAdminPlugins**(): `Promise`\<`object`[]\> Defined in: [src/utils/adminPluginInstaller.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L386) Gets all installed admin plugins from the file system via server API ## Returns `Promise`\<`object`[]\> ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/functions/installAdminPluginFromZip.md ================================================ [Admin Docs](/) *** # Function: installAdminPluginFromZip() > **installAdminPluginFromZip**(`__namedParameters`): `Promise`\<[`IAdminPluginInstallationResult`](../interfaces/IAdminPluginInstallationResult.md)\> Defined in: [src/utils/adminPluginInstaller.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L252) Installs a plugin from a zip file (supports both admin and API) Flow: 1) Create plugin in DB, 2) Install files, 3) Installation is handled separately ## Parameters ### \_\_namedParameters [`IAdminPluginInstallationOptions`](../interfaces/IAdminPluginInstallationOptions.md) ## Returns `Promise`\<[`IAdminPluginInstallationResult`](../interfaces/IAdminPluginInstallationResult.md)\> ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/functions/removeAdminPlugin.md ================================================ [Admin Docs](/) *** # Function: removeAdminPlugin() > **removeAdminPlugin**(`pluginId`): `Promise`\<`boolean`\> Defined in: [src/utils/adminPluginInstaller.ts:409](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L409) Removes an admin plugin from the file system via server API ## Parameters ### pluginId `string` ## Returns `Promise`\<`boolean`\> ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/functions/validateAdminPluginStructure.md ================================================ [Admin Docs](/) *** # Function: validateAdminPluginStructure() > **validateAdminPluginStructure**(`files`): `object` Defined in: [src/utils/adminPluginInstaller.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L198) Validates admin plugin structure ## Parameters ### files `Record`\<`string`, `string`\> ## Returns `object` ### error? > `optional` **error**: `string` ### valid > **valid**: `boolean` ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/functions/validateAdminPluginZip.md ================================================ [Admin Docs](/) *** # Function: validateAdminPluginZip() > **validateAdminPluginZip**(`zipFile`): `Promise`\<[`IAdminPluginZipStructure`](../interfaces/IAdminPluginZipStructure.md)\> Defined in: [src/utils/adminPluginInstaller.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L54) Validates the structure of a plugin zip file (supports both admin and API) ## Parameters ### zipFile `File` ## Returns `Promise`\<[`IAdminPluginZipStructure`](../interfaces/IAdminPluginZipStructure.md)\> ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginInstallationOptions.md ================================================ [Admin Docs](/) *** # Interface: IAdminPluginInstallationOptions Defined in: [src/utils/adminPluginInstaller.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L45) ## Properties ### apolloClient? > `optional` **apolloClient**: `ApolloClient`\<`NormalizedCacheObject`\> Defined in: [src/utils/adminPluginInstaller.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L48) *** ### backup? > `optional` **backup**: `boolean` Defined in: [src/utils/adminPluginInstaller.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L47) *** ### zipFile > **zipFile**: `File` Defined in: [src/utils/adminPluginInstaller.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L46) ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginInstallationResult.md ================================================ [Admin Docs](/) *** # Interface: IAdminPluginInstallationResult Defined in: [src/utils/adminPluginInstaller.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L37) ## Properties ### error? > `optional` **error**: `string` Defined in: [src/utils/adminPluginInstaller.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L42) *** ### installedComponents > **installedComponents**: `string`[] Defined in: [src/utils/adminPluginInstaller.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L41) *** ### manifest > **manifest**: [`IAdminPluginManifest`](IAdminPluginManifest.md) Defined in: [src/utils/adminPluginInstaller.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L40) *** ### pluginId > **pluginId**: `string` Defined in: [src/utils/adminPluginInstaller.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L39) *** ### success > **success**: `boolean` Defined in: [src/utils/adminPluginInstaller.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L38) ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginManifest.md ================================================ [Admin Docs](/) *** # Interface: IAdminPluginManifest Defined in: [src/utils/adminPluginInstaller.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L10) ## Properties ### author > **author**: `string` Defined in: [src/utils/adminPluginInstaller.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L14) *** ### description > **description**: `string` Defined in: [src/utils/adminPluginInstaller.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L13) *** ### extensionPoints? > `optional` **extensionPoints**: `object` Defined in: [src/utils/adminPluginInstaller.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L17) #### routes? > `optional` **routes**: `object`[] *** ### main > **main**: `string` Defined in: [src/utils/adminPluginInstaller.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L15) *** ### name > **name**: `string` Defined in: [src/utils/adminPluginInstaller.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L11) *** ### pluginId > **pluginId**: `string` Defined in: [src/utils/adminPluginInstaller.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L16) *** ### version > **version**: `string` Defined in: [src/utils/adminPluginInstaller.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L12) ================================================ FILE: docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginZipStructure.md ================================================ [Admin Docs](/) *** # Interface: IAdminPluginZipStructure Defined in: [src/utils/adminPluginInstaller.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L27) ## Properties ### adminManifest? > `optional` **adminManifest**: [`IAdminPluginManifest`](IAdminPluginManifest.md) Defined in: [src/utils/adminPluginInstaller.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L30) *** ### apiFiles? > `optional` **apiFiles**: `string`[] Defined in: [src/utils/adminPluginInstaller.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L34) *** ### apiManifest? > `optional` **apiManifest**: [`IAdminPluginManifest`](IAdminPluginManifest.md) Defined in: [src/utils/adminPluginInstaller.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L31) *** ### files > **files**: `Record`\<`string`, `string`\> Defined in: [src/utils/adminPluginInstaller.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L33) *** ### hasAdminFolder > **hasAdminFolder**: `boolean` Defined in: [src/utils/adminPluginInstaller.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L28) *** ### hasApiFolder > **hasApiFolder**: `boolean` Defined in: [src/utils/adminPluginInstaller.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L29) *** ### pluginId? > `optional` **pluginId**: `string` Defined in: [src/utils/adminPluginInstaller.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L32) ================================================ FILE: docs/docs/auto-docs/utils/autocompleteHelpers/functions/areOptionsEqual.md ================================================ [Admin Docs](/) *** # Function: areOptionsEqual() > **areOptionsEqual**(`option`, `value`): `boolean` Defined in: [src/utils/autocompleteHelpers.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/autocompleteHelpers.ts#L10) Compares two user options by their IDs to determine equality in Autocomplete. ## Parameters ### option [`InterfaceUserInfoPG`](../../interfaces/interfaces/InterfaceUserInfoPG.md) The option from the list ### value [`InterfaceUserInfoPG`](../../interfaces/interfaces/InterfaceUserInfoPG.md) The currently selected value ## Returns `boolean` true if the IDs match ================================================ FILE: docs/docs/auto-docs/utils/autocompleteHelpers/functions/getMemberLabel.md ================================================ [Admin Docs](/) *** # Function: getMemberLabel() > **getMemberLabel**(`member`): `string` Defined in: [src/utils/autocompleteHelpers.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/autocompleteHelpers.ts#L21) Gets the display label for a member, preferring First Last name, falling back to name. ## Parameters ### member [`InterfaceUserInfoPG`](../../interfaces/interfaces/InterfaceUserInfoPG.md) The user/member object ## Returns `string` The formatted name string ================================================ FILE: docs/docs/auto-docs/utils/chartToPdf/functions/exportDemographicsToCSV.md ================================================ [Admin Docs](/) *** # Function: exportDemographicsToCSV() > **exportDemographicsToCSV**(`selectedCategory`, `categoryLabels`, `categoryData`): `void` Defined in: [src/utils/chartToPdf.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/chartToPdf.ts#L82) ## Parameters ### selectedCategory `string` ### categoryLabels `string`[] ### categoryData `number`[] ## Returns `void` ================================================ FILE: docs/docs/auto-docs/utils/chartToPdf/functions/exportToCSV.md ================================================ [Admin Docs](/) *** # Function: exportToCSV() > **exportToCSV**(`data`, `filename`): `void` Defined in: [src/utils/chartToPdf.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/chartToPdf.ts#L5) ## Parameters ### data `CSVData` ### filename `string` ## Returns `void` ================================================ FILE: docs/docs/auto-docs/utils/chartToPdf/functions/exportTrendsToCSV.md ================================================ [Admin Docs](/) *** # Function: exportTrendsToCSV() > **exportTrendsToCSV**(`eventLabels`, `attendeeCounts`, `maleCounts`, `femaleCounts`, `otherCounts`): `void` Defined in: [src/utils/chartToPdf.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/chartToPdf.ts#L52) ## Parameters ### eventLabels `string`[] ### attendeeCounts `number`[] ### maleCounts `number`[] ### femaleCounts `number`[] ### otherCounts `number`[] ## Returns `void` ================================================ FILE: docs/docs/auto-docs/utils/currency/variables/currencyOptions.md ================================================ [Admin Docs](/) *** # Variable: currencyOptions > `const` **currencyOptions**: `object`[] Defined in: [src/utils/currency.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/currency.ts#L1) ## Type Declaration ### label > **label**: `string` = `'AED'` ### value > **value**: `string` = `'AED'` ================================================ FILE: docs/docs/auto-docs/utils/currency/variables/currencySymbols.md ================================================ [Admin Docs](/) *** # Variable: currencySymbols > `const` **currencySymbols**: `object` Defined in: [src/utils/currency.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/currency.ts#L166) ## Index Signature \[`key`: `string`\]: `string` ================================================ FILE: docs/docs/auto-docs/utils/dateFormatter/functions/formatDate.md ================================================ [Admin Docs](/) *** # Function: formatDate() > **formatDate**(`dateString`): `string` Defined in: [src/utils/dateFormatter.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/dateFormatter.ts#L1) ## Parameters ### dateString `string` ## Returns `string` ================================================ FILE: docs/docs/auto-docs/utils/errorHandler/functions/errorHandler.md ================================================ [Admin Docs](/) *** # Function: errorHandler() > **errorHandler**(`a`, `error`): `void` Defined in: [src/utils/errorHandler.tsx:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/errorHandler.tsx#L9) This function is used to handle api errors in the application. It takes in the error object and displays the error message to the user. If 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 ## Parameters ### a `unknown` ### error `unknown` ## Returns `void` ================================================ FILE: docs/docs/auto-docs/utils/fieldTypes/variables/default.md ================================================ [Admin Docs](/) *** # Variable: default > `const` **default**: `string`[] Defined in: [src/utils/fieldTypes.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/fieldTypes.ts#L1) ================================================ FILE: docs/docs/auto-docs/utils/fileValidation/functions/validateFile.md ================================================ [Admin Docs](/) *** # Function: validateFile() > **validateFile**(`file`, `maxSizeInMB`, `allowedTypes`): `IFileValidationResult` Defined in: [src/utils/fileValidation.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/fileValidation.ts#L23) Validates a file for size and type ## Parameters ### file `File` The file to validate ### maxSizeInMB `number` = `FILE_UPLOAD_MAX_SIZE_MB` Maximum file size in MB (default: 5MB) ### allowedTypes readonly `string`[] = `FILE_UPLOAD_ALLOWED_TYPES` Array of allowed MIME types (default: ['image/jpeg', 'image/png', 'image/gif']) ## Returns `IFileValidationResult` IFileValidationResult - Object containing validation status and error message if any ================================================ FILE: docs/docs/auto-docs/utils/filehash/functions/calculateFileHash.md ================================================ [Admin Docs](/) *** # Function: calculateFileHash() > **calculateFileHash**(`file`): `Promise`\<`string`\> Defined in: [src/utils/filehash.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/filehash.ts#L1) ## Parameters ### file `File` ## Returns `Promise`\<`string`\> ================================================ FILE: docs/docs/auto-docs/utils/formEnumFields/variables/countryOptions.md ================================================ [Admin Docs](/) *** # Variable: countryOptions > `const` **countryOptions**: `object`[] Defined in: [src/utils/formEnumFields.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L1) ## Type Declaration ### label > **label**: `string` = `'Afghanistan'` ### value > **value**: `string` = `'af'` ================================================ FILE: docs/docs/auto-docs/utils/formEnumFields/variables/educationGradeEnum.md ================================================ [Admin Docs](/) *** # Variable: educationGradeEnum > `const` **educationGradeEnum**: `object`[] Defined in: [src/utils/formEnumFields.ts:202](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L202) ## Type Declaration ### label > **label**: `string` = `'No-Grade'` ### value > **value**: `string` = `'no_grade'` ================================================ FILE: docs/docs/auto-docs/utils/formEnumFields/variables/employmentStatusEnum.md ================================================ [Admin Docs](/) *** # Variable: employmentStatusEnum > `const` **employmentStatusEnum**: `object`[] Defined in: [src/utils/formEnumFields.ts:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L311) ## Type Declaration ### label > **label**: `string` = `'Full-Time'` ### value > **value**: `string` = `'full_time'` ================================================ FILE: docs/docs/auto-docs/utils/formEnumFields/variables/genderEnum.md ================================================ [Admin Docs](/) *** # Variable: genderEnum > `const` **genderEnum**: `object`[] Defined in: [src/utils/formEnumFields.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L296) ## Type Declaration ### label > **label**: `string` = `'Male'` ### value > **value**: `string` = `'male'` ================================================ FILE: docs/docs/auto-docs/utils/formEnumFields/variables/maritalStatusEnum.md ================================================ [Admin Docs](/) *** # Variable: maritalStatusEnum > `const` **maritalStatusEnum**: `object`[] Defined in: [src/utils/formEnumFields.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L269) ## Type Declaration ### label > **label**: `string` = `'Single'` ### value > **value**: `string` = `'single'` ================================================ FILE: docs/docs/auto-docs/utils/getRefreshToken/functions/handleTokenRefresh.md ================================================ [Admin Docs](/) *** # Function: handleTokenRefresh() > **handleTokenRefresh**(): `Promise`\<`void`\> Defined in: [src/utils/getRefreshToken.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/getRefreshToken.ts#L45) Attempts to refresh the token and reload the page if successful. Falls back to clearing storage and redirecting to login if refresh fails. ## Returns `Promise`\<`void`\> ================================================ FILE: docs/docs/auto-docs/utils/getRefreshToken/functions/refreshToken.md ================================================ [Admin Docs](/) *** # Function: refreshToken() > **refreshToken**(): `Promise`\<`boolean`\> Defined in: [src/utils/getRefreshToken.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/getRefreshToken.ts#L13) Refreshes the access token using HTTP-Only cookies. The refresh token is automatically sent via cookies by the browser. This function is called when the current access token expires. ## Returns `Promise`\<`boolean`\> Returns true if token refresh was successful, false otherwise ================================================ FILE: docs/docs/auto-docs/utils/interfaces/enumerations/AdvertisementTypePg.md ================================================ [Admin Docs](/) *** # Enumeration: AdvertisementTypePg Defined in: [src/utils/interfaces.ts:324](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L324) Represents the type of an advertisement. ## Enumeration Members ### BANNER > **BANNER**: `"banner"` Defined in: [src/utils/interfaces.ts:325](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L325) *** ### MENU > **MENU**: `"menu"` Defined in: [src/utils/interfaces.ts:326](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L326) *** ### POP\_UP > **POP\_UP**: `"pop_up"` Defined in: [src/utils/interfaces.ts:327](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L327) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/enumerations/Iso3166Alpha2CountryCode.md ================================================ [Admin Docs](/) *** # Enumeration: Iso3166Alpha2CountryCode Defined in: [src/utils/interfaces.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L4) Represents the ISO 3166-1 alpha-2 country codes. ## Enumeration Members ### ad > **ad**: `"ad"` Defined in: [src/utils/interfaces.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L5) *** ### ae > **ae**: `"ae"` Defined in: [src/utils/interfaces.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L6) *** ### af > **af**: `"af"` Defined in: [src/utils/interfaces.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L7) *** ### ag > **ag**: `"ag"` Defined in: [src/utils/interfaces.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L8) *** ### ai > **ai**: `"ai"` Defined in: [src/utils/interfaces.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L9) *** ### al > **al**: `"al"` Defined in: [src/utils/interfaces.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L10) *** ### am > **am**: `"am"` Defined in: [src/utils/interfaces.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L11) *** ### ao > **ao**: `"ao"` Defined in: [src/utils/interfaces.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L12) *** ### aq > **aq**: `"aq"` Defined in: [src/utils/interfaces.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L13) *** ### ar > **ar**: `"ar"` Defined in: [src/utils/interfaces.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L14) *** ### as > **as**: `"as"` Defined in: [src/utils/interfaces.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L15) *** ### at > **at**: `"at"` Defined in: [src/utils/interfaces.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L16) *** ### au > **au**: `"au"` Defined in: [src/utils/interfaces.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L17) *** ### aw > **aw**: `"aw"` Defined in: [src/utils/interfaces.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L18) *** ### ax > **ax**: `"ax"` Defined in: [src/utils/interfaces.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L19) *** ### az > **az**: `"az"` Defined in: [src/utils/interfaces.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L20) *** ### ba > **ba**: `"ba"` Defined in: [src/utils/interfaces.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L21) *** ### bb > **bb**: `"bb"` Defined in: [src/utils/interfaces.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L22) *** ### bd > **bd**: `"bd"` Defined in: [src/utils/interfaces.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L23) *** ### be > **be**: `"be"` Defined in: [src/utils/interfaces.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L24) *** ### bf > **bf**: `"bf"` Defined in: [src/utils/interfaces.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L25) *** ### bg > **bg**: `"bg"` Defined in: [src/utils/interfaces.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L26) *** ### bh > **bh**: `"bh"` Defined in: [src/utils/interfaces.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L27) *** ### bi > **bi**: `"bi"` Defined in: [src/utils/interfaces.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L28) *** ### bj > **bj**: `"bj"` Defined in: [src/utils/interfaces.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L29) *** ### bl > **bl**: `"bl"` Defined in: [src/utils/interfaces.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L30) *** ### bm > **bm**: `"bm"` Defined in: [src/utils/interfaces.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L31) *** ### bn > **bn**: `"bn"` Defined in: [src/utils/interfaces.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L32) *** ### bo > **bo**: `"bo"` Defined in: [src/utils/interfaces.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L33) *** ### bq > **bq**: `"bq"` Defined in: [src/utils/interfaces.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L34) *** ### br > **br**: `"br"` Defined in: [src/utils/interfaces.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L35) *** ### bs > **bs**: `"bs"` Defined in: [src/utils/interfaces.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L36) *** ### bt > **bt**: `"bt"` Defined in: [src/utils/interfaces.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L37) *** ### bv > **bv**: `"bv"` Defined in: [src/utils/interfaces.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L38) *** ### bw > **bw**: `"bw"` Defined in: [src/utils/interfaces.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L39) *** ### by > **by**: `"by"` Defined in: [src/utils/interfaces.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L40) *** ### bz > **bz**: `"bz"` Defined in: [src/utils/interfaces.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L41) *** ### ca > **ca**: `"ca"` Defined in: [src/utils/interfaces.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L42) *** ### cc > **cc**: `"cc"` Defined in: [src/utils/interfaces.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L43) *** ### cd > **cd**: `"cd"` Defined in: [src/utils/interfaces.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L44) *** ### cf > **cf**: `"cf"` Defined in: [src/utils/interfaces.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L45) *** ### cg > **cg**: `"cg"` Defined in: [src/utils/interfaces.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L46) *** ### ch > **ch**: `"ch"` Defined in: [src/utils/interfaces.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L47) *** ### ci > **ci**: `"ci"` Defined in: [src/utils/interfaces.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L48) *** ### ck > **ck**: `"ck"` Defined in: [src/utils/interfaces.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L49) *** ### cl > **cl**: `"cl"` Defined in: [src/utils/interfaces.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L50) *** ### cm > **cm**: `"cm"` Defined in: [src/utils/interfaces.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L51) *** ### cn > **cn**: `"cn"` Defined in: [src/utils/interfaces.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L52) *** ### co > **co**: `"co"` Defined in: [src/utils/interfaces.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L53) *** ### cr > **cr**: `"cr"` Defined in: [src/utils/interfaces.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L54) *** ### cu > **cu**: `"cu"` Defined in: [src/utils/interfaces.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L55) *** ### cv > **cv**: `"cv"` Defined in: [src/utils/interfaces.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L56) *** ### cw > **cw**: `"cw"` Defined in: [src/utils/interfaces.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L57) *** ### cx > **cx**: `"cx"` Defined in: [src/utils/interfaces.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L58) *** ### cy > **cy**: `"cy"` Defined in: [src/utils/interfaces.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L59) *** ### cz > **cz**: `"cz"` Defined in: [src/utils/interfaces.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L60) *** ### de > **de**: `"de"` Defined in: [src/utils/interfaces.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L61) *** ### dj > **dj**: `"dj"` Defined in: [src/utils/interfaces.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L62) *** ### dk > **dk**: `"dk"` Defined in: [src/utils/interfaces.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L63) *** ### dm > **dm**: `"dm"` Defined in: [src/utils/interfaces.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L64) *** ### do > **do**: `"do"` Defined in: [src/utils/interfaces.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L65) *** ### dz > **dz**: `"dz"` Defined in: [src/utils/interfaces.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L66) *** ### ec > **ec**: `"ec"` Defined in: [src/utils/interfaces.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L67) *** ### ee > **ee**: `"ee"` Defined in: [src/utils/interfaces.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L68) *** ### eg > **eg**: `"eg"` Defined in: [src/utils/interfaces.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L69) *** ### eh > **eh**: `"eh"` Defined in: [src/utils/interfaces.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L70) *** ### er > **er**: `"er"` Defined in: [src/utils/interfaces.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L71) *** ### es > **es**: `"es"` Defined in: [src/utils/interfaces.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L72) *** ### et > **et**: `"et"` Defined in: [src/utils/interfaces.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L73) *** ### fi > **fi**: `"fi"` Defined in: [src/utils/interfaces.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L74) *** ### fj > **fj**: `"fj"` Defined in: [src/utils/interfaces.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L75) *** ### fk > **fk**: `"fk"` Defined in: [src/utils/interfaces.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L76) *** ### fm > **fm**: `"fm"` Defined in: [src/utils/interfaces.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L77) *** ### fo > **fo**: `"fo"` Defined in: [src/utils/interfaces.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L78) *** ### fr > **fr**: `"fr"` Defined in: [src/utils/interfaces.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L79) *** ### ga > **ga**: `"ga"` Defined in: [src/utils/interfaces.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L80) *** ### gb > **gb**: `"gb"` Defined in: [src/utils/interfaces.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L81) *** ### gd > **gd**: `"gd"` Defined in: [src/utils/interfaces.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L82) *** ### ge > **ge**: `"ge"` Defined in: [src/utils/interfaces.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L83) *** ### gf > **gf**: `"gf"` Defined in: [src/utils/interfaces.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L84) *** ### gg > **gg**: `"gg"` Defined in: [src/utils/interfaces.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L85) *** ### gh > **gh**: `"gh"` Defined in: [src/utils/interfaces.ts:86](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L86) *** ### gi > **gi**: `"gi"` Defined in: [src/utils/interfaces.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L87) *** ### gl > **gl**: `"gl"` Defined in: [src/utils/interfaces.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L88) *** ### gm > **gm**: `"gm"` Defined in: [src/utils/interfaces.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L89) *** ### gn > **gn**: `"gn"` Defined in: [src/utils/interfaces.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L90) *** ### gp > **gp**: `"gp"` Defined in: [src/utils/interfaces.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L91) *** ### gq > **gq**: `"gq"` Defined in: [src/utils/interfaces.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L92) *** ### gr > **gr**: `"gr"` Defined in: [src/utils/interfaces.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L93) *** ### gs > **gs**: `"gs"` Defined in: [src/utils/interfaces.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L94) *** ### gt > **gt**: `"gt"` Defined in: [src/utils/interfaces.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L95) *** ### gu > **gu**: `"gu"` Defined in: [src/utils/interfaces.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L96) *** ### gw > **gw**: `"gw"` Defined in: [src/utils/interfaces.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L97) *** ### gy > **gy**: `"gy"` Defined in: [src/utils/interfaces.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L98) *** ### hk > **hk**: `"hk"` Defined in: [src/utils/interfaces.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L99) *** ### hm > **hm**: `"hm"` Defined in: [src/utils/interfaces.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L100) *** ### hn > **hn**: `"hn"` Defined in: [src/utils/interfaces.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L101) *** ### hr > **hr**: `"hr"` Defined in: [src/utils/interfaces.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L102) *** ### ht > **ht**: `"ht"` Defined in: [src/utils/interfaces.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L103) *** ### hu > **hu**: `"hu"` Defined in: [src/utils/interfaces.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L104) *** ### id > **id**: `"id"` Defined in: [src/utils/interfaces.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L105) *** ### ie > **ie**: `"ie"` Defined in: [src/utils/interfaces.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L106) *** ### il > **il**: `"il"` Defined in: [src/utils/interfaces.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L107) *** ### im > **im**: `"im"` Defined in: [src/utils/interfaces.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L108) *** ### in > **in**: `"in"` Defined in: [src/utils/interfaces.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L109) *** ### io > **io**: `"io"` Defined in: [src/utils/interfaces.ts:110](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L110) *** ### iq > **iq**: `"iq"` Defined in: [src/utils/interfaces.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L111) *** ### ir > **ir**: `"ir"` Defined in: [src/utils/interfaces.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L112) *** ### is > **is**: `"is"` Defined in: [src/utils/interfaces.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L113) *** ### it > **it**: `"it"` Defined in: [src/utils/interfaces.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L114) *** ### je > **je**: `"je"` Defined in: [src/utils/interfaces.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L115) *** ### jm > **jm**: `"jm"` Defined in: [src/utils/interfaces.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L116) *** ### jo > **jo**: `"jo"` Defined in: [src/utils/interfaces.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L117) *** ### jp > **jp**: `"jp"` Defined in: [src/utils/interfaces.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L118) *** ### ke > **ke**: `"ke"` Defined in: [src/utils/interfaces.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L119) *** ### kg > **kg**: `"kg"` Defined in: [src/utils/interfaces.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L120) *** ### kh > **kh**: `"kh"` Defined in: [src/utils/interfaces.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L121) *** ### ki > **ki**: `"ki"` Defined in: [src/utils/interfaces.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L122) *** ### km > **km**: `"km"` Defined in: [src/utils/interfaces.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L123) *** ### kn > **kn**: `"kn"` Defined in: [src/utils/interfaces.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L124) *** ### kp > **kp**: `"kp"` Defined in: [src/utils/interfaces.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L125) *** ### kr > **kr**: `"kr"` Defined in: [src/utils/interfaces.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L126) *** ### kw > **kw**: `"kw"` Defined in: [src/utils/interfaces.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L127) *** ### ky > **ky**: `"ky"` Defined in: [src/utils/interfaces.ts:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L128) *** ### kz > **kz**: `"kz"` Defined in: [src/utils/interfaces.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L129) *** ### la > **la**: `"la"` Defined in: [src/utils/interfaces.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L130) *** ### lb > **lb**: `"lb"` Defined in: [src/utils/interfaces.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L131) *** ### lc > **lc**: `"lc"` Defined in: [src/utils/interfaces.ts:132](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L132) *** ### li > **li**: `"li"` Defined in: [src/utils/interfaces.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L133) *** ### lk > **lk**: `"lk"` Defined in: [src/utils/interfaces.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L134) *** ### lr > **lr**: `"lr"` Defined in: [src/utils/interfaces.ts:135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L135) *** ### ls > **ls**: `"ls"` Defined in: [src/utils/interfaces.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L136) *** ### lt > **lt**: `"lt"` Defined in: [src/utils/interfaces.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L137) *** ### lu > **lu**: `"lu"` Defined in: [src/utils/interfaces.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L138) *** ### lv > **lv**: `"lv"` Defined in: [src/utils/interfaces.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L139) *** ### ly > **ly**: `"ly"` Defined in: [src/utils/interfaces.ts:140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L140) *** ### ma > **ma**: `"ma"` Defined in: [src/utils/interfaces.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L141) *** ### mc > **mc**: `"mc"` Defined in: [src/utils/interfaces.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L142) *** ### md > **md**: `"md"` Defined in: [src/utils/interfaces.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L143) *** ### me > **me**: `"me"` Defined in: [src/utils/interfaces.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L144) *** ### mf > **mf**: `"mf"` Defined in: [src/utils/interfaces.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L145) *** ### mg > **mg**: `"mg"` Defined in: [src/utils/interfaces.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L146) *** ### mh > **mh**: `"mh"` Defined in: [src/utils/interfaces.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L147) *** ### mk > **mk**: `"mk"` Defined in: [src/utils/interfaces.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L148) *** ### ml > **ml**: `"ml"` Defined in: [src/utils/interfaces.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L149) *** ### mm > **mm**: `"mm"` Defined in: [src/utils/interfaces.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L150) *** ### mn > **mn**: `"mn"` Defined in: [src/utils/interfaces.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L151) *** ### mo > **mo**: `"mo"` Defined in: [src/utils/interfaces.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L152) *** ### mp > **mp**: `"mp"` Defined in: [src/utils/interfaces.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L153) *** ### mq > **mq**: `"mq"` Defined in: [src/utils/interfaces.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L154) *** ### mr > **mr**: `"mr"` Defined in: [src/utils/interfaces.ts:155](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L155) *** ### ms > **ms**: `"ms"` Defined in: [src/utils/interfaces.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L156) *** ### mt > **mt**: `"mt"` Defined in: [src/utils/interfaces.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L157) *** ### mu > **mu**: `"mu"` Defined in: [src/utils/interfaces.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L158) *** ### mv > **mv**: `"mv"` Defined in: [src/utils/interfaces.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L159) *** ### mw > **mw**: `"mw"` Defined in: [src/utils/interfaces.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L160) *** ### mx > **mx**: `"mx"` Defined in: [src/utils/interfaces.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L161) *** ### my > **my**: `"my"` Defined in: [src/utils/interfaces.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L162) *** ### mz > **mz**: `"mz"` Defined in: [src/utils/interfaces.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L163) *** ### na > **na**: `"na"` Defined in: [src/utils/interfaces.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L164) *** ### nc > **nc**: `"nc"` Defined in: [src/utils/interfaces.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L165) *** ### ne > **ne**: `"ne"` Defined in: [src/utils/interfaces.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L166) *** ### nf > **nf**: `"nf"` Defined in: [src/utils/interfaces.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L167) *** ### ng > **ng**: `"ng"` Defined in: [src/utils/interfaces.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L168) *** ### ni > **ni**: `"ni"` Defined in: [src/utils/interfaces.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L169) *** ### nl > **nl**: `"nl"` Defined in: [src/utils/interfaces.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L170) *** ### no > **no**: `"no"` Defined in: [src/utils/interfaces.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L171) *** ### np > **np**: `"np"` Defined in: [src/utils/interfaces.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L172) *** ### nr > **nr**: `"nr"` Defined in: [src/utils/interfaces.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L173) *** ### nu > **nu**: `"nu"` Defined in: [src/utils/interfaces.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L174) *** ### nz > **nz**: `"nz"` Defined in: [src/utils/interfaces.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L175) *** ### om > **om**: `"om"` Defined in: [src/utils/interfaces.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L176) *** ### pa > **pa**: `"pa"` Defined in: [src/utils/interfaces.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L177) *** ### pe > **pe**: `"pe"` Defined in: [src/utils/interfaces.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L178) *** ### pf > **pf**: `"pf"` Defined in: [src/utils/interfaces.ts:179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L179) *** ### pg > **pg**: `"pg"` Defined in: [src/utils/interfaces.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L180) *** ### ph > **ph**: `"ph"` Defined in: [src/utils/interfaces.ts:181](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L181) *** ### pk > **pk**: `"pk"` Defined in: [src/utils/interfaces.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L182) *** ### pl > **pl**: `"pl"` Defined in: [src/utils/interfaces.ts:183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L183) *** ### pm > **pm**: `"pm"` Defined in: [src/utils/interfaces.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L184) *** ### pn > **pn**: `"pn"` Defined in: [src/utils/interfaces.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L185) *** ### pr > **pr**: `"pr"` Defined in: [src/utils/interfaces.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L186) *** ### ps > **ps**: `"ps"` Defined in: [src/utils/interfaces.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L187) *** ### pt > **pt**: `"pt"` Defined in: [src/utils/interfaces.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L188) *** ### pw > **pw**: `"pw"` Defined in: [src/utils/interfaces.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L189) *** ### py > **py**: `"py"` Defined in: [src/utils/interfaces.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L190) *** ### qa > **qa**: `"qa"` Defined in: [src/utils/interfaces.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L191) *** ### re > **re**: `"re"` Defined in: [src/utils/interfaces.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L192) *** ### ro > **ro**: `"ro"` Defined in: [src/utils/interfaces.ts:193](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L193) *** ### rs > **rs**: `"rs"` Defined in: [src/utils/interfaces.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L194) *** ### ru > **ru**: `"ru"` Defined in: [src/utils/interfaces.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L195) *** ### rw > **rw**: `"rw"` Defined in: [src/utils/interfaces.ts:196](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L196) *** ### sa > **sa**: `"sa"` Defined in: [src/utils/interfaces.ts:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L197) *** ### sb > **sb**: `"sb"` Defined in: [src/utils/interfaces.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L198) *** ### sc > **sc**: `"sc"` Defined in: [src/utils/interfaces.ts:199](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L199) *** ### sd > **sd**: `"sd"` Defined in: [src/utils/interfaces.ts:200](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L200) *** ### se > **se**: `"se"` Defined in: [src/utils/interfaces.ts:201](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L201) *** ### sg > **sg**: `"sg"` Defined in: [src/utils/interfaces.ts:202](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L202) *** ### sh > **sh**: `"sh"` Defined in: [src/utils/interfaces.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L203) *** ### si > **si**: `"si"` Defined in: [src/utils/interfaces.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L204) *** ### sj > **sj**: `"sj"` Defined in: [src/utils/interfaces.ts:205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L205) *** ### sk > **sk**: `"sk"` Defined in: [src/utils/interfaces.ts:206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L206) *** ### sl > **sl**: `"sl"` Defined in: [src/utils/interfaces.ts:207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L207) *** ### sm > **sm**: `"sm"` Defined in: [src/utils/interfaces.ts:208](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L208) *** ### sn > **sn**: `"sn"` Defined in: [src/utils/interfaces.ts:209](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L209) *** ### so > **so**: `"so"` Defined in: [src/utils/interfaces.ts:210](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L210) *** ### sr > **sr**: `"sr"` Defined in: [src/utils/interfaces.ts:211](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L211) *** ### ss > **ss**: `"ss"` Defined in: [src/utils/interfaces.ts:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L212) *** ### st > **st**: `"st"` Defined in: [src/utils/interfaces.ts:213](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L213) *** ### sv > **sv**: `"sv"` Defined in: [src/utils/interfaces.ts:214](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L214) *** ### sx > **sx**: `"sx"` Defined in: [src/utils/interfaces.ts:215](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L215) *** ### sy > **sy**: `"sy"` Defined in: [src/utils/interfaces.ts:216](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L216) *** ### sz > **sz**: `"sz"` Defined in: [src/utils/interfaces.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L217) *** ### tc > **tc**: `"tc"` Defined in: [src/utils/interfaces.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L218) *** ### td > **td**: `"td"` Defined in: [src/utils/interfaces.ts:219](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L219) *** ### tf > **tf**: `"tf"` Defined in: [src/utils/interfaces.ts:220](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L220) *** ### tg > **tg**: `"tg"` Defined in: [src/utils/interfaces.ts:221](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L221) *** ### th > **th**: `"th"` Defined in: [src/utils/interfaces.ts:222](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L222) *** ### tj > **tj**: `"tj"` Defined in: [src/utils/interfaces.ts:223](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L223) *** ### tk > **tk**: `"tk"` Defined in: [src/utils/interfaces.ts:224](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L224) *** ### tl > **tl**: `"tl"` Defined in: [src/utils/interfaces.ts:225](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L225) *** ### tm > **tm**: `"tm"` Defined in: [src/utils/interfaces.ts:226](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L226) *** ### tn > **tn**: `"tn"` Defined in: [src/utils/interfaces.ts:227](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L227) *** ### to > **to**: `"to"` Defined in: [src/utils/interfaces.ts:228](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L228) *** ### tr > **tr**: `"tr"` Defined in: [src/utils/interfaces.ts:229](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L229) *** ### tt > **tt**: `"tt"` Defined in: [src/utils/interfaces.ts:230](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L230) *** ### tv > **tv**: `"tv"` Defined in: [src/utils/interfaces.ts:231](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L231) *** ### tw > **tw**: `"tw"` Defined in: [src/utils/interfaces.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L232) *** ### tz > **tz**: `"tz"` Defined in: [src/utils/interfaces.ts:233](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L233) *** ### ua > **ua**: `"ua"` Defined in: [src/utils/interfaces.ts:234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L234) *** ### ug > **ug**: `"ug"` Defined in: [src/utils/interfaces.ts:235](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L235) *** ### um > **um**: `"um"` Defined in: [src/utils/interfaces.ts:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L236) *** ### us > **us**: `"us"` Defined in: [src/utils/interfaces.ts:237](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L237) *** ### uy > **uy**: `"uy"` Defined in: [src/utils/interfaces.ts:238](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L238) *** ### uz > **uz**: `"uz"` Defined in: [src/utils/interfaces.ts:239](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L239) *** ### va > **va**: `"va"` Defined in: [src/utils/interfaces.ts:240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L240) *** ### vc > **vc**: `"vc"` Defined in: [src/utils/interfaces.ts:241](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L241) *** ### ve > **ve**: `"ve"` Defined in: [src/utils/interfaces.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L242) *** ### vg > **vg**: `"vg"` Defined in: [src/utils/interfaces.ts:243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L243) *** ### vi > **vi**: `"vi"` Defined in: [src/utils/interfaces.ts:244](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L244) *** ### vn > **vn**: `"vn"` Defined in: [src/utils/interfaces.ts:245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L245) *** ### vu > **vu**: `"vu"` Defined in: [src/utils/interfaces.ts:246](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L246) *** ### wf > **wf**: `"wf"` Defined in: [src/utils/interfaces.ts:247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L247) *** ### ws > **ws**: `"ws"` Defined in: [src/utils/interfaces.ts:248](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L248) *** ### ye > **ye**: `"ye"` Defined in: [src/utils/interfaces.ts:249](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L249) *** ### yt > **yt**: `"yt"` Defined in: [src/utils/interfaces.ts:250](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L250) *** ### za > **za**: `"za"` Defined in: [src/utils/interfaces.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L251) *** ### zm > **zm**: `"zm"` Defined in: [src/utils/interfaces.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L252) *** ### zw > **zw**: `"zw"` Defined in: [src/utils/interfaces.ts:253](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L253) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/enumerations/UserEducationGrade.md ================================================ [Admin Docs](/) *** # Enumeration: UserEducationGrade Defined in: [src/utils/interfaces.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L259) Represents the education grades for a user. ## Enumeration Members ### GRADE\_1 > **GRADE\_1**: `"grade_1"` Defined in: [src/utils/interfaces.ts:260](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L260) *** ### GRADE\_10 > **GRADE\_10**: `"grade_10"` Defined in: [src/utils/interfaces.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L269) *** ### GRADE\_11 > **GRADE\_11**: `"grade_11"` Defined in: [src/utils/interfaces.ts:270](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L270) *** ### GRADE\_12 > **GRADE\_12**: `"grade_12"` Defined in: [src/utils/interfaces.ts:271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L271) *** ### GRADE\_2 > **GRADE\_2**: `"grade_2"` Defined in: [src/utils/interfaces.ts:261](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L261) *** ### GRADE\_3 > **GRADE\_3**: `"grade_3"` Defined in: [src/utils/interfaces.ts:262](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L262) *** ### GRADE\_4 > **GRADE\_4**: `"grade_4"` Defined in: [src/utils/interfaces.ts:263](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L263) *** ### GRADE\_5 > **GRADE\_5**: `"grade_5"` Defined in: [src/utils/interfaces.ts:264](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L264) *** ### GRADE\_6 > **GRADE\_6**: `"grade_6"` Defined in: [src/utils/interfaces.ts:265](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L265) *** ### GRADE\_7 > **GRADE\_7**: `"grade_7"` Defined in: [src/utils/interfaces.ts:266](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L266) *** ### GRADE\_8 > **GRADE\_8**: `"grade_8"` Defined in: [src/utils/interfaces.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L267) *** ### GRADE\_9 > **GRADE\_9**: `"grade_9"` Defined in: [src/utils/interfaces.ts:268](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L268) *** ### GRADUATE > **GRADUATE**: `"graduate"` Defined in: [src/utils/interfaces.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L272) *** ### KG > **KG**: `"kg"` Defined in: [src/utils/interfaces.ts:273](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L273) *** ### NO\_GRADE > **NO\_GRADE**: `"no_grade"` Defined in: [src/utils/interfaces.ts:274](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L274) *** ### PRE\_KG > **PRE\_KG**: `"pre_kg"` Defined in: [src/utils/interfaces.ts:275](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L275) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/enumerations/UserEmploymentStatus.md ================================================ [Admin Docs](/) *** # Enumeration: UserEmploymentStatus Defined in: [src/utils/interfaces.ts:281](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L281) Represents the employment status of a user. ## Enumeration Members ### FULL\_TIME > **FULL\_TIME**: `"full_time"` Defined in: [src/utils/interfaces.ts:282](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L282) *** ### PART\_TIME > **PART\_TIME**: `"part_time"` Defined in: [src/utils/interfaces.ts:283](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L283) *** ### UNEMPLOYED > **UNEMPLOYED**: `"unemployed"` Defined in: [src/utils/interfaces.ts:284](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L284) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/enumerations/UserMaritalStatus.md ================================================ [Admin Docs](/) *** # Enumeration: UserMaritalStatus Defined in: [src/utils/interfaces.ts:290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L290) Represents the marital status of a user. ## Enumeration Members ### DIVORCED > **DIVORCED**: `"divorced"` Defined in: [src/utils/interfaces.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L291) *** ### ENGAGED > **ENGAGED**: `"engaged"` Defined in: [src/utils/interfaces.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L292) *** ### MARRIED > **MARRIED**: `"married"` Defined in: [src/utils/interfaces.ts:293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L293) *** ### SEPARATED > **SEPARATED**: `"separated"` Defined in: [src/utils/interfaces.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L294) *** ### SINGLE > **SINGLE**: `"single"` Defined in: [src/utils/interfaces.ts:295](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L295) *** ### WIDOWED > **WIDOWED**: `"widowed"` Defined in: [src/utils/interfaces.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L296) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/enumerations/UserNatalSex.md ================================================ [Admin Docs](/) *** # Enumeration: UserNatalSex Defined in: [src/utils/interfaces.ts:302](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L302) Represents the natal sex of a user. ## Enumeration Members ### FEMALE > **FEMALE**: `"female"` Defined in: [src/utils/interfaces.ts:303](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L303) *** ### INTERSEX > **INTERSEX**: `"intersex"` Defined in: [src/utils/interfaces.ts:304](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L304) *** ### MALE > **MALE**: `"male"` Defined in: [src/utils/interfaces.ts:305](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L305) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/enumerations/UserRole.md ================================================ [Admin Docs](/) *** # Enumeration: UserRole Defined in: [src/utils/interfaces.ts:316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L316) Represents the role of a user within the system. ## Enumeration Members ### Administrator > **Administrator**: `"administrator"` Defined in: [src/utils/interfaces.ts:317](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L317) *** ### Regular > **Regular**: `"regular"` Defined in: [src/utils/interfaces.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L318) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/IEvent.md ================================================ [Admin Docs](/) *** # Interface: IEvent Defined in: [src/utils/interfaces.ts:729](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L729) ## Properties ### node > **node**: `object` Defined in: [src/utils/interfaces.ts:730](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L730) #### attachments > **attachments**: [`InterfaceEventAttachmentPg`](InterfaceEventAttachmentPg.md)[] #### createdAt > **createdAt**: `string` #### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) #### description > **description**: `string` #### endAt > **endAt**: `string` #### id > **id**: `ID` #### name > **name**: `string` #### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) #### startAt > **startAt**: `string` #### updatedAt > **updatedAt**: `string` #### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddress.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAddress Defined in: [src/utils/interfaces.ts:1568](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1568) Defines the structure for an address. ## Properties ### city > **city**: `string` Defined in: [src/utils/interfaces.ts:1569](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1569) *** ### countryCode > **countryCode**: `string` Defined in: [src/utils/interfaces.ts:1570](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1570) *** ### dependentLocality > **dependentLocality**: `string` Defined in: [src/utils/interfaces.ts:1571](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1571) *** ### line1 > **line1**: `string` Defined in: [src/utils/interfaces.ts:1572](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1572) *** ### line2 > **line2**: `string` Defined in: [src/utils/interfaces.ts:1573](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1573) *** ### postalCode > **postalCode**: `string` Defined in: [src/utils/interfaces.ts:1574](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1574) *** ### sortingCode > **sortingCode**: `string` Defined in: [src/utils/interfaces.ts:1575](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1575) *** ### state > **state**: `string` Defined in: [src/utils/interfaces.ts:1576](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1576) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementAttachmentPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAdvertisementAttachmentPg Defined in: [src/utils/interfaces.ts:581](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L581) Defines the structure for an advertisement attachment with PostgreSQL-specific fields. ## Properties ### mimeType > **mimeType**: `string` Defined in: [src/utils/interfaces.ts:582](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L582) *** ### url > **url**: `string` Defined in: [src/utils/interfaces.ts:583](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L583) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceAdvertisementPg Defined in: [src/utils/interfaces.ts:563](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L563) Defines the structure for an advertisement with PostgreSQL-specific fields. ## Properties ### attachments > **attachments**: [`InterfaceAdvertisementAttachmentPg`](InterfaceAdvertisementAttachmentPg.md)[] Defined in: [src/utils/interfaces.ts:575](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L575) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:570](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L570) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:572](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L572) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:566](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L566) *** ### endAt > **endAt**: `string` Defined in: [src/utils/interfaces.ts:569](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L569) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:564](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L564) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:565](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L565) *** ### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) Defined in: [src/utils/interfaces.ts:574](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L574) *** ### startAt > **startAt**: `string` Defined in: [src/utils/interfaces.ts:568](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L568) *** ### type > **type**: [`AdvertisementTypePg`](../enumerations/AdvertisementTypePg.md) Defined in: [src/utils/interfaces.ts:567](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L567) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:571](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L571) *** ### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:573](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L573) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceBaseEvent.md ================================================ [Admin Docs](/) *** # Interface: InterfaceBaseEvent Defined in: [src/utils/interfaces.ts:382](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L382) Base interface for common event properties. ## Extended by - [`InterfaceQueryOrganizationEventListItem`](InterfaceQueryOrganizationEventListItem.md) ## Properties ### \_id > **\_id**: `string` Defined in: [src/utils/interfaces.ts:383](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L383) *** ### allDay > **allDay**: `boolean` Defined in: [src/utils/interfaces.ts:391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L391) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:385](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L385) *** ### endDate > **endDate**: `string` Defined in: [src/utils/interfaces.ts:387](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L387) *** ### endTime > **endTime**: `string` Defined in: [src/utils/interfaces.ts:390](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L390) *** ### location > **location**: `string` Defined in: [src/utils/interfaces.ts:388](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L388) *** ### recurring > **recurring**: `boolean` Defined in: [src/utils/interfaces.ts:392](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L392) *** ### startDate > **startDate**: `string` Defined in: [src/utils/interfaces.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L386) *** ### startTime > **startTime**: `string` Defined in: [src/utils/interfaces.ts:389](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L389) *** ### title > **title**: `string` Defined in: [src/utils/interfaces.ts:384](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L384) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCampaignInfo Defined in: [src/utils/interfaces.ts:1315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1315) Defines the structure for campaign information. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1321](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1321) *** ### currencyCode > **currencyCode**: `string` Defined in: [src/utils/interfaces.ts:1322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1322) *** ### endAt > **endAt**: `Date` Defined in: [src/utils/interfaces.ts:1320](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1320) *** ### fundingRaised? > `optional` **fundingRaised**: `number` Defined in: [src/utils/interfaces.ts:1323](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1323) *** ### goalAmount > **goalAmount**: `number` Defined in: [src/utils/interfaces.ts:1318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1318) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1316) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1317](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1317) *** ### startAt > **startAt**: `Date` Defined in: [src/utils/interfaces.ts:1319](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1319) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfoPG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCampaignInfoPG Defined in: [src/utils/interfaces.ts:1274](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1274) Defines the structure for campaign information with PostgreSQL-specific fields. ## Properties ### currency > **currency**: `string` Defined in: [src/utils/interfaces.ts:1279](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1279) *** ### endDate > **endDate**: `Date` Defined in: [src/utils/interfaces.ts:1278](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1278) *** ### goal > **goal**: `number` Defined in: [src/utils/interfaces.ts:1276](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1276) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1275](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1275) *** ### startDate > **startDate**: `Date` Defined in: [src/utils/interfaces.ts:1277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1277) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatMessagePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceChatMessagePg Defined in: [src/utils/interfaces.ts:637](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L637) Defines the structure for a chat message with PostgreSQL-specific fields. ## Properties ### body > **body**: `string` Defined in: [src/utils/interfaces.ts:639](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L639) *** ### chat > **chat**: [`InterfaceChatPg`](InterfaceChatPg.md) Defined in: [src/utils/interfaces.ts:640](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L640) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:641](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L641) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:642](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L642) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:638](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L638) *** ### parentMessage > **parentMessage**: `InterfaceChatMessagePg` Defined in: [src/utils/interfaces.ts:643](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L643) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:644](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L644) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceChatPg Defined in: [src/utils/interfaces.ts:621](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L621) Defines the structure for a chat with PostgreSQL-specific fields. ## Properties ### avatarMimeType > **avatarMimeType**: `string` Defined in: [src/utils/interfaces.ts:625](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L625) *** ### avatarURL > **avatarURL**: `string` Defined in: [src/utils/interfaces.ts:626](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L626) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:627](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L627) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:629](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L629) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:624](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L624) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:622](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L622) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:623](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L623) *** ### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) Defined in: [src/utils/interfaces.ts:631](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L631) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:628](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L628) *** ### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:630](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L630) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceComment.md ================================================ [Admin Docs](/) *** # Interface: InterfaceComment Defined in: [src/utils/interfaces.ts:1618](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1618) ## Properties ### body > **body**: `string` Defined in: [src/utils/interfaces.ts:1620](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1620) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1626](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1626) *** ### creator > **creator**: `object` Defined in: [src/utils/interfaces.ts:1621](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1621) #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### downVotesCount > **downVotesCount**: `number` Defined in: [src/utils/interfaces.ts:1628](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1628) *** ### hasUserVoted? > `optional` **hasUserVoted**: `object` Defined in: [src/utils/interfaces.ts:1629](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1629) #### hasVoted > **hasVoted**: `boolean` #### voteType > **voteType**: [`VoteType`](../type-aliases/VoteType.md) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1619](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1619) *** ### upVotesCount > **upVotesCount**: `number` Defined in: [src/utils/interfaces.ts:1627](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1627) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCommentEdge.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCommentEdge Defined in: [src/utils/interfaces.ts:1635](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1635) ## Properties ### node > **node**: `object` Defined in: [src/utils/interfaces.ts:1636](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1636) #### body > **body**: `string` #### createdAt > **createdAt**: `string` #### creator > **creator**: `object` ##### creator.avatarURL? > `optional` **avatarURL**: `string` ##### creator.id > **id**: `string` ##### creator.name > **name**: `string` #### downVotesCount > **downVotesCount**: `number` #### hasUserVoted? > `optional` **hasUserVoted**: `object` ##### hasUserVoted.hasVoted > **hasVoted**: `boolean` ##### hasUserVoted.voteType > **voteType**: [`VoteType`](../type-aliases/VoteType.md) #### id > **id**: `string` #### upVotesCount > **upVotesCount**: `number` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreateFund Defined in: [src/utils/interfaces.ts:1582](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1582) Defines the structure for creating a fund. ## Properties ### fundName > **fundName**: `string` Defined in: [src/utils/interfaces.ts:1583](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1583) *** ### fundRef > **fundRef**: `string` Defined in: [src/utils/interfaces.ts:1584](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1584) *** ### isArchived > **isArchived**: `boolean` Defined in: [src/utils/interfaces.ts:1586](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1586) *** ### isDefault > **isDefault**: `boolean` Defined in: [src/utils/interfaces.ts:1585](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1585) *** ### isTaxDeductible > **isTaxDeductible**: `boolean` Defined in: [src/utils/interfaces.ts:1587](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1587) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreatePledge Defined in: [src/utils/interfaces.ts:1657](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1657) Defines the structure for creating a pledge. ## Properties ### pledgeAmount > **pledgeAmount**: `number` Defined in: [src/utils/interfaces.ts:1659](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1659) *** ### pledgeCurrency > **pledgeCurrency**: `string` Defined in: [src/utils/interfaces.ts:1660](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1660) *** ### pledgeUsers > **pledgeUsers**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)[] Defined in: [src/utils/interfaces.ts:1658](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1658) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateVolunteerGroup.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCreateVolunteerGroup Defined in: [src/utils/interfaces.ts:1762](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1762) Defines the structure for creating a volunteer group. ## Properties ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:1764](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1764) *** ### leader > **leader**: [`InterfaceUserInfo`](InterfaceUserInfo.md) Defined in: [src/utils/interfaces.ts:1765](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1765) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1763](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1763) *** ### volunteersRequired > **volunteersRequired**: `number` Defined in: [src/utils/interfaces.ts:1766](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1766) *** ### volunteerUsers > **volunteerUsers**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)[] Defined in: [src/utils/interfaces.ts:1767](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1767) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCurrentUserTypePG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCurrentUserTypePG Defined in: [src/utils/interfaces.ts:357](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L357) Defines the structure for the current user type with PostgreSQL-specific fields. ## Properties ### currentUser > **currentUser**: `object` Defined in: [src/utils/interfaces.ts:358](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L358) #### emailAddress > **emailAddress**: `string` #### id > **id**: `string` #### name > **name**: `string` #### role > **role**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCustomFieldData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceCustomFieldData Defined in: [src/utils/interfaces.ts:1691](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1691) Defines the structure for custom field data. ## Properties ### id? > `optional` **id**: `string` Defined in: [src/utils/interfaces.ts:1692](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1692) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1693](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1693) *** ### organizationId? > `optional` **organizationId**: `string` Defined in: [src/utils/interfaces.ts:1695](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1695) *** ### type > **type**: `string` Defined in: [src/utils/interfaces.ts:1694](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1694) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventAttachmentPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventAttachmentPg Defined in: [src/utils/interfaces.ts:748](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L748) Defines the structure for an event attachment with PostgreSQL-specific fields. ## Properties ### mimeType > **mimeType**: `string` Defined in: [src/utils/interfaces.ts:749](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L749) *** ### url > **url**: `string` Defined in: [src/utils/interfaces.ts:750](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L750) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceEventVolunteerInfo Defined in: [src/utils/interfaces.ts:1701](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1701) Defines the structure for event volunteer information. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1709](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1709) *** ### creator > **creator**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md) Defined in: [src/utils/interfaces.ts:1722](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1722) *** ### event > **event**: `object` Defined in: [src/utils/interfaces.ts:1712](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1712) #### baseEvent? > `optional` **baseEvent**: `object` ##### baseEvent.id > **id**: `string` #### id > **id**: `string` #### name > **name**: `string` #### recurrenceRule? > `optional` **recurrenceRule**: `object` ##### recurrenceRule.id > **id**: `string` *** ### groups > **groups**: `object`[] Defined in: [src/utils/interfaces.ts:1724](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1724) #### description > **description**: `string` #### id > **id**: `string` #### name > **name**: `string` #### volunteers > **volunteers**: `object`[] *** ### hasAccepted > **hasAccepted**: `boolean` Defined in: [src/utils/interfaces.ts:1703](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1703) *** ### hoursVolunteered > **hoursVolunteered**: `number` Defined in: [src/utils/interfaces.ts:1705](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1705) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1702](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1702) *** ### isInstanceException > **isInstanceException**: `boolean` Defined in: [src/utils/interfaces.ts:1708](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1708) *** ### isPublic > **isPublic**: `boolean` Defined in: [src/utils/interfaces.ts:1706](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1706) *** ### isTemplate > **isTemplate**: `boolean` Defined in: [src/utils/interfaces.ts:1707](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1707) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:1710](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1710) *** ### updater > **updater**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md) Defined in: [src/utils/interfaces.ts:1723](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1723) *** ### user > **user**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md) Defined in: [src/utils/interfaces.ts:1711](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1711) *** ### volunteerStatus > **volunteerStatus**: `"accepted"` \| `"rejected"` \| `"pending"` Defined in: [src/utils/interfaces.ts:1704](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1704) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFundInfo Defined in: [src/utils/interfaces.ts:1285](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1285) Defines the structure for fund information. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1292) *** ### creator > **creator**: `object` Defined in: [src/utils/interfaces.ts:1294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1294) #### name > **name**: `string` *** ### edges > **edges**: `object` Defined in: [src/utils/interfaces.ts:1299](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1299) #### node > **node**: `object` ##### node.createdAt > **createdAt**: `string` ##### node.currency > **currency**: `string` ##### node.endDate > **endDate**: `string` ##### node.fundingGoal > **fundingGoal**: `number` ##### node.id > **id**: `string` ##### node.name > **name**: `string` ##### node.startDate > **startDate**: `string` *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1286](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1286) *** ### isArchived > **isArchived**: `boolean` Defined in: [src/utils/interfaces.ts:1290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1290) *** ### isDefault > **isDefault**: `boolean` Defined in: [src/utils/interfaces.ts:1291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1291) *** ### isTaxDeductible > **isTaxDeductible**: `boolean` Defined in: [src/utils/interfaces.ts:1289](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1289) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1287](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1287) *** ### organization > **organization**: `object` Defined in: [src/utils/interfaces.ts:1295](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1295) #### name > **name**: `string` *** ### organizationId > **organizationId**: `string` Defined in: [src/utils/interfaces.ts:1293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1293) *** ### refrenceNumber > **refrenceNumber**: `string` Defined in: [src/utils/interfaces.ts:1288](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1288) *** ### updater > **updater**: `object` Defined in: [src/utils/interfaces.ts:1296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1296) #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceFundPg Defined in: [src/utils/interfaces.ts:772](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L772) Defines the structure for a fund with PostgreSQL-specific fields. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:776](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L776) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:778](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L778) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:773](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L773) *** ### isTaxDeductible > **isTaxDeductible**: `boolean` Defined in: [src/utils/interfaces.ts:780](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L780) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:774](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L774) *** ### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) Defined in: [src/utils/interfaces.ts:775](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L775) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:777](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L777) *** ### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:779](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L779) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMapType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMapType Defined in: [src/utils/interfaces.ts:1684](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1684) Defines a generic map type where keys and values are strings. ## Indexable \[`key`: `string`\]: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMemberInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMemberInfo Defined in: [src/utils/interfaces.ts:408](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L408) Defines the structure for member information. ## Properties ### \_id > **\_id**: `string` Defined in: [src/utils/interfaces.ts:409](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L409) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:414](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L414) *** ### email > **email**: `string` Defined in: [src/utils/interfaces.ts:412](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L412) *** ### firstName > **firstName**: `string` Defined in: [src/utils/interfaces.ts:410](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L410) *** ### image > **image**: `string` Defined in: [src/utils/interfaces.ts:413](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L413) *** ### lastName > **lastName**: `string` Defined in: [src/utils/interfaces.ts:411](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L411) *** ### organizationsBlockedBy > **organizationsBlockedBy**: `object`[] Defined in: [src/utils/interfaces.ts:415](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L415) #### \_id > **\_id**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMembersList.md ================================================ [Admin Docs](/) *** # Interface: InterfaceMembersList Defined in: [src/utils/interfaces.ts:398](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L398) Defines the structure for a list of organizations with their members. ## Properties ### organizations > **organizations**: `object`[] Defined in: [src/utils/interfaces.ts:399](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L399) #### \_id > **\_id**: `string` #### members > **members**: [`InterfaceMemberInfo`](InterfaceMemberInfo.md)[] ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgConnectionInfoType Defined in: [src/utils/interfaces.ts:423](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L423) Defines the structure for organization connection information. ## Properties ### \_id > **\_id**: `string` Defined in: [src/utils/interfaces.ts:424](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L424) *** ### address > **address**: [`InterfaceAddress`](InterfaceAddress.md) Defined in: [src/utils/interfaces.ts:439](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L439) *** ### admins > **admins**: `object`[] Defined in: [src/utils/interfaces.ts:435](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L435) #### \_id > **\_id**: `string` *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:438](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L438) *** ### creator > **creator**: `object` Defined in: [src/utils/interfaces.ts:426](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L426) #### \_id > **\_id**: `string` #### firstName > **firstName**: `string` #### lastName > **lastName**: `string` *** ### image > **image**: `string` Defined in: [src/utils/interfaces.ts:425](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L425) *** ### members > **members**: `object`[] Defined in: [src/utils/interfaces.ts:432](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L432) #### \_id > **\_id**: `string` *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:431](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L431) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoTypePG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgConnectionInfoTypePG Defined in: [src/utils/interfaces.ts:445](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L445) Defines the structure for organization connection information with PostgreSQL-specific fields. ## Properties ### organizations > **organizations**: [`InterfaceOrgInfoTypePG`](InterfaceOrgInfoTypePG.md)[] Defined in: [src/utils/interfaces.ts:446](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L446) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgInfoTypePG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrgInfoTypePG Defined in: [src/utils/interfaces.ts:452](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L452) Defines the structure for organization information with PostgreSQL-specific fields. ## Properties ### addressLine1 > **addressLine1**: `string` Defined in: [src/utils/interfaces.ts:455](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L455) *** ### avatarURL > **avatarURL**: `string` Defined in: [src/utils/interfaces.ts:457](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L457) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:458](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L458) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:456](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L456) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:453](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L453) *** ### isMember? > `optional` **isMember**: `boolean` Defined in: [src/utils/interfaces.ts:469](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L469) *** ### members? > `optional` **members**: `object` Defined in: [src/utils/interfaces.ts:460](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L460) #### edges > **edges**: `object`[] #### id? > `optional` **id**: `string` *** ### membersCount? > `optional` **membersCount**: `number` Defined in: [src/utils/interfaces.ts:459](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L459) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:454](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L454) *** ### role > **role**: `string` Defined in: [src/utils/interfaces.ts:468](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L468) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationAdvertisementsConnectionEdgePg Defined in: [src/utils/interfaces.ts:597](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L597) Defines the structure for an edge in the organization advertisements connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:598](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L598) *** ### node > **node**: [`InterfaceAdvertisementPg`](InterfaceAdvertisementPg.md) Defined in: [src/utils/interfaces.ts:599](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L599) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationAdvertisementsConnectionPg Defined in: [src/utils/interfaces.ts:589](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L589) Defines the structure for a connection of organization advertisements with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationAdvertisementsConnectionEdgePg`](InterfaceOrganizationAdvertisementsConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:590](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L590) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L591) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationBlockedUsersConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationBlockedUsersConnectionEdgePg Defined in: [src/utils/interfaces.ts:605](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L605) Defines the structure for an edge in the organization blocked users connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:606](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L606) *** ### node > **node**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:607](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L607) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationBlockedUsersConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationBlockedUsersConnectionPg Defined in: [src/utils/interfaces.ts:613](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L613) Defines the structure for a connection of organization blocked users with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationBlockedUsersConnectionEdgePg`](InterfaceOrganizationBlockedUsersConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:614](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L614) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:615](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L615) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationEventsConnectionEdgePg Defined in: [src/utils/interfaces.ts:724](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L724) Defines the structure for an edge in the organization events connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:725](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L725) *** ### node > **node**: [`IEvent`](IEvent.md) Defined in: [src/utils/interfaces.ts:726](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L726) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationEventsConnectionPg Defined in: [src/utils/interfaces.ts:716](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L716) Defines the structure for a connection of organization events with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationEventsConnectionEdgePg`](InterfaceOrganizationEventsConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:717](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L717) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:718](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L718) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationFundsConnectionEdgePg Defined in: [src/utils/interfaces.ts:764](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L764) Defines the structure for an edge in the organization funds connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:765](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L765) *** ### node > **node**: [`InterfaceFundPg`](InterfaceFundPg.md) Defined in: [src/utils/interfaces.ts:766](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L766) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationFundsConnectionPg Defined in: [src/utils/interfaces.ts:756](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L756) Defines the structure for a connection of organization funds with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationFundsConnectionEdgePg`](InterfaceOrganizationFundsConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:757](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L757) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:758](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L758) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationMembersConnectionEdgePg Defined in: [src/utils/interfaces.ts:794](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L794) Defines the structure for an edge in the organization members connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:795](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L795) *** ### node > **node**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:796](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L796) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationMembersConnectionPg Defined in: [src/utils/interfaces.ts:786](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L786) Defines the structure for a connection of organization members with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationMembersConnectionEdgePg`](InterfaceOrganizationMembersConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:787](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L787) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:788](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L788) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationPg Defined in: [src/utils/interfaces.ts:954](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L954) Defines the structure for an organization with PostgreSQL-specific fields. ## Properties ### organization > **organization**: `object` Defined in: [src/utils/interfaces.ts:955](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L955) #### addressLine1 > **addressLine1**: `string` #### addressLine2 > **addressLine2**: `string` #### adminsCount > **adminsCount**: `number` #### advertisements > **advertisements**: [`InterfaceOrganizationAdvertisementsConnectionPg`](InterfaceOrganizationAdvertisementsConnectionPg.md) #### avatarMimeType > **avatarMimeType**: `string` #### avatarURL > **avatarURL**: `string` #### blockedUsers > **blockedUsers**: [`InterfaceOrganizationBlockedUsersConnectionPg`](InterfaceOrganizationBlockedUsersConnectionPg.md) #### chats > **chats**: `InterfaceOrganizationChatsConnectionPg` #### city > **city**: `string` #### countryCode > **countryCode**: [`Iso3166Alpha2CountryCode`](../enumerations/Iso3166Alpha2CountryCode.md) #### createdAt > **createdAt**: `Date` #### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) #### description > **description**: `string` #### events > **events**: [`InterfaceOrganizationEventsConnectionPg`](InterfaceOrganizationEventsConnectionPg.md) #### funds > **funds**: [`InterfaceOrganizationFundsConnectionPg`](InterfaceOrganizationFundsConnectionPg.md) #### id > **id**: `string` #### members > **members**: [`InterfaceOrganizationMembersConnectionPg`](InterfaceOrganizationMembersConnectionPg.md) #### membersCount > **membersCount**: `number` #### name > **name**: `string` #### pinnedPosts > **pinnedPosts**: [`InterfaceOrganizationPinnedPostsConnectionPg`](InterfaceOrganizationPinnedPostsConnectionPg.md) #### pinnedPostsCount > **pinnedPostsCount**: `number` #### posts > **posts**: [`InterfaceOrganizationPostsConnectionPg`](InterfaceOrganizationPostsConnectionPg.md) #### postsCount > **postsCount**: `number` #### tagFolders > **tagFolders**: [`InterfaceOrganizationTagFoldersConnectionPg`](InterfaceOrganizationTagFoldersConnectionPg.md) #### tags > **tags**: [`InterfaceOrganizationTagsConnectionPg`](InterfaceOrganizationTagsConnectionPg.md) #### updatedAt > **updatedAt**: `Date` #### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) #### venues > **venues**: [`InterfaceOrganizationVenuesConnectionPg`](InterfaceOrganizationVenuesConnectionPg.md) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationPinnedPostsConnectionEdgePg Defined in: [src/utils/interfaces.ts:810](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L810) Defines the structure for an edge in the organization pinned posts connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:811](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L811) *** ### node > **node**: [`InterfacePostPg`](InterfacePostPg.md) Defined in: [src/utils/interfaces.ts:812](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L812) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationPinnedPostsConnectionPg Defined in: [src/utils/interfaces.ts:802](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L802) Defines the structure for a connection of organization pinned posts with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationPinnedPostsConnectionEdgePg`](InterfaceOrganizationPinnedPostsConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:803](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L803) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:804](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L804) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationPostsConnectionEdgePg Defined in: [src/utils/interfaces.ts:843](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L843) Defines the structure for an edge in the organization posts connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:844](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L844) *** ### node > **node**: [`InterfacePostPg`](InterfacePostPg.md) Defined in: [src/utils/interfaces.ts:845](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L845) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationPostsConnectionPg Defined in: [src/utils/interfaces.ts:835](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L835) Defines the structure for a connection of organization posts with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationPostsConnectionEdgePg`](InterfaceOrganizationPostsConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:836](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L836) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:837](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L837) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationTagFoldersConnectionEdgePg Defined in: [src/utils/interfaces.ts:859](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L859) Defines the structure for an edge in the organization tag folders connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:860](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L860) *** ### node > **node**: [`InterfaceTagFolderPg`](InterfaceTagFolderPg.md) Defined in: [src/utils/interfaces.ts:861](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L861) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationTagFoldersConnectionPg Defined in: [src/utils/interfaces.ts:851](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L851) Defines the structure for a connection of organization tag folders with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationTagFoldersConnectionEdgePg`](InterfaceOrganizationTagFoldersConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:852](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L852) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:853](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L853) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationTagsConnectionEdgePg Defined in: [src/utils/interfaces.ts:888](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L888) Defines the structure for an edge in the organization tags connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:889](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L889) *** ### node > **node**: [`InterfaceTagPg`](InterfaceTagPg.md) Defined in: [src/utils/interfaces.ts:890](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L890) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationTagsConnectionPg Defined in: [src/utils/interfaces.ts:880](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L880) Defines the structure for a connection of organization tags with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationTagsConnectionEdgePg`](InterfaceOrganizationTagsConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:881](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L881) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:882](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L882) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionEdgePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationVenuesConnectionEdgePg Defined in: [src/utils/interfaces.ts:917](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L917) Defines the structure for an edge in the organization venues connection with PostgreSQL-specific fields. ## Properties ### cursor > **cursor**: `string` Defined in: [src/utils/interfaces.ts:918](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L918) *** ### node > **node**: [`InterfaceVenuePg`](InterfaceVenuePg.md) Defined in: [src/utils/interfaces.ts:919](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L919) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationVenuesConnectionPg Defined in: [src/utils/interfaces.ts:909](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L909) Defines the structure for a connection of organization venues with PostgreSQL-specific fields. ## Properties ### edges > **edges**: [`InterfaceOrganizationVenuesConnectionEdgePg`](InterfaceOrganizationVenuesConnectionEdgePg.md)[] Defined in: [src/utils/interfaces.ts:910](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L910) *** ### pageInfo > **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) Defined in: [src/utils/interfaces.ts:911](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L911) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePageInfoPg.md ================================================ [Admin Docs](/) *** # Interface: InterfacePageInfoPg Defined in: [src/utils/interfaces.ts:520](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L520) Defines the structure for pagination information in PostgreSQL-backed connections. ## Properties ### endCursor > **endCursor**: `string` Defined in: [src/utils/interfaces.ts:521](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L521) *** ### hasNextPage > **hasNextPage**: `boolean` Defined in: [src/utils/interfaces.ts:522](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L522) *** ### hasPreviousPage > **hasPreviousPage**: `boolean` Defined in: [src/utils/interfaces.ts:523](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L523) *** ### startCursor > **startCursor**: `string` Defined in: [src/utils/interfaces.ts:524](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L524) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePaginationArgs.md ================================================ [Admin Docs](/) *** # Interface: InterfacePaginationArgs Defined in: [src/utils/interfaces.ts:944](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L944) Defines the arguments for pagination. ## Properties ### after > **after**: `string` Defined in: [src/utils/interfaces.ts:945](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L945) *** ### before > **before**: `string` Defined in: [src/utils/interfaces.ts:946](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L946) *** ### first > **first**: `number` Defined in: [src/utils/interfaces.ts:947](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L947) *** ### last > **last**: `number` Defined in: [src/utils/interfaces.ts:948](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L948) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfacePledgeInfo Defined in: [src/utils/interfaces.ts:1329](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1329) Defines the structure for pledge information. ## Properties ### amount > **amount**: `number` Defined in: [src/utils/interfaces.ts:1338](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1338) *** ### campaign? > `optional` **campaign**: `object` Defined in: [src/utils/interfaces.ts:1331](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1331) #### currencyCode > **currencyCode**: `string` #### endAt > **endAt**: `Date` #### goalAmount > **goalAmount**: `number` #### id > **id**: `string` #### name > **name**: `string` *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1341](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1341) *** ### currency > **currency**: `string` Defined in: [src/utils/interfaces.ts:1340](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1340) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1330](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1330) *** ### note? > `optional` **note**: `string` Defined in: [src/utils/interfaces.ts:1339](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1339) *** ### pledger > **pledger**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md) Defined in: [src/utils/interfaces.ts:1343](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1343) *** ### updatedAt? > `optional` **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:1342](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1342) *** ### users? > `optional` **users**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)[] Defined in: [src/utils/interfaces.ts:1344](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1344) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfoPG.md ================================================ [Admin Docs](/) *** # Interface: InterfacePledgeInfoPG Defined in: [src/utils/interfaces.ts:1350](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1350) Defines the structure for pledge information with PostgreSQL-specific fields. ## Properties ### amount > **amount**: `number` Defined in: [src/utils/interfaces.ts:1359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1359) *** ### campaign? > `optional` **campaign**: `object` Defined in: [src/utils/interfaces.ts:1352](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1352) #### currencyCode > **currencyCode**: `string` #### endDate > **endDate**: `Date` #### goalAmount > **goalAmount**: `number` #### id > **id**: `string` #### name > **name**: `string` *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1361](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1361) *** ### currencyCode > **currencyCode**: `string` Defined in: [src/utils/interfaces.ts:1360](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1360) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1351](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1351) *** ### pledger > **pledger**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md) Defined in: [src/utils/interfaces.ts:1363](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1363) *** ### updatedAt? > `optional` **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:1362](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1362) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostCard.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostCard Defined in: [src/utils/interfaces.ts:1596](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1596) Defines the structure for a post card. ## Properties ### attachmentURL? > `optional` **attachmentURL**: `string` Defined in: [src/utils/interfaces.ts:1608](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1608) *** ### body? > `optional` **body**: `string` Defined in: [src/utils/interfaces.ts:1610](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1610) *** ### commentCount > **commentCount**: `number` Defined in: [src/utils/interfaces.ts:1612](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1612) *** ### creator > **creator**: `object` Defined in: [src/utils/interfaces.ts:1599](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1599) #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### downVoteCount > **downVoteCount**: `number` Defined in: [src/utils/interfaces.ts:1614](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1614) *** ### fetchPosts() > **fetchPosts**: () => `Promise`\<`unknown`\> Defined in: [src/utils/interfaces.ts:1615](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1615) #### Returns `Promise`\<`unknown`\> *** ### hasUserVoted > **hasUserVoted**: [`VoteState`](../type-aliases/VoteState.md) Defined in: [src/utils/interfaces.ts:1604](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1604) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1597](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1597) *** ### isModalView? > `optional` **isModalView**: `boolean` Defined in: [src/utils/interfaces.ts:1598](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1598) *** ### mimeType? > `optional` **mimeType**: `string` Defined in: [src/utils/interfaces.ts:1607](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1607) *** ### pinnedAt? > `optional` **pinnedAt**: `string` Defined in: [src/utils/interfaces.ts:1606](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1606) *** ### postedAt > **postedAt**: `string` Defined in: [src/utils/interfaces.ts:1605](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1605) *** ### text > **text**: `string` Defined in: [src/utils/interfaces.ts:1611](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1611) *** ### title > **title**: `string` Defined in: [src/utils/interfaces.ts:1609](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1609) *** ### upVoteCount > **upVoteCount**: `number` Defined in: [src/utils/interfaces.ts:1613](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1613) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostForm.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostForm Defined in: [src/utils/interfaces.ts:1011](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1011) Defines the structure for a post form. ## Properties ### pinned > **pinned**: `boolean` Defined in: [src/utils/interfaces.ts:1016](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1016) *** ### postinfo > **postinfo**: `string` Defined in: [src/utils/interfaces.ts:1013](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1013) *** ### postphoto > **postphoto**: `string` Defined in: [src/utils/interfaces.ts:1014](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1014) *** ### posttitle > **posttitle**: `string` Defined in: [src/utils/interfaces.ts:1012](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1012) *** ### postvideo > **postvideo**: `string` Defined in: [src/utils/interfaces.ts:1015](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1015) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostPg.md ================================================ [Admin Docs](/) *** # Interface: InterfacePostPg Defined in: [src/utils/interfaces.ts:818](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L818) Defines the structure for a post with PostgreSQL-specific fields. ## Properties ### caption > **caption**: `string` Defined in: [src/utils/interfaces.ts:820](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L820) *** ### commentsCount > **commentsCount**: `number` Defined in: [src/utils/interfaces.ts:821](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L821) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:822](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L822) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:823](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L823) *** ### downVotesCount > **downVotesCount**: `number` Defined in: [src/utils/interfaces.ts:824](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L824) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:819](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L819) *** ### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) Defined in: [src/utils/interfaces.ts:825](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L825) *** ### pinnedAt > **pinnedAt**: `string` Defined in: [src/utils/interfaces.ts:826](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L826) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:828](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L828) *** ### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:829](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L829) *** ### upVotesCount > **upVotesCount**: `number` Defined in: [src/utils/interfaces.ts:827](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L827) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryBlockPageMemberListItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryBlockPageMemberListItem Defined in: [src/utils/interfaces.ts:1388](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1388) Defines the structure for a blocked page member list item returned from a query. ## Properties ### \_id > **\_id**: `string` Defined in: [src/utils/interfaces.ts:1389](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1389) *** ### email > **email**: `string` Defined in: [src/utils/interfaces.ts:1392](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1392) *** ### firstName > **firstName**: `string` Defined in: [src/utils/interfaces.ts:1390](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1390) *** ### lastName > **lastName**: `string` Defined in: [src/utils/interfaces.ts:1391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1391) *** ### organizationsBlockedBy > **organizationsBlockedBy**: `object`[] Defined in: [src/utils/interfaces.ts:1393](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1393) #### \_id > **\_id**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryFundCampaignsPledges Defined in: [src/utils/interfaces.ts:1239](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1239) Defines the structure for a query result containing fund campaigns and their pledges. ## Properties ### currencyCode > **currencyCode**: `string` Defined in: [src/utils/interfaces.ts:1245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1245) *** ### endAt > **endAt**: `Date` Defined in: [src/utils/interfaces.ts:1247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1247) *** ### fundId > **fundId**: `object` Defined in: [src/utils/interfaces.ts:1240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1240) #### name > **name**: `string` *** ### goalAmount > **goalAmount**: `number` Defined in: [src/utils/interfaces.ts:1244](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1244) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1243) *** ### pledges > **pledges**: `object` Defined in: [src/utils/interfaces.ts:1248](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1248) #### edges > **edges**: `object`[] *** ### startAt > **startAt**: `Date` Defined in: [src/utils/interfaces.ts:1246](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1246) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryMembershipRequestsListItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryMembershipRequestsListItem Defined in: [src/utils/interfaces.ts:1666](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1666) Defines the structure for a membership requests list item returned from a query. ## Properties ### organizations > **organizations**: `object`[] Defined in: [src/utils/interfaces.ts:1667](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1667) #### id > **id**: `string` #### membershipRequests > **membershipRequests**: `object`[] ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationAdvertisementListItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationAdvertisementListItem Defined in: [src/utils/interfaces.ts:1179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1179) Defines the structure for an organization advertisement list item returned from a query. ## Properties ### advertisements > **advertisements**: `object` Defined in: [src/utils/interfaces.ts:1180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1180) #### edges > **edges**: `object`[] #### pageInfo > **pageInfo**: `object` ##### pageInfo.endCursor > **endCursor**: `string` ##### pageInfo.hasNextPage > **hasNextPage**: `boolean` ##### pageInfo.hasPreviousPage > **hasPreviousPage**: `boolean` ##### pageInfo.startCursor > **startCursor**: `string` #### totalCount > **totalCount**: `number` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationEventListItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationEventListItem Defined in: [src/utils/interfaces.ts:1380](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1380) Extends InterfaceBaseEvent with additional properties for an organization event list item. ## Extends - [`InterfaceBaseEvent`](InterfaceBaseEvent.md) ## Properties ### \_id > **\_id**: `string` Defined in: [src/utils/interfaces.ts:383](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L383) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`_id`](InterfaceBaseEvent.md#_id) *** ### allDay > **allDay**: `boolean` Defined in: [src/utils/interfaces.ts:391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L391) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`allDay`](InterfaceBaseEvent.md#allday) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:385](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L385) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`description`](InterfaceBaseEvent.md#description) *** ### endDate > **endDate**: `string` Defined in: [src/utils/interfaces.ts:387](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L387) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endDate`](InterfaceBaseEvent.md#enddate) *** ### endTime > **endTime**: `string` Defined in: [src/utils/interfaces.ts:390](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L390) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endTime`](InterfaceBaseEvent.md#endtime) *** ### isPublic > **isPublic**: `boolean` Defined in: [src/utils/interfaces.ts:1381](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1381) *** ### isRegisterable > **isRegisterable**: `boolean` Defined in: [src/utils/interfaces.ts:1382](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1382) *** ### location > **location**: `string` Defined in: [src/utils/interfaces.ts:388](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L388) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`location`](InterfaceBaseEvent.md#location) *** ### recurring > **recurring**: `boolean` Defined in: [src/utils/interfaces.ts:392](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L392) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`recurring`](InterfaceBaseEvent.md#recurring) *** ### startDate > **startDate**: `string` Defined in: [src/utils/interfaces.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L386) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startDate`](InterfaceBaseEvent.md#startdate) *** ### startTime > **startTime**: `string` Defined in: [src/utils/interfaces.ts:389](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L389) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startTime`](InterfaceBaseEvent.md#starttime) *** ### title > **title**: `string` Defined in: [src/utils/interfaces.ts:384](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L384) #### Inherited from [`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`title`](InterfaceBaseEvent.md#title) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationFundCampaigns.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationFundCampaigns Defined in: [src/utils/interfaces.ts:1205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1205) Defines the structure for a query result containing organization fund campaigns. ## Properties ### campaigns > **campaigns**: `object` Defined in: [src/utils/interfaces.ts:1209](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1209) #### edges > **edges**: `object`[] *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1206) *** ### isArchived > **isArchived**: `boolean` Defined in: [src/utils/interfaces.ts:1208](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1208) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1207) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationListObject.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationListObject Defined in: [src/utils/interfaces.ts:1001](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1001) Defines the structure for an organization list object returned from a query. ## Properties ### addressLine1 > **addressLine1**: `string` Defined in: [src/utils/interfaces.ts:1004](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1004) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:1005](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1005) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1002](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1002) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1003](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1003) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationPostListItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationPostListItem Defined in: [src/utils/interfaces.ts:1022](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1022) Defines the structure for an organization post list item returned from a query. ## Properties ### posts > **posts**: `object` Defined in: [src/utils/interfaces.ts:1023](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1023) #### edges > **edges**: `object`[] #### pageInfo > **pageInfo**: `object` ##### pageInfo.endCursor > **endCursor**: `string` ##### pageInfo.hasNextPage > **hasNextPage**: `boolean` ##### pageInfo.hasPreviousPage > **hasPreviousPage**: `boolean` ##### pageInfo.startCursor > **startCursor**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTags.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationUserTags Defined in: [src/utils/interfaces.ts:1134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1134) Defines the structure for a query result containing organization user tags. ## Properties ### userTags > **userTags**: `InterfaceTagNodeData` Defined in: [src/utils/interfaces.ts:1135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1135) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTagsPG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationUserTagsPG Defined in: [src/utils/interfaces.ts:1138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1138) ## Properties ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1139) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1140) *** ### tags > **tags**: `InterfaceTagNodeDataPG` Defined in: [src/utils/interfaces.ts:1141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1141) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryOrganizationsListObject Defined in: [src/utils/interfaces.ts:475](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L475) Defines the structure for an organization object returned from a query. ## Properties ### address > **address**: [`InterfaceAddress`](InterfaceAddress.md) Defined in: [src/utils/interfaces.ts:485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L485) *** ### admins > **admins**: `object`[] Defined in: [src/utils/interfaces.ts:494](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L494) #### \_id > **\_id**: `string` #### createdAt > **createdAt**: `string` #### email > **email**: `string` #### firstName > **firstName**: `string` #### lastName > **lastName**: `string` *** ### blockedUsers > **blockedUsers**: `object`[] Defined in: [src/utils/interfaces.ts:509](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L509) #### \_id > **\_id**: `string` #### email > **email**: `string` #### firstName > **firstName**: `string` #### lastName > **lastName**: `string` *** ### creator > **creator**: `object` Defined in: [src/utils/interfaces.ts:478](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L478) #### email > **email**: `string` #### firstName > **firstName**: `string` #### lastName > **lastName**: `string` *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:484](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L484) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:476](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L476) *** ### image > **image**: `string` Defined in: [src/utils/interfaces.ts:477](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L477) *** ### members > **members**: `object`[] Defined in: [src/utils/interfaces.ts:488](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L488) #### \_id > **\_id**: `string` #### email > **email**: `string` #### firstName > **firstName**: `string` #### lastName > **lastName**: `string` *** ### membershipRequests > **membershipRequests**: `object`[] Defined in: [src/utils/interfaces.ts:501](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L501) #### \_id > **\_id**: `string` #### user > **user**: `object` ##### user.email > **email**: `string` ##### user.firstName > **firstName**: `string` ##### user.lastName > **lastName**: `string` *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:483](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L483) *** ### userRegistrationRequired > **userRegistrationRequired**: `boolean` Defined in: [src/utils/interfaces.ts:486](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L486) *** ### visibleInSearch > **visibleInSearch**: `boolean` Defined in: [src/utils/interfaces.ts:487](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L487) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryUserListItem Defined in: [src/utils/interfaces.ts:1421](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1421) Defines the structure for a user list item returned from a query. ## Properties ### appUserProfile? > `optional` **appUserProfile**: `object` Defined in: [src/utils/interfaces.ts:1469](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1469) #### adminFor? > `optional` **adminFor**: `object`[] #### isSuperAdmin? > `optional` **isSuperAdmin**: `boolean` *** ### avatarURL > **avatarURL**: `string` Defined in: [src/utils/interfaces.ts:1425](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1425) *** ### birthDate > **birthDate**: `string` Defined in: [src/utils/interfaces.ts:1426](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1426) *** ### city > **city**: `string` Defined in: [src/utils/interfaces.ts:1427](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1427) *** ### countryCode > **countryCode**: `string` Defined in: [src/utils/interfaces.ts:1428](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1428) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1429](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1429) *** ### createdOrganizations > **createdOrganizations**: `object`[] Defined in: [src/utils/interfaces.ts:1444](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1444) #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### educationGrade > **educationGrade**: `string` Defined in: [src/utils/interfaces.ts:1431](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1431) *** ### emailAddress > **emailAddress**: `string` Defined in: [src/utils/interfaces.ts:1424](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1424) *** ### employmentStatus > **employmentStatus**: `string` Defined in: [src/utils/interfaces.ts:1432](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1432) *** ### homePhoneNumber > **homePhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:1441](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1441) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1422](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1422) *** ### isEmailAddressVerified > **isEmailAddressVerified**: `boolean` Defined in: [src/utils/interfaces.ts:1433](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1433) *** ### maritalStatus > **maritalStatus**: `string` Defined in: [src/utils/interfaces.ts:1434](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1434) *** ### mobilePhoneNumber > **mobilePhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:1440](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1440) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1423](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1423) *** ### natalSex > **natalSex**: `string` Defined in: [src/utils/interfaces.ts:1435](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1435) *** ### naturalLanguageCode > **naturalLanguageCode**: `string` Defined in: [src/utils/interfaces.ts:1436](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1436) *** ### organizationsWhereMember > **organizationsWhereMember**: `object` Defined in: [src/utils/interfaces.ts:1450](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1450) #### edges > **edges**: `object`[] *** ### postalCode > **postalCode**: `string` Defined in: [src/utils/interfaces.ts:1437](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1437) *** ### role > **role**: `string` Defined in: [src/utils/interfaces.ts:1438](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1438) *** ### state > **state**: `string` Defined in: [src/utils/interfaces.ts:1439](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1439) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:1430](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1430) *** ### workPhoneNumber > **workPhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:1442](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1442) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItemForAdmin.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryUserListItemForAdmin Defined in: [src/utils/interfaces.ts:1475](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1475) ## Properties ### appUserProfile? > `optional` **appUserProfile**: `object` Defined in: [src/utils/interfaces.ts:1542](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1542) #### adminFor? > `optional` **adminFor**: `object`[] #### isSuperAdmin? > `optional` **isSuperAdmin**: `boolean` *** ### avatarURL > **avatarURL**: `string` Defined in: [src/utils/interfaces.ts:1479](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1479) *** ### birthDate > **birthDate**: `string` Defined in: [src/utils/interfaces.ts:1480](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1480) *** ### city > **city**: `string` Defined in: [src/utils/interfaces.ts:1481](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1481) *** ### countryCode > **countryCode**: `string` Defined in: [src/utils/interfaces.ts:1482](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1482) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1483](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1483) *** ### createdOrganizations > **createdOrganizations**: `object`[] Defined in: [src/utils/interfaces.ts:1498](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1498) #### avatarURL? > `optional` **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` *** ### educationGrade > **educationGrade**: `string` Defined in: [src/utils/interfaces.ts:1485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1485) *** ### emailAddress > **emailAddress**: `string` Defined in: [src/utils/interfaces.ts:1478](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1478) *** ### employmentStatus > **employmentStatus**: `string` Defined in: [src/utils/interfaces.ts:1486](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1486) *** ### homePhoneNumber > **homePhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:1495](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1495) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1476](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1476) *** ### isEmailAddressVerified > **isEmailAddressVerified**: `boolean` Defined in: [src/utils/interfaces.ts:1487](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1487) *** ### maritalStatus > **maritalStatus**: `string` Defined in: [src/utils/interfaces.ts:1488](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1488) *** ### mobilePhoneNumber > **mobilePhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:1494](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1494) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1477](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1477) *** ### natalSex > **natalSex**: `string` Defined in: [src/utils/interfaces.ts:1489](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1489) *** ### naturalLanguageCode > **naturalLanguageCode**: `string` Defined in: [src/utils/interfaces.ts:1490](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1490) *** ### organizationsWhereMember > **organizationsWhereMember**: `object` Defined in: [src/utils/interfaces.ts:1504](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1504) #### edges > **edges**: `object`[] *** ### orgsWhereUserIsBlocked? > `optional` **orgsWhereUserIsBlocked**: `object` Defined in: [src/utils/interfaces.ts:1524](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1524) #### edges > **edges**: `object`[] *** ### postalCode > **postalCode**: `string` Defined in: [src/utils/interfaces.ts:1491](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1491) *** ### role > **role**: `string` Defined in: [src/utils/interfaces.ts:1492](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1492) *** ### state > **state**: `string` Defined in: [src/utils/interfaces.ts:1493](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1493) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:1484](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1484) *** ### workPhoneNumber > **workPhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:1496](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1496) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryUserTagChildTags Defined in: [src/utils/interfaces.ts:1147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1147) Defines the structure for a query result containing user tag child tags. ## Properties ### ancestorTags > **ancestorTags**: `object`[] Defined in: [src/utils/interfaces.ts:1150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1150) #### \_id > **\_id**: `string` #### name > **name**: `string` *** ### childTags > **childTags**: `InterfaceTagNodeData` Defined in: [src/utils/interfaces.ts:1149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1149) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1148) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryUserTagsAssignedMembers Defined in: [src/utils/interfaces.ts:1159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1159) Defines the structure for a query result containing user tags and their assigned members. ## Properties ### ancestorTags > **ancestorTags**: `object`[] Defined in: [src/utils/interfaces.ts:1162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1162) #### \_id > **\_id**: `string` #### name > **name**: `string` *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1160) *** ### usersAssignedTo > **usersAssignedTo**: `InterfaceTagMembersData` Defined in: [src/utils/interfaces.ts:1161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1161) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryUserTagsMembersToAssignTo Defined in: [src/utils/interfaces.ts:1171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1171) Defines the structure for a query result containing user tags and members available to assign. ## Properties ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1172) *** ### usersToAssignTo > **usersToAssignTo**: `InterfaceTagMembersData` Defined in: [src/utils/interfaces.ts:1173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1173) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryVenueListItem.md ================================================ [Admin Docs](/) *** # Interface: InterfaceQueryVenueListItem Defined in: [src/utils/interfaces.ts:1551](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1551) Defines the structure for a venue list item returned from a query. ## Properties ### node > **node**: `object` Defined in: [src/utils/interfaces.ts:1552](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1552) #### attachments? > `optional` **attachments**: `object`[] #### capacity? > `optional` **capacity**: `number` #### description > **description**: `string` #### id > **id**: `string` #### image? > `optional` **image**: `string` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagData.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagData Defined in: [src/utils/interfaces.ts:1048](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1048) Defines the structure for tag data. ## Properties ### \_id > **\_id**: `string` Defined in: [src/utils/interfaces.ts:1049](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1049) *** ### ancestorTags > **ancestorTags**: `object`[] Defined in: [src/utils/interfaces.ts:1058](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1058) #### \_id > **\_id**: `string` #### name > **name**: `string` *** ### childTags > **childTags**: `object` Defined in: [src/utils/interfaces.ts:1055](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1055) #### totalCount > **totalCount**: `number` *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1050](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1050) *** ### parentTag > **parentTag**: `object` Defined in: [src/utils/interfaces.ts:1051](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1051) #### \_id > **\_id**: `string` *** ### usersAssignedTo > **usersAssignedTo**: `object` Defined in: [src/utils/interfaces.ts:1052](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1052) #### totalCount > **totalCount**: `number` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagDataPG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagDataPG Defined in: [src/utils/interfaces.ts:1064](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1064) ## Properties ### ancestorTags > **ancestorTags**: `object`[] Defined in: [src/utils/interfaces.ts:1074](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1074) #### id > **id**: `string` #### name > **name**: `string` *** ### childTags > **childTags**: `object` Defined in: [src/utils/interfaces.ts:1071](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1071) #### totalCount > **totalCount**: `number` *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1065](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1065) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1066](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1066) *** ### parentTag > **parentTag**: `object` Defined in: [src/utils/interfaces.ts:1067](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1067) #### id > **id**: `string` *** ### usersAssignedTo > **usersAssignedTo**: `object` Defined in: [src/utils/interfaces.ts:1068](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1068) #### totalCount > **totalCount**: `number` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagFolderPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagFolderPg Defined in: [src/utils/interfaces.ts:867](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L867) Defines the structure for a tag folder with PostgreSQL-specific fields. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:870](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L870) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:872](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L872) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:868](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L868) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:869](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L869) *** ### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) Defined in: [src/utils/interfaces.ts:874](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L874) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:871](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L871) *** ### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:873](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L873) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagPg Defined in: [src/utils/interfaces.ts:896](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L896) Defines the structure for a tag with PostgreSQL-specific fields. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:899](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L899) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:901](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L901) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:897](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L897) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:898](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L898) *** ### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) Defined in: [src/utils/interfaces.ts:903](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L903) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:900](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L900) *** ### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:902](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L902) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserCampaign.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserCampaign Defined in: [src/utils/interfaces.ts:1227](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1227) Defines the structure for a user campaign. ## Properties ### \_id > **\_id**: `string` Defined in: [src/utils/interfaces.ts:1228](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1228) *** ### currency > **currency**: `string` Defined in: [src/utils/interfaces.ts:1233](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1233) *** ### endDate > **endDate**: `Date` Defined in: [src/utils/interfaces.ts:1232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1232) *** ### fundingGoal > **fundingGoal**: `number` Defined in: [src/utils/interfaces.ts:1230](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1230) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1229](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1229) *** ### startDate > **startDate**: `Date` Defined in: [src/utils/interfaces.ts:1231](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1231) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserEvents.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserEvents Defined in: [src/utils/interfaces.ts:1828](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1828) Defines the structure for user-related events with volunteer information. ## Properties ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:1831](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1831) *** ### endAt > **endAt**: `string` Defined in: [src/utils/interfaces.ts:1833](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1833) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1829](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1829) *** ### location > **location**: `string` Defined in: [src/utils/interfaces.ts:1834](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1834) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1830](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1830) *** ### startAt > **startAt**: `string` Defined in: [src/utils/interfaces.ts:1832](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1832) *** ### volunteerGroups > **volunteerGroups**: [`InterfaceVolunteerGroupInfo`](InterfaceVolunteerGroupInfo.md)[] Defined in: [src/utils/interfaces.ts:1835](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1835) *** ### volunteers > **volunteers**: [`InterfaceEventVolunteerInfo`](InterfaceEventVolunteerInfo.md)[] Defined in: [src/utils/interfaces.ts:1836](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1836) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserInfo Defined in: [src/utils/interfaces.ts:369](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L369) Defines the basic information for a user. ## Properties ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/utils/interfaces.ts:373](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L373) *** ### createdAt? > `optional` **createdAt**: `Date` Defined in: [src/utils/interfaces.ts:375](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L375) *** ### emailAddress > **emailAddress**: `string` Defined in: [src/utils/interfaces.ts:372](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L372) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:370](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L370) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:371](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L371) *** ### role? > `optional` **role**: `string` Defined in: [src/utils/interfaces.ts:374](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L374) *** ### updatedAt? > `optional` **updatedAt**: `Date` Defined in: [src/utils/interfaces.ts:376](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L376) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfoPG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserInfoPG Defined in: [src/utils/interfaces.ts:1369](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1369) Defines the structure for user information with PostgreSQL-specific fields. ## Properties ### avatarURL? > `optional` **avatarURL**: `string` Defined in: [src/utils/interfaces.ts:1374](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1374) *** ### firstName? > `optional` **firstName**: `string` Defined in: [src/utils/interfaces.ts:1370](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1370) *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1373](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1373) *** ### lastName? > `optional` **lastName**: `string` Defined in: [src/utils/interfaces.ts:1371](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1371) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1372](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1372) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserListQueryResponse.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserListQueryResponse Defined in: [src/utils/interfaces.ts:1401](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1401) GraphQL response type for user list queries. ## Properties ### allUsers? > `optional` **allUsers**: `object` Defined in: [src/utils/interfaces.ts:1402](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1402) #### edges? > `optional` **edges**: `object`[] #### pageInfo? > `optional` **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserPg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserPg Defined in: [src/utils/interfaces.ts:530](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L530) Defines the structure for a user with PostgreSQL-specific fields. ## Properties ### addressLine1 > **addressLine1**: `string` Defined in: [src/utils/interfaces.ts:531](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L531) *** ### addressLine2 > **addressLine2**: `string` Defined in: [src/utils/interfaces.ts:532](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L532) *** ### avatarMimeType > **avatarMimeType**: `string` Defined in: [src/utils/interfaces.ts:533](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L533) *** ### avatarURL > **avatarURL**: `string` Defined in: [src/utils/interfaces.ts:534](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L534) *** ### birthDate > **birthDate**: `Date` Defined in: [src/utils/interfaces.ts:535](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L535) *** ### city > **city**: `string` Defined in: [src/utils/interfaces.ts:536](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L536) *** ### countryCode > **countryCode**: [`Iso3166Alpha2CountryCode`](../enumerations/Iso3166Alpha2CountryCode.md) Defined in: [src/utils/interfaces.ts:537](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L537) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:538](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L538) *** ### creator > **creator**: `InterfaceUserPg` Defined in: [src/utils/interfaces.ts:539](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L539) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:540](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L540) *** ### educationGrade > **educationGrade**: [`UserEducationGrade`](../enumerations/UserEducationGrade.md) Defined in: [src/utils/interfaces.ts:541](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L541) *** ### emailAddress > **emailAddress**: `string` Defined in: [src/utils/interfaces.ts:542](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L542) *** ### employmentStatus > **employmentStatus**: [`UserEmploymentStatus`](../enumerations/UserEmploymentStatus.md) Defined in: [src/utils/interfaces.ts:543](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L543) *** ### homePhoneNumber > **homePhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:544](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L544) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:545](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L545) *** ### isEmailAddressVerified > **isEmailAddressVerified**: `boolean` Defined in: [src/utils/interfaces.ts:546](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L546) *** ### maritalStatus > **maritalStatus**: [`UserMaritalStatus`](../enumerations/UserMaritalStatus.md) Defined in: [src/utils/interfaces.ts:547](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L547) *** ### mobilePhoneNumber > **mobilePhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:548](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L548) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:549](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L549) *** ### natalSex > **natalSex**: [`UserNatalSex`](../enumerations/UserNatalSex.md) Defined in: [src/utils/interfaces.ts:550](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L550) *** ### naturalLanguageCode > **naturalLanguageCode**: `string` Defined in: [src/utils/interfaces.ts:557](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L557) *** ### postalCode > **postalCode**: `string` Defined in: [src/utils/interfaces.ts:551](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L551) *** ### role > **role**: [`UserRole`](../enumerations/UserRole.md) Defined in: [src/utils/interfaces.ts:552](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L552) *** ### state > **state**: `string` Defined in: [src/utils/interfaces.ts:553](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L553) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:554](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L554) *** ### updater > **updater**: `InterfaceUserPg` Defined in: [src/utils/interfaces.ts:555](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L555) *** ### workPhoneNumber > **workPhoneNumber**: `string` Defined in: [src/utils/interfaces.ts:556](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L556) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserType.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserType Defined in: [src/utils/interfaces.ts:333](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L333) Defines the structure for a basic user type. ## Properties ### user > **user**: `object` Defined in: [src/utils/interfaces.ts:334](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L334) #### email > **email**: `string` #### firstName > **firstName**: `string` #### image > **image**: `string` #### lastName > **lastName**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserTypePG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceUserTypePG Defined in: [src/utils/interfaces.ts:345](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L345) Defines the structure for a user type with PostgreSQL-specific fields. ## Properties ### user > **user**: `object` Defined in: [src/utils/interfaces.ts:346](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L346) #### emailAddress > **emailAddress**: `string` #### id > **id**: `string` #### name > **name**: `string` #### role > **role**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVenuePg.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVenuePg Defined in: [src/utils/interfaces.ts:925](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L925) Defines the structure for a venue with PostgreSQL-specific fields. ## Properties ### attachments? > `optional` **attachments**: `object`[] Defined in: [src/utils/interfaces.ts:930](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L930) #### mimeType > **mimeType**: `string` #### url > **url**: `string` *** ### capacity? > `optional` **capacity**: `number` Defined in: [src/utils/interfaces.ts:929](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L929) *** ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:934](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L934) *** ### creator > **creator**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:936](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L936) *** ### description? > `optional` **description**: `string` Defined in: [src/utils/interfaces.ts:928](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L928) *** ### id > **id**: `ID` Defined in: [src/utils/interfaces.ts:926](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L926) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:927](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L927) *** ### organization > **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md) Defined in: [src/utils/interfaces.ts:938](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L938) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:935](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L935) *** ### updater > **updater**: [`InterfaceUserPg`](InterfaceUserPg.md) Defined in: [src/utils/interfaces.ts:937](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L937) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerGroupInfo Defined in: [src/utils/interfaces.ts:1737](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1737) Defines the structure for volunteer group information. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1747](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1747) *** ### creator > **creator**: [`InterfaceUserInfo`](InterfaceUserInfo.md) Defined in: [src/utils/interfaces.ts:1748](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1748) *** ### description > **description**: `string` Defined in: [src/utils/interfaces.ts:1740](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1740) *** ### event > **event**: `object` Defined in: [src/utils/interfaces.ts:1741](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1741) #### id > **id**: `string` *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1738](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1738) *** ### isInstanceException > **isInstanceException**: `boolean` Defined in: [src/utils/interfaces.ts:1746](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1746) *** ### isTemplate > **isTemplate**: `boolean` Defined in: [src/utils/interfaces.ts:1745](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1745) *** ### leader > **leader**: [`InterfaceUserInfo`](InterfaceUserInfo.md) Defined in: [src/utils/interfaces.ts:1749](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1749) *** ### name > **name**: `string` Defined in: [src/utils/interfaces.ts:1739](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1739) *** ### volunteers > **volunteers**: `object`[] Defined in: [src/utils/interfaces.ts:1750](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1750) #### hasAccepted > **hasAccepted**: `boolean` #### hoursVolunteered > **hoursVolunteered**: `number` #### id > **id**: `string` #### isPublic > **isPublic**: `boolean` #### user > **user**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md) *** ### volunteersRequired > **volunteersRequired**: `number` Defined in: [src/utils/interfaces.ts:1744](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1744) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerMembership.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerMembership Defined in: [src/utils/interfaces.ts:1773](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1773) Defines the structure for volunteer membership information. ## Properties ### createdAt > **createdAt**: `string` Defined in: [src/utils/interfaces.ts:1776](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1776) *** ### createdBy > **createdBy**: `object` Defined in: [src/utils/interfaces.ts:1802](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1802) #### id > **id**: `string` #### name > **name**: `string` *** ### event > **event**: `object` Defined in: [src/utils/interfaces.ts:1778](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1778) #### endAt > **endAt**: `string` #### id > **id**: `string` #### name > **name**: `string` #### recurrenceRule? > `optional` **recurrenceRule**: `object` ##### recurrenceRule.id > **id**: `string` #### startAt > **startAt**: `string` *** ### group? > `optional` **group**: `object` Defined in: [src/utils/interfaces.ts:1798](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1798) #### id > **id**: `string` #### name > **name**: `string` *** ### id > **id**: `string` Defined in: [src/utils/interfaces.ts:1774](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1774) *** ### status > **status**: `string` Defined in: [src/utils/interfaces.ts:1775](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1775) *** ### updatedAt > **updatedAt**: `string` Defined in: [src/utils/interfaces.ts:1777](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1777) *** ### updatedBy > **updatedBy**: `object` Defined in: [src/utils/interfaces.ts:1806](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1806) #### id > **id**: `string` #### name > **name**: `string` *** ### volunteer > **volunteer**: `object` Defined in: [src/utils/interfaces.ts:1787](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1787) #### hasAccepted > **hasAccepted**: `boolean` #### hoursVolunteered > **hoursVolunteered**: `number` #### id > **id**: `string` #### user > **user**: `object` ##### user.avatarURL? > `optional` **avatarURL**: `string` ##### user.emailAddress > **emailAddress**: `string` ##### user.id > **id**: `string` ##### user.name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerRank.md ================================================ [Admin Docs](/) *** # Interface: InterfaceVolunteerRank Defined in: [src/utils/interfaces.ts:1815](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1815) Defines the structure for volunteer ranking information. ## Properties ### hoursVolunteered > **hoursVolunteered**: `number` Defined in: [src/utils/interfaces.ts:1817](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1817) *** ### rank > **rank**: `number` Defined in: [src/utils/interfaces.ts:1816](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1816) *** ### user > **user**: `object` Defined in: [src/utils/interfaces.ts:1818](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1818) #### avatarURL > **avatarURL**: `string` #### id > **id**: `string` #### name > **name**: `string` ================================================ FILE: docs/docs/auto-docs/utils/interfaces/type-aliases/VoteState.md ================================================ [Admin Docs](/) *** # Type Alias: VoteState > **VoteState** = `object` Defined in: [src/utils/interfaces.ts:1591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1591) ## Properties ### hasVoted > **hasVoted**: `boolean` Defined in: [src/utils/interfaces.ts:1591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1591) *** ### voteType > **voteType**: [`VoteType`](VoteType.md) Defined in: [src/utils/interfaces.ts:1591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1591) ================================================ FILE: docs/docs/auto-docs/utils/interfaces/type-aliases/VoteType.md ================================================ [Admin Docs](/) *** # Type Alias: VoteType > **VoteType** = `"up_vote"` \| `"down_vote"` \| `null` Defined in: [src/utils/interfaces.ts:1590](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1590) ================================================ FILE: docs/docs/auto-docs/utils/languages/variables/languageArray.md ================================================ [Admin Docs](/) *** # Variable: languageArray > `const` **languageArray**: `string`[] Defined in: [src/utils/languages.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/languages.ts#L1) ================================================ FILE: docs/docs/auto-docs/utils/languages/variables/languages.md ================================================ [Admin Docs](/) *** # Variable: languages > `const` **languages**: `object`[] Defined in: [src/utils/languages.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/languages.ts#L3) ## Type Declaration ### code > **code**: `string` = `'en'` ### country\_code > **country\_code**: `string` = `'gb'` ### name > **name**: `string` = `'English'` ================================================ FILE: docs/docs/auto-docs/utils/linkValidator/functions/isValidLink.md ================================================ [Admin Docs](/) *** # Function: isValidLink() > **isValidLink**(`link`): `boolean` Defined in: [src/utils/linkValidator.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/linkValidator.ts#L1) ## Parameters ### link `string` ## Returns `boolean` ================================================ FILE: docs/docs/auto-docs/utils/oauth/oauthFlowHandler/functions/handleOAuthLink.md ================================================ [Admin Docs](/) *** # Function: handleOAuthLink() > **handleOAuthLink**(`client`, `provider`, `authorizationCode`, `redirectUri`): `Promise`\<[`InterfaceOAuthLinkResponse`](../../../../types/Auth/auth/interfaces/InterfaceOAuthLinkResponse.md)\> Defined in: [src/utils/oauth/oauthFlowHandler.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/oauth/oauthFlowHandler.ts#L102) Links an existing user account with an OAuth provider. This function associates a user's existing account with an OAuth provider by exchanging the authorization code. This allows users to sign in with multiple OAuth providers or add additional sign-in methods to their account. ## Parameters ### client `ApolloClient`\<`unknown`\> Apollo GraphQL client instance for making API requests ### provider [`OAuthProviderKey`](../../../../types/Auth/auth/type-aliases/OAuthProviderKey.md) OAuth provider to link (e.g., 'GOOGLE', 'GITHUB') ### authorizationCode `string` Authorization code received from OAuth provider callback ### redirectUri `string` Redirect URI used in the OAuth flow for validation ## Returns `Promise`\<[`InterfaceOAuthLinkResponse`](../../../../types/Auth/auth/interfaces/InterfaceOAuthLinkResponse.md)\> Promise that resolves to the linking operation result containing user data with linked OAuth accounts ## Throws Error When GraphQL errors are returned from the server ## Throws Error When no response data is received despite successful request ## Throws ApolloError When network or Apollo Client errors occur ## Example ```typescript const linkResult = await handleOAuthLink( apolloClient, 'GITHUB', 'auth-code-456', 'http://localhost:3000/callback' ); console.log('User ID:', linkResult.id); console.log('Linked accounts:', linkResult.oauthAccounts); ``` ================================================ FILE: docs/docs/auto-docs/utils/oauth/oauthFlowHandler/functions/handleOAuthLogin.md ================================================ [Admin Docs](/) *** # Function: handleOAuthLogin() > **handleOAuthLogin**(`client`, `provider`, `authorizationCode`, `redirectUri`): `Promise`\<[`InterfaceAuthenticationPayload`](../../../../types/Auth/auth/interfaces/InterfaceAuthenticationPayload.md)\> Defined in: [src/utils/oauth/oauthFlowHandler.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/oauth/oauthFlowHandler.ts#L43) Handles OAuth login flow by exchanging an authorization code for authentication tokens. This function performs the OAuth sign-in process by sending the authorization code and other required parameters to the GraphQL mutation. It validates the response and returns the authentication payload containing user data and tokens. ## Parameters ### client `ApolloClient`\<`unknown`\> Apollo GraphQL client instance for making API requests ### provider [`OAuthProviderKey`](../../../../types/Auth/auth/type-aliases/OAuthProviderKey.md) OAuth provider (e.g., 'GOOGLE', 'GITHUB') ### authorizationCode `string` Authorization code received from OAuth provider callback ### redirectUri `string` Redirect URI used in the OAuth flow for validation ## Returns `Promise`\<[`InterfaceAuthenticationPayload`](../../../../types/Auth/auth/interfaces/InterfaceAuthenticationPayload.md)\> Promise that resolves to authentication payload with user data and tokens ## Throws Error When GraphQL errors are returned from the server ## Throws Error When no authentication data is received despite successful request ## Throws ApolloError When network or Apollo Client errors occur ## Example ```typescript const authPayload = await handleOAuthLogin( apolloClient, 'GOOGLE', 'auth-code-123', 'http://localhost:3000/callback' ); console.log(authPayload.user.name); // User's name console.log(authPayload.authenticationToken); // JWT access token ``` ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationSubTagsQuery.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationSubTagsQuery Defined in: [src/utils/organizationTagsUtils.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L100) ## Extends - `InterfaceBaseQueryResult` ## Properties ### data? > `optional` **data**: `object` Defined in: [src/utils/organizationTagsUtils.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L101) #### getChildTags > **getChildTags**: [`InterfaceQueryUserTagChildTags`](../../interfaces/interfaces/InterfaceQueryUserTagChildTags.md) *** ### error? > `optional` **error**: `ApolloError` Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61) #### Inherited from `InterfaceBaseQueryResult.error` *** ### fetchMore() > **fetchMore**: (`options`) => `void` Defined in: [src/utils/organizationTagsUtils.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L104) #### Parameters ##### options `InterfaceBaseFetchMoreOptions`\<\{ `getChildTags`: [`InterfaceQueryUserTagChildTags`](../../interfaces/interfaces/InterfaceQueryUserTagChildTags.md); \}\> #### Returns `void` *** ### loading > **loading**: `boolean` Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60) #### Inherited from `InterfaceBaseQueryResult.loading` *** ### refetch()? > `optional` **refetch**: () => `void` Defined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62) #### Returns `void` #### Inherited from `InterfaceBaseQueryResult.refetch` ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationTagsQuery.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationTagsQuery Defined in: [src/utils/organizationTagsUtils.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L78) ## Extends - `InterfaceBaseQueryResult` ## Properties ### data? > `optional` **data**: `object` Defined in: [src/utils/organizationTagsUtils.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L79) #### organizations > **organizations**: [`InterfaceQueryOrganizationUserTags`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTags.md)[] *** ### error? > `optional` **error**: `ApolloError` Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61) #### Inherited from `InterfaceBaseQueryResult.error` *** ### fetchMore() > **fetchMore**: (`options`) => `void` Defined in: [src/utils/organizationTagsUtils.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L82) #### Parameters ##### options `InterfaceBaseFetchMoreOptions`\<\{ `organizations`: [`InterfaceQueryOrganizationUserTags`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTags.md)[]; \}\> #### Returns `void` *** ### loading > **loading**: `boolean` Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60) #### Inherited from `InterfaceBaseQueryResult.loading` *** ### refetch()? > `optional` **refetch**: () => `void` Defined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62) #### Returns `void` #### Inherited from `InterfaceBaseQueryResult.refetch` ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationTagsQueryPG.md ================================================ [Admin Docs](/) *** # Interface: InterfaceOrganizationTagsQueryPG Defined in: [src/utils/organizationTagsUtils.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L89) ## Extends - `InterfaceBaseQueryResult` ## Properties ### data? > `optional` **data**: `object` Defined in: [src/utils/organizationTagsUtils.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L90) #### organization > **organization**: [`InterfaceQueryOrganizationUserTagsPG`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTagsPG.md) *** ### error? > `optional` **error**: `ApolloError` Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61) #### Inherited from `InterfaceBaseQueryResult.error` *** ### fetchMore() > **fetchMore**: (`options`) => `void` Defined in: [src/utils/organizationTagsUtils.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L93) #### Parameters ##### options `InterfaceBaseFetchMoreOptions`\<\{ `organization`: [`InterfaceQueryOrganizationUserTagsPG`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTagsPG.md); \}\> #### Returns `void` *** ### loading > **loading**: `boolean` Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60) #### Inherited from `InterfaceBaseQueryResult.loading` *** ### refetch()? > `optional` **refetch**: () => `void` Defined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62) #### Returns `void` #### Inherited from `InterfaceBaseQueryResult.refetch` ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagAssignedMembersQuery.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagAssignedMembersQuery Defined in: [src/utils/organizationTagsUtils.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L111) ## Extends - `InterfaceBaseQueryResult` ## Properties ### data? > `optional` **data**: `object` Defined in: [src/utils/organizationTagsUtils.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L112) #### getAssignedUsers > **getAssignedUsers**: [`InterfaceQueryUserTagsAssignedMembers`](../../interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md) *** ### error? > `optional` **error**: `ApolloError` Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61) #### Inherited from `InterfaceBaseQueryResult.error` *** ### fetchMore() > **fetchMore**: (`options`) => `void` Defined in: [src/utils/organizationTagsUtils.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L115) #### Parameters ##### options `InterfaceBaseFetchMoreOptions`\<\{ `getAssignedUsers`: [`InterfaceQueryUserTagsAssignedMembers`](../../interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md); \}\> #### Returns `void` *** ### loading > **loading**: `boolean` Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60) #### Inherited from `InterfaceBaseQueryResult.loading` *** ### refetch()? > `optional` **refetch**: () => `void` Defined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62) #### Returns `void` #### Inherited from `InterfaceBaseQueryResult.refetch` ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagUsersToAssignToQuery.md ================================================ [Admin Docs](/) *** # Interface: InterfaceTagUsersToAssignToQuery Defined in: [src/utils/organizationTagsUtils.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L122) ## Extends - `InterfaceBaseQueryResult` ## Properties ### data? > `optional` **data**: `object` Defined in: [src/utils/organizationTagsUtils.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L123) #### getUsersToAssignTo > **getUsersToAssignTo**: [`InterfaceQueryUserTagsMembersToAssignTo`](../../interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md) *** ### error? > `optional` **error**: `ApolloError` Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61) #### Inherited from `InterfaceBaseQueryResult.error` *** ### fetchMore() > **fetchMore**: (`options`) => `void` Defined in: [src/utils/organizationTagsUtils.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L126) #### Parameters ##### options `InterfaceBaseFetchMoreOptions`\<\{ `getUsersToAssignTo`: [`InterfaceQueryUserTagsMembersToAssignTo`](../../interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md); \}\> #### Returns `void` *** ### loading > **loading**: `boolean` Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60) #### Inherited from `InterfaceBaseQueryResult.loading` *** ### refetch()? > `optional` **refetch**: () => `void` Defined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62) #### Returns `void` #### Inherited from `InterfaceBaseQueryResult.refetch` ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/SortedByType.md ================================================ [Admin Docs](/) *** # Type Alias: SortedByType > **SortedByType** = `"ASCENDING"` \| `"DESCENDING"` Defined in: [src/utils/organizationTagsUtils.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L55) ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/TagActionType.md ================================================ [Admin Docs](/) *** # Type Alias: TagActionType > **TagActionType** = `"assignToTags"` \| `"removeFromTags"` Defined in: [src/utils/organizationTagsUtils.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L52) ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/variables/TAGS_QUERY_DATA_CHUNK_SIZE.md ================================================ [Admin Docs](/) *** # Variable: TAGS\_QUERY\_DATA\_CHUNK\_SIZE > `const` **TAGS\_QUERY\_DATA\_CHUNK\_SIZE**: `10` = `10` Defined in: [src/utils/organizationTagsUtils.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L49) ================================================ FILE: docs/docs/auto-docs/utils/organizationTagsUtils/variables/dataGridStyle.md ================================================ [Admin Docs](/) *** # Variable: dataGridStyle > `const` **dataGridStyle**: `object` Defined in: [src/utils/organizationTagsUtils.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L13) ## Type Declaration #### & .MuiDataGrid-cell:focus > **& .MuiDataGrid-cell:focus**: `object` #### & .MuiDataGrid-cell:focus.outline > **outline**: `string` = `'2px solid #000'` #### & .MuiDataGrid-cell:focus.outlineOffset > **outlineOffset**: `string` = `'-2px'` #### & .MuiDataGrid-main > **& .MuiDataGrid-main**: `object` #### & .MuiDataGrid-main.borderRadius > **borderRadius**: `string` = `'0.1rem'` #### & .MuiDataGrid-root > **& .MuiDataGrid-root**: `object` #### & .MuiDataGrid-root.borderRadius > **borderRadius**: `string` = `'0.1rem'` #### & .MuiDataGrid-row:hover > **& .MuiDataGrid-row:hover**: `object` #### & .MuiDataGrid-row:hover.backgroundColor > **backgroundColor**: `string` = `'transparent'` #### & .MuiDataGrid-row:hover.boxShadow > **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'` #### & .MuiDataGrid-row.Mui-hovered > **& .MuiDataGrid-row.Mui-hovered**: `object` #### & .MuiDataGrid-row.Mui-hovered.backgroundColor > **backgroundColor**: `string` = `'transparent'` #### & .MuiDataGrid-row.Mui-hovered.boxShadow > **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'` #### & .MuiDataGrid-topContainer > **& .MuiDataGrid-topContainer**: `object` #### & .MuiDataGrid-topContainer.position > **position**: `string` = `'fixed'` #### & .MuiDataGrid-topContainer.top > **top**: `number` = `290` #### & .MuiDataGrid-topContainer.zIndex > **zIndex**: `number` = `1` #### & .MuiDataGrid-virtualScrollerContent > **& .MuiDataGrid-virtualScrollerContent**: `object` #### & .MuiDataGrid-virtualScrollerContent.marginTop > **marginTop**: `number` = `6.5` #### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within > **&.MuiDataGrid-root .MuiDataGrid-cell:focus-within**: `object` #### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within.outline > **outline**: `string` = `'none !important'` #### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within > **&.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within**: `object` #### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within.outline > **outline**: `string` = `'none'` ================================================ FILE: docs/docs/auto-docs/utils/passwordValidator/functions/validatePassword.md ================================================ [Admin Docs](/) *** # Function: validatePassword() > **validatePassword**(`password`): `string` Defined in: [src/utils/passwordValidator.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/passwordValidator.ts#L1) ## Parameters ### password `string` ## Returns `string` ================================================ FILE: docs/docs/auto-docs/utils/profileNavigation/functions/resolveProfileNavigation.md ================================================ [Admin Docs](/) *** # Function: resolveProfileNavigation() > **resolveProfileNavigation**(`__namedParameters`): `string` Defined in: [src/utils/profileNavigation.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L10) Resolves the appropriate profile route based on portal context, role, and org id. ## Parameters ### \_\_namedParameters [`InterfaceProfileNavigationOptions`](../interfaces/InterfaceProfileNavigationOptions.md) ## Returns `string` ================================================ FILE: docs/docs/auto-docs/utils/profileNavigation/interfaces/InterfaceProfileNavigationOptions.md ================================================ [Admin Docs](/) *** # Interface: InterfaceProfileNavigationOptions Defined in: [src/utils/profileNavigation.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L3) ## Properties ### portal? > `optional` **portal**: [`ProfilePortal`](../type-aliases/ProfilePortal.md) Defined in: [src/utils/profileNavigation.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L4) *** ### role? > `optional` **role**: `string` Defined in: [src/utils/profileNavigation.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L5) ================================================ FILE: docs/docs/auto-docs/utils/profileNavigation/type-aliases/ProfilePortal.md ================================================ [Admin Docs](/) *** # Type Alias: ProfilePortal > **ProfilePortal** = `"admin"` \| `"user"` Defined in: [src/utils/profileNavigation.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L1) ================================================ FILE: docs/docs/auto-docs/utils/recaptcha/functions/getRecaptchaToken.md ================================================ [Admin Docs](/) *** # Function: getRecaptchaToken() > **getRecaptchaToken**(`siteKey`, `action`): `Promise`\<`string`\> Defined in: [src/utils/recaptcha.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recaptcha.ts#L94) Get a reCAPTCHA token for the specified action ## Parameters ### siteKey `string` The reCAPTCHA site key ### action `string` The action name for this reCAPTCHA request ## Returns `Promise`\<`string`\> Promise that resolves to the reCAPTCHA token ================================================ FILE: docs/docs/auto-docs/utils/recaptcha/functions/loadRecaptchaScript.md ================================================ [Admin Docs](/) *** # Function: loadRecaptchaScript() > **loadRecaptchaScript**(`siteKey`): `Promise`\<`void`\> Defined in: [src/utils/recaptcha.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recaptcha.ts#L21) Load the reCAPTCHA script if not already loaded ## Parameters ### siteKey `string` The reCAPTCHA site key ## Returns `Promise`\<`void`\> Promise that resolves when script is loaded ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/Days.md ================================================ [Admin Docs](/) *** # Variable: Days > `const` **Days**: [`WeekDays`](../../recurrenceTypes/enumerations/WeekDays.md)[] Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L19) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/dayNames.md ================================================ [Admin Docs](/) *** # Variable: dayNames > `const` **dayNames**: `object` Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L42) ## Type Declaration ### FR > **FR**: `string` = `'Friday'` ### MO > **MO**: `string` = `'Monday'` ### SA > **SA**: `string` = `'Saturday'` ### SU > **SU**: `string` = `'Sunday'` ### TH > **TH**: `string` = `'Thursday'` ### TU > **TU**: `string` = `'Tuesday'` ### WE > **WE**: `string` = `'Wednesday'` ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/daysOptions.md ================================================ [Admin Docs](/) *** # Variable: daysOptions > `const` **daysOptions**: `string`[] Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L16) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsAfter.md ================================================ [Admin Docs](/) *** # Variable: endsAfter > `const` **endsAfter**: [`after`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#after) = `RecurrenceEndOption.after` Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L39) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsNever.md ================================================ [Admin Docs](/) *** # Variable: endsNever > `const` **endsNever**: [`never`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#never) = `RecurrenceEndOption.never` Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L37) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsOn.md ================================================ [Admin Docs](/) *** # Variable: endsOn > `const` **endsOn**: [`on`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#on) = `RecurrenceEndOption.on` Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L38) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/frequencies.md ================================================ [Admin Docs](/) *** # Variable: frequencies > `const` **frequencies**: `object` Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L8) ## Type Declaration ### DAILY > **DAILY**: `string` = `'Daily'` ### MONTHLY > **MONTHLY**: `string` = `'Monthly'` ### WEEKLY > **WEEKLY**: `string` = `'Weekly'` ### YEARLY > **YEARLY**: `string` = `'Yearly'` ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/monthNames.md ================================================ [Admin Docs](/) *** # Variable: monthNames > `const` **monthNames**: `string`[] Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L53) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurrenceEndOptions.md ================================================ [Admin Docs](/) *** # Variable: recurrenceEndOptions > `const` **recurrenceEndOptions**: [`RecurrenceEndOption`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md)[] Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L30) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md ================================================ [Admin Docs](/) *** # Enumeration: Frequency Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L22) ## Enumeration Members ### DAILY > **DAILY**: `"DAILY"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L23) *** ### MONTHLY > **MONTHLY**: `"MONTHLY"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L25) *** ### WEEKLY > **WEEKLY**: `"WEEKLY"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L24) *** ### YEARLY > **YEARLY**: `"YEARLY"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L26) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurrenceEndOption.md ================================================ [Admin Docs](/) *** # Enumeration: RecurrenceEndOption Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L41) ## Enumeration Members ### after > **after**: `"after"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L44) *** ### never > **never**: `"never"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L42) *** ### on > **on**: `"on"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L43) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/WeekDays.md ================================================ [Admin Docs](/) *** # Enumeration: WeekDays Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L30) ## Enumeration Members ### FR > **FR**: `"FR"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L36) *** ### MO > **MO**: `"MO"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L32) *** ### SA > **SA**: `"SA"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L37) *** ### SU > **SU**: `"SU"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L31) *** ### TH > **TH**: `"TH"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L35) *** ### TU > **TU**: `"TU"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L33) *** ### WE > **WE**: `"WE"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L34) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md ================================================ [Admin Docs](/) *** # Interface: InterfaceRecurrenceRule Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L7) Recurrence types for event scheduling Based on RFC 5545 (iCalendar) specification ## Properties ### byDay? > `optional` **byDay**: [`WeekDays`](../enumerations/WeekDays.md)[] Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L14) *** ### byMonth? > `optional` **byMonth**: `number`[] Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L15) *** ### byMonthDay? > `optional` **byMonthDay**: `number`[] Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L16) *** ### bySetPos? > `optional` **bySetPos**: `number`[] Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L18) RFC 5545 BYSETPOS: which occurrence of byDay within the month (e.g. [3] = 3rd Monday) *** ### count? > `optional` **count**: `number` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L12) *** ### endDate? > `optional` **endDate**: `Date` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L10) *** ### frequency > **frequency**: [`Frequency`](../enumerations/Frequency.md) Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L8) *** ### interval? > `optional` **interval**: `number` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L9) *** ### never? > `optional` **never**: `boolean` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L13) *** ### recurrenceEndDate? > `optional` **recurrenceEndDate**: `Date` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L11) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/type-aliases/RecurrenceEndOptionType.md ================================================ [Admin Docs](/) *** # Type Alias: RecurrenceEndOptionType > **RecurrenceEndOptionType** = `"never"` \| `"on"` \| `"after"` Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L48) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/areRecurrenceRulesEqual.md ================================================ [Admin Docs](/) *** # Function: areRecurrenceRulesEqual() > **areRecurrenceRulesEqual**(`rule1`, `rule2`): `boolean` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:275](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L275) Checks if two recurrence rules are equal ## Parameters ### rule1 [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) First recurrence rule ### rule2 [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Second recurrence rule ## Returns `boolean` True if rules are equal ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/createDefaultRecurrenceRule.md ================================================ [Admin Docs](/) *** # Function: createDefaultRecurrenceRule() > **createDefaultRecurrenceRule**(`startDate`, `frequency`): [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:223](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L223) Creates a default recurrence rule based on the event start date ## Parameters ### startDate `Date` The event start date ### frequency [`Frequency`](../../recurrenceTypes/enumerations/Frequency.md) The desired frequency ## Returns [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) Default recurrence rule ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/formatRecurrenceForApi.md ================================================ [Admin Docs](/) *** # Function: formatRecurrenceForApi() > **formatRecurrenceForApi**(`recurrence`): `Omit`\<[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `"endDate"`\> & `object` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:305](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L305) Formats a recurrence rule for API submission. Converts Date object to ISO string for `endDate`. ## Parameters ### recurrence [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) The recurrence rule to format. ## Returns `Omit`\<[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `"endDate"`\> & `object` A recurrence rule object suitable for API submission. ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getDayName.md ================================================ [Admin Docs](/) *** # Function: getDayName() > **getDayName**(`dayIndex`): `string` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:377](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L377) Gets the full day name from a day index ## Parameters ### dayIndex `number` The day index (0-6, where 0 is Sunday) ## Returns `string` The full day name ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getEndTypeFromRecurrence.md ================================================ [Admin Docs](/) *** # Function: getEndTypeFromRecurrence() > **getEndTypeFromRecurrence**(`recurrence`): [`RecurrenceEndOptionType`](../../recurrenceTypes/type-aliases/RecurrenceEndOptionType.md) Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L259) Determines the end type from a recurrence rule ## Parameters ### recurrence [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) The recurrence rule ## Returns [`RecurrenceEndOptionType`](../../recurrenceTypes/type-aliases/RecurrenceEndOptionType.md) The end type ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getMonthlyOptions.md ================================================ [Admin Docs](/) *** # Function: getMonthlyOptions() > **getMonthlyOptions**(`startDate`): `object` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L386) Generates monthly recurrence options based on the start date ## Parameters ### startDate `Date` The event start date ## Returns `object` Object containing monthly recurrence display strings and values ### byDate > **byDate**: `string` ### byWeekday > **byWeekday**: `string` ### dateValue > **dateValue**: `number` = `dayOfMonth` ### weekdayValue > **weekdayValue**: `object` #### weekdayValue.day > **day**: [`WeekDays`](../../recurrenceTypes/enumerations/WeekDays.md) #### weekdayValue.week > **week**: `number` = `weekdayOccurrence` ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getOrdinalString.md ================================================ [Admin Docs](/) *** # Function: getOrdinalString() > **getOrdinalString**(`num`): `string` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:367](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L367) Converts a number to its ordinal string representation ## Parameters ### num `number` The number to convert (1-5) ## Returns `string` The ordinal string (e.g., "first", "second", etc.) ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getOrdinalSuffix.md ================================================ [Admin Docs](/) *** # Function: getOrdinalSuffix() > **getOrdinalSuffix**(`num`): `string` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:208](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L208) Gets ordinal suffix for a number (st, nd, rd, th) ## Parameters ### num `number` The number ## Returns `string` Ordinal suffix ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getRecurrenceRuleText.md ================================================ [Admin Docs](/) *** # Function: getRecurrenceRuleText() > **getRecurrenceRuleText**(`recurrence`, `startDate`, `endDate?`): `string` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L104) Generates a human-readable description of the recurrence rule ## Parameters ### recurrence [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) The recurrence rule ### startDate `Date` The event start date ### endDate? `Date` ## Returns `string` Human-readable description ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getWeekOfMonth.md ================================================ [Admin Docs](/) *** # Function: getWeekOfMonth() > **getWeekOfMonth**(`date`): `number` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:325](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L325) Calculates which week of the month a given date falls in (calendar row), using UTC. ## Parameters ### date `Date` The date to calculate the week for ## Returns `number` The week number (1-6) within the month ================================================ FILE: docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/validateRecurrenceInput.md ================================================ [Admin Docs](/) *** # Function: validateRecurrenceInput() > **validateRecurrenceInput**(`recurrence`, `startDate`): `object` Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L20) Validates recurrence input data ## Parameters ### recurrence [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) The recurrence rule to validate ### startDate `Date` The event start date ## Returns `object` Validation result with errors ### errors > **errors**: `string`[] ### isValid > **isValid**: `boolean` ================================================ FILE: docs/docs/auto-docs/utils/sanitizeAvatar/functions/sanitizeAvatarURL.md ================================================ [Admin Docs](/) *** # Function: sanitizeAvatarURL() > **sanitizeAvatarURL**(`url`): `string` Defined in: [src/utils/sanitizeAvatar.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/sanitizeAvatar.ts#L47) Normalizes an avatar URL by converting null-like values to an empty string. ## Parameters ### url `string` The avatar URL to normalize ## Returns `string` The original URL, or an empty string if the input is falsy or the literal string "null" ================================================ FILE: docs/docs/auto-docs/utils/sanitizeAvatar/functions/sanitizeAvatars.md ================================================ [Admin Docs](/) *** # Function: sanitizeAvatars() > **sanitizeAvatars**(`file`, `fallbackUrl`): `string` Defined in: [src/utils/sanitizeAvatar.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/sanitizeAvatar.ts#L8) Sanitizes a file-based or URL-based avatar source. ## Parameters ### file `File` An image File to create an object URL from, or null ### fallbackUrl `string` A URL string to validate and return if no file is provided ## Returns `string` A safe blob: or https: URL, or an empty string ================================================ FILE: docs/docs/auto-docs/utils/testConstants/variables/SIDEBAR_TEST_BG_COLOR.md ================================================ [Admin Docs](/) *** # Variable: SIDEBAR\_TEST\_BG\_COLOR > `const` **SIDEBAR\_TEST\_BG\_COLOR**: `"#f0f7fb"` = `'#f0f7fb'` Defined in: [src/utils/testConstants.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/testConstants.ts#L4) Background color used for sidebar tests. ================================================ FILE: docs/docs/auto-docs/utils/timezoneUtils/dateTimeConfig/variables/dateTimeFields.md ================================================ [Admin Docs](/) *** # Variable: dateTimeFields > `const` **dateTimeFields**: `object` Defined in: [src/utils/timezoneUtils/dateTimeConfig.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/timezoneUtils/dateTimeConfig.ts#L3) ## Type Declaration ### directFields > **directFields**: `string`[] ### pairedFields > **pairedFields**: `object`[] ================================================ FILE: docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/requestMiddleware.md ================================================ [Admin Docs](/) *** # Variable: requestMiddleware > `const` **requestMiddleware**: `ApolloLink` Defined in: [src/utils/timezoneUtils/dateTimeMiddleware.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/timezoneUtils/dateTimeMiddleware.ts#L84) ================================================ FILE: docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/responseMiddleware.md ================================================ [Admin Docs](/) *** # Variable: responseMiddleware > `const` **responseMiddleware**: `ApolloLink` Defined in: [src/utils/timezoneUtils/dateTimeMiddleware.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/timezoneUtils/dateTimeMiddleware.ts#L94) ================================================ FILE: docs/docs/auto-docs/utils/tokenValues/functions/getSpacingValue.md ================================================ [Admin Docs](/) *** # Function: getSpacingValue() > **getSpacingValue**(`token`): `number` Defined in: [src/utils/tokenValues.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L66) Converts a spacing token name to its pixel value. ## Parameters ### token `string` The spacing token name (e.g., 'space-15') ## Returns `number` The pixel value as a number ## Throws Error if the token name is not found ## Example ```ts getSpacingValue('space-15') // returns 150 getSpacingValue('space-8') // returns 32 ``` ================================================ FILE: docs/docs/auto-docs/utils/tokenValues/functions/isSpacingToken.md ================================================ [Admin Docs](/) *** # Function: isSpacingToken() > **isSpacingToken**(`value`): `value is string` Defined in: [src/utils/tokenValues.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L82) Type guard to check if a value is a valid spacing token name. ## Parameters ### value `unknown` The value to check ## Returns `value is string` True if the value is a valid spacing token name ================================================ FILE: docs/docs/auto-docs/utils/tokenValues/type-aliases/SpacingToken.md ================================================ [Admin Docs](/) *** # Type Alias: SpacingToken > **SpacingToken** = keyof *typeof* [`spacingTokens`](../variables/spacingTokens.md) Defined in: [src/utils/tokenValues.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L51) Type representing valid spacing token names ================================================ FILE: docs/docs/auto-docs/utils/tokenValues/variables/spacingTokens.md ================================================ [Admin Docs](/) *** # Variable: spacingTokens > `const` **spacingTokens**: `Record`\<`string`, `number`\> Defined in: [src/utils/tokenValues.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L16) Mapping of spacing token names to their pixel values. Token names match the CSS variable names without the '--' prefix. ================================================ FILE: docs/docs/auto-docs/utils/urlToFile/functions/urlToFile.md ================================================ [Admin Docs](/) *** # Function: urlToFile() > **urlToFile**(`url`): `Promise`\<`File`\> Defined in: [src/utils/urlToFile.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/urlToFile.ts#L2) ## Parameters ### url `string` ## Returns `Promise`\<`File`\> ================================================ FILE: docs/docs/auto-docs/utils/useLocalstorage/functions/clearAllItems.md ================================================ [Admin Docs](/) *** # Function: clearAllItems() > **clearAllItems**(`prefix`): `void` Defined in: [src/utils/useLocalstorage.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L68) Clears all items from localStorage with the given prefix. ## Parameters ### prefix `string` Prefix to be added to the key, common for all keys. ## Returns `void` void ================================================ FILE: docs/docs/auto-docs/utils/useLocalstorage/functions/getItem.md ================================================ [Admin Docs](/) *** # Function: getItem() > **getItem**\<`T`\>(`prefix`, `key`): `T` Defined in: [src/utils/useLocalstorage.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L30) Retrieves the stored value for the given key from local storage. ## Type Parameters ### T `T` ## Parameters ### prefix `string` Prefix to be added to the key, common for all keys. ### key `string` The unique name identifying the value. ## Returns `T` - The stored value parsed as type T or null. ================================================ FILE: docs/docs/auto-docs/utils/useLocalstorage/functions/getStorageKey.md ================================================ [Admin Docs](/) *** # Function: getStorageKey() > **getStorageKey**(`prefix`, `key`): `string` Defined in: [src/utils/useLocalstorage.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L20) Generates the prefixed key for storage. ## Parameters ### prefix `string` Prefix to be added to the key, common for all keys. ### key `string` The unique name identifying the value. ## Returns `string` - Prefixed key. ================================================ FILE: docs/docs/auto-docs/utils/useLocalstorage/functions/removeItem.md ================================================ [Admin Docs](/) *** # Function: removeItem() > **removeItem**(`prefix`, `key`): `void` Defined in: [src/utils/useLocalstorage.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L58) Removes the value associated with the given key from local storage. ## Parameters ### prefix `string` Prefix to be added to the key, common for all keys. ### key `string` The unique name identifying the value. ## Returns `void` ================================================ FILE: docs/docs/auto-docs/utils/useLocalstorage/functions/setItem.md ================================================ [Admin Docs](/) *** # Function: setItem() > **setItem**(`prefix`, `key`, `value`): `void` Defined in: [src/utils/useLocalstorage.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L48) Sets the value for the given key in local storage. ## Parameters ### prefix `string` Prefix to be added to the key, common for all keys. ### key `string` The unique name identifying the value. ### value `unknown` The value to be stored (any type that can be serialized). ## Returns `void` ================================================ FILE: docs/docs/auto-docs/utils/useLocalstorage/functions/useLocalStorage.md ================================================ [Admin Docs](/) *** # Function: useLocalStorage() > **useLocalStorage**(`prefix`): `InterfaceStorageHelper` Defined in: [src/utils/useLocalstorage.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L87) Factory function that returns localStorage helper methods with a common prefix. ## Parameters ### prefix `string` = `PREFIX` Prefix to be added to all keys, defaults to 'Talawa-admin'. ## Returns `InterfaceStorageHelper` InterfaceStorageHelper with getItem, setItem, removeItem, getStorageKey, and clearAllItems methods. ================================================ FILE: docs/docs/auto-docs/utils/useLocalstorage/variables/PREFIX.md ================================================ [Admin Docs](/) *** # Variable: PREFIX > `const` **PREFIX**: `"Talawa-admin"` = `'Talawa-admin'` Defined in: [src/utils/useLocalstorage.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L12) ================================================ FILE: docs/docs/auto-docs/utils/useSession/functions/default.md ================================================ [Admin Docs](/) *** # Function: default() > **default**(): `UseSessionReturnType` Defined in: [src/utils/useSession.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useSession.tsx#L32) Custom hook for managing user session timeouts in a React application. This hook handles: - Starting and ending the user session. - Displaying a warning toast at half of the session timeout duration. - Logging the user out and displaying a session expiration toast when the session times out. - Automatically resetting the timers when user activity is detected. - Pausing session timers when the tab is inactive and resuming them when it becomes active again. ## Returns `UseSessionReturnType` UseSessionReturnType - An object with methods to start and end the session, and to handle logout. ================================================ FILE: docs/docs/auto-docs/utils/userUpdateUtils/functions/removeEmptyFields.md ================================================ [Admin Docs](/) *** # Function: removeEmptyFields() > **removeEmptyFields**\<`T`\>(`obj`): `Partial`\<`T`\> Defined in: [src/utils/userUpdateUtils.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/userUpdateUtils.ts#L23) Removes empty fields from an object, filtering out null, undefined, and empty/whitespace-only strings. File objects are preserved regardless of their content. This function accepts a generic type T that extends Record with string keys and values that can be string, File, null ## Type Parameters ### T `T` *extends* `Record`\<`string`, `string` \| `File`\> ## Parameters ### obj `T` The object to filter ## Returns `Partial`\<`T`\> A partial object with empty fields removed ## Example ```typescript const input = { name: 'John', email: '', age: null }; const result = removeEmptyFields(input); // Returns: { name: 'John' } ``` ================================================ FILE: docs/docs/auto-docs/utils/userUpdateUtils/functions/validateImageFile.md ================================================ [Admin Docs](/) *** # Function: validateImageFile() > **validateImageFile**(`file`, `tCommon`): `boolean` Defined in: [src/utils/userUpdateUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/userUpdateUtils.ts#L60) Validates an image file for type and size constraints. Shows error notifications for invalid files using the provided translation function. ## Parameters ### file `File` The file to validate, or undefined if no file is selected ### tCommon (`key`, `options?`) => `string` Translation function for error messages, accepts a key and optional interpolation options ## Returns `boolean` `true` if the file is valid, `false` otherwise ## Remarks - Accepted file types: JPEG, PNG, GIF - Maximum file size: 5MB - Returns `false` immediately if no file is provided - Displays error notifications for invalid files ## Example ```typescript const { t: tCommon } = useTranslation('common'); const isValid = validateImageFile(selectedFile, tCommon); if (isValid) { // Process the valid image file } ``` ================================================ FILE: docs/docs/auto-docs/utils/validators/authValidators/functions/getPasswordRequirements.md ================================================ [Admin Docs](/) *** # Function: getPasswordRequirements() > **getPasswordRequirements**(`password`): [`InterfacePasswordRequirements`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfacePasswordRequirements.md) Defined in: [src/utils/validators/authValidators.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L87) Checks password requirements status. ## Parameters ### password `string` Password to check ## Returns [`InterfacePasswordRequirements`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfacePasswordRequirements.md) Object indicating which requirements are met ================================================ FILE: docs/docs/auto-docs/utils/validators/authValidators/functions/validateEmail.md ================================================ [Admin Docs](/) *** # Function: validateEmail() > **validateEmail**(`email`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Defined in: [src/utils/validators/authValidators.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L19) Validates email format. Note: Uses basic regex validation. Does not enforce RFC 5322 compliance. ## Parameters ### email `string` Email address to validate ## Returns [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Validation result with error message if invalid ================================================ FILE: docs/docs/auto-docs/utils/validators/authValidators/functions/validateName.md ================================================ [Admin Docs](/) *** # Function: validateName() > **validateName**(`name`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Defined in: [src/utils/validators/authValidators.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L58) Validates name field requirements. ## Parameters ### name `string` Name to validate ## Returns [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Validation result with error message if invalid ================================================ FILE: docs/docs/auto-docs/utils/validators/authValidators/functions/validatePassword.md ================================================ [Admin Docs](/) *** # Function: validatePassword() > **validatePassword**(`password`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Defined in: [src/utils/validators/authValidators.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L31) Validates password complexity requirements. ## Parameters ### password `string` Password to validate ## Returns [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Validation result with error message if invalid ================================================ FILE: docs/docs/auto-docs/utils/validators/authValidators/functions/validatePasswordConfirmation.md ================================================ [Admin Docs](/) *** # Function: validatePasswordConfirmation() > **validatePasswordConfirmation**(`password`, `confirmPassword`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Defined in: [src/utils/validators/authValidators.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L73) Validates password confirmation matches original password. ## Parameters ### password `string` Original password ### confirmPassword `string` Confirmation password ## Returns [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md) Validation result with error message if passwords don't match ================================================ FILE: docs/docs/auto-docs/utils/validators/authValidators/variables/PASSWORD_REGEX.md ================================================ [Admin Docs](/) *** # Variable: PASSWORD\_REGEX > `const` **PASSWORD\_REGEX**: `object` Defined in: [src/utils/validators/authValidators.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L6) ## Type Declaration ### lowercase > `readonly` **lowercase**: `RegExp` ### numeric > `readonly` **numeric**: `RegExp` ### specialChar > `readonly` **specialChar**: `RegExp` ### uppercase > `readonly` **uppercase**: `RegExp` ================================================ FILE: docs/docs/auto-docs/utils/volunteerStatusMapper/functions/mapVolunteerStatusToVariant.md ================================================ [Admin Docs](/) *** # Function: mapVolunteerStatusToVariant() > **mapVolunteerStatusToVariant**(`status`): `object` Defined in: [src/utils/volunteerStatusMapper.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/volunteerStatusMapper.ts#L26) Maps volunteer membership status to StatusBadge variant. This function provides a single source of truth for status→variant mapping, ensuring consistent visual representation across the application. ## Parameters ### status `string` The membership status string (e.g., 'requested', 'invited', 'accepted', 'rejected') ## Returns `object` Object containing the StatusBadge variant ### variant > **variant**: [`StatusVariant`](../../../types/shared-components/StatusBadge/interface/type-aliases/StatusVariant.md) ## Example ```typescript const badgeProps = mapVolunteerStatusToVariant('invited'); // Returns: { variant: 'pending' } ``` ================================================ FILE: docs/docs/docs/developer-resources/actionitems-components.md ================================================ --- id: actionitems-components title: ActionItems Modal Components slug: /developer-resources/actionitems-components sidebar_position: 44 --- ## Overview The 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. **Key Features:** - Create and edit action items with category, volunteer/group assignment, and dates - View detailed action item information in read-only mode - Delete action items with confirmation and recurring event handling - Support for assigning to individual volunteers or volunteer groups - Template vs. instance distinction for recurring event management - MUI Autocomplete for volunteer/group/category selection with keyboard navigation - Completion tracking with pre/post-completion notes - i18n ready with full internationalization support **Why Use ActionItems Components:** - **Consistent UI:** Standardized modals for all action item operations across the application - **Accessibility:** WCAG 2.1 Level AA compliant with proper labels, roles, and keyboard navigation - **Flexibility:** Handles both one-time and recurring event action items with different mutation strategies - **Type Safety:** Fully typed interfaces for all props and data structures - **Testing:** Comprehensive test coverage with proper MUI Autocomplete interaction patterns ## Component Location ```text src/shared-components/ActionItems/ ├── ActionItemModal/ │ ├── [ActionItemModal.tsx](http://_vscodecontentref_/0) # Create/Edit action item modal │ ├── ActionItemModal.module.css │ └── ActionItemModal.spec.tsx ├── ActionItemViewModal/ │ ├── [ActionItemViewModal.tsx](http://_vscodecontentref_/1) # Read-only view modal │ ├── ActionItemViewModal.module.css │ └── ActionItemViewModal.spec.tsx ├── ActionItemDeleteModal/ │ ├── [ActionItemDeleteModal.tsx](http://_vscodecontentref_/2) # Delete confirmation modal │ ├── ActionItemDeleteModal.module.css │ └── ActionItemDeleteModal.spec.tsx ├── ActionItemUpdateModal/ # Status update modals ├── [ActionItem.mocks.ts](http://_vscodecontentref_/3) # GraphQL query/mutation mocks └── ActionItemUpdateModal/ ``` ## Type Definitions: ```text src/types/shared-components/ActionItems/interface.ts ``` ## Related Components: `AssignmentTypeSelector` - Chip-based toggle for volunteer vs. volunteer group selection `ApplyToSelector` - Radio group for series vs. instance selection (recurring events) `FormFieldGroup` - Wrapper for form fields `DatePicker` - Date selection component `BaseModal` - Base modal wrapper with backdrop handling Quick Start `ActionItemModal` (Create/Edit) ## Quick Start ### ActionItemModal (Create/Edit) ```tsx import ActionItemModal from 'shared-components/ActionItems/ActionItemModal/ActionItemModal'; setShowModal(false)} orgId="organization-123" eventId="event-456" actionItem={null} // null for create, object for edit editMode={false} actionItemsRefetch={refetchActionItems} isRecurring={false} /> ``` ### ActionItemViewModal (Read-Only) ```tsx import ActionItemViewModal from 'shared-components/ActionItems/ActionItemViewModal/ActionItemViewModal'; setShowModal(false)} item={actionItemData} /> ``` ### ActionItemDeleteModal (Confirmation) ```tsx import ActionItemDeleteModal from 'shared-components/ActionItems/ActionItemDeleteModal/ActionItemDeleteModal'; setShowModal(false)} actionItem={actionItemData} actionItemsRefetch={refetchActionItems} eventId="event-456" isRecurring={true} /> ``` ## Usage Examples ### Complete Create Flow ```tsx import React, { useState } from 'react'; import ActionItemModal from 'shared-components/ActionItems/ActionItemModal/ActionItemModal'; import { Button } from 'react-bootstrap'; import { useQuery } from '@apollo/client'; import { GET_EVENT_ACTION_ITEMS } from 'GraphQl/Queries/ActionItemQueries'; export const ActionItemsManager = ({ eventId, orgId }) => { const [showModal, setShowModal] = useState(false); const { refetch: refetchActionItems } = useQuery(GET_EVENT_ACTION_ITEMS, { variables: { input: { id: eventId } }, }); return ( <> setShowModal(false)} orgId={orgId} eventId={eventId} actionItem={null} editMode={false} actionItemsRefetch={refetchActionItems} /> ); }; ``` ### Edit Flow with Recurring Support ```tsx import React, { useState } from 'react'; import ActionItemModal from 'shared-components/ActionItems/ActionItemModal/ActionItemModal'; import { useQuery } from '@apollo/client'; import { GET_EVENT_ACTION_ITEMS } from 'GraphQl/Queries/ActionItemQueries'; export const EditActionItem = ({ actionItem, eventId, orgId, isRecurringEvent }) => { const [showModal, setShowModal] = useState(false); const { refetch: refetchActionItems } = useQuery(GET_EVENT_ACTION_ITEMS, { variables: { input: { id: eventId } }, }); return ( <> setShowModal(false)} orgId={orgId} eventId={eventId} actionItem={actionItem} editMode={true} actionItemsRefetch={refetchActionItems} isRecurring={isRecurringEvent} baseEvent={actionItem.event} /> ); }; ``` ### Delete With Confirmation ```tsx import React, { useState } from 'react'; import ActionItemDeleteModal from 'shared-components/ActionItems/ActionItemDeleteModal/ActionItemDeleteModal'; import { Button } from 'react-bootstrap'; import { useQuery } from '@apollo/client'; import { GET_EVENT_ACTION_ITEMS } from 'GraphQl/Queries/ActionItemQueries'; export const DeleteActionItem = ({ actionItem, eventId, isRecurringEvent }) => { const [showModal, setShowModal] = useState(false); const { refetch: refetchActionItems } = useQuery(GET_EVENT_ACTION_ITEMS, { variables: { input: { id: eventId } }, }); return ( <> setShowModal(false)} actionItem={actionItem} actionItemsRefetch={refetchActionItems} eventId={eventId} isRecurring={isRecurringEvent} /> ); }; ``` ## Component API --- ### ActionItemModal Props | Prop | Type | Required | Default | Description | |------------------------|-----------------------------------|----------|---------|-------------| | `isOpen` | `boolean` | Yes | – | Controls modal visibility | | `hide` | `() => void` | Yes | – | Callback to close the modal | | `orgId` | `string` | Yes | – | Organization ID for category/volunteer queries | | `eventId` | `string \| undefined` | Yes | – | Event ID for volunteer group queries (`undefined` for organization-level) | | `actionItem` | `IActionItemInfo \| null` | Yes | – | Action item object for edit mode, `null` for create | | `editMode` | `boolean` | Yes | – | Controls form behavior (create vs. edit) | | `actionItemsRefetch` | `() => void` | Yes | – | Callback to refetch action items after mutation | | `orgActionItemsRefetch`| `() => void` | No | – | Optional callback for organization-level refetch | | `isRecurring` | `boolean` | No | `false` | Show series/instance selector for recurring events | | `baseEvent` | `{ id: string } \| null` | No | – | Base event reference for recurring event handling | --- ### ActionItemViewModal Props | Prop | Type | Required | Default | Description | |----------|--------------------|----------|---------|-------------| | `isOpen` | `boolean` | Yes | – | Controls modal visibility | | `hide` | `() => void` | Yes | – | Callback to close the modal | | `item` | `IActionItemInfo` | Yes | – | Action item data to display | --- ### ActionItemDeleteModal Props | Prop | Type | Required | Default | Description | |----------------------|--------------------|----------|---------|-------------| | `isOpen` | `boolean` | Yes | – | Controls modal visibility | | `hide` | `() => void` | Yes | – | Callback to close the modal | | `actionItem` | `IActionItemInfo` | Yes | – | Action item to delete | | `actionItemsRefetch` | `() => void` | Yes | – | Callback to refetch after deletion | | `eventId` | `string` | No | – | Event ID for instance-specific deletion | | `isRecurring` | `boolean` | No | `false` | Show series/instance selector for recurring events | ================================================ FILE: docs/docs/docs/developer-resources/contributing.md ================================================ --- id: contributing title: Contributing slug: /developer-resources/contributing sidebar_position: 15 --- Please 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. ================================================ FILE: docs/docs/docs/developer-resources/crud-modal-template.md ================================================ --- id: crud-modal-template title: CRUDModalTemplate Component slug: /developer-resources/crud-modal-template sidebar_position: 38 --- ## Overview The `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. **Key Features:** - Four specialized modal types: Create, Edit, Delete, and View - Built-in loading states for data fetching and form submission - Auto-focus on first input field - Keyboard accessibility (Escape to close) - Consistent styling and layout - i18n ready **Why Use CRUDModalTemplate:** - **Consistency:** Ensures all CRUD modals across the application have uniform behavior and appearance - **Reduced Boilerplate:** Common features like loading states and form handling are pre-integrated - **Maintainability:** Changes to modal behavior can be made in one place - **Accessibility:** Built-in keyboard navigation and focus management ## Component Location ```text src/shared-components/CRUDModalTemplate/ ├── CRUDModalTemplate.tsx # Base modal component ├── CRUDModalTemplate.module.css ├── CRUDModalTemplate.spec.tsx ├── CreateModal.tsx # Create entity modal ├── EditModal.tsx # Edit entity modal ├── DeleteModal.tsx # Delete entity modal └── ViewModal.tsx # View entity modal (read-only) ``` **Type Definitions:** ```text src/types/shared-components/CRUDModalTemplate/interface.ts ``` ## Quick Start ### CreateModal ```tsx import { CreateModal } from 'shared-components/CRUDModalTemplate/CreateModal'; import { Form } from 'react-bootstrap'; setShowModal(false)} onSubmit={handleSubmit} loading={isSubmitting} submitDisabled={!isFormValid} > Event Name setEventName(e.target.value)} /> ``` ### EditModal ```tsx import { EditModal } from 'shared-components/CRUDModalTemplate/EditModal'; import { Form } from 'react-bootstrap'; setShowModal(false)} onSubmit={handleSubmit} loading={isSubmitting} loadingData={isFetchingData} submitDisabled={!hasChanges} > Event Name setEventName(e.target.value)} /> ``` ### DeleteModal ```tsx import { DeleteModal } from 'shared-components/CRUDModalTemplate/DeleteModal'; setShowModal(false)} onDelete={handleDelete} showWarning={true} /> ``` ### ViewModal ```tsx import { ViewModal } from 'shared-components/CRUDModalTemplate/ViewModal'; import { Button } from 'react-bootstrap'; setShowModal(false)} loadingData={isFetchingData} customActions={ <> } >
Event Name:

Annual Conference 2024

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

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

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

{event?.name}

Date:

{event?.date}

Location:

{event?.location}

Description:

{event?.description}

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

{title}

{subtitle}

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