diff --git a/.eslintignore b/.eslintignore index ee98c5bdb0..9d39469b2a 100644 --- a/.eslintignore +++ b/.eslintignore @@ -3,6 +3,6 @@ src/components/CheckIn/tagTemplate.ts package.json package-lock.json tsconfig.json - +fix-readme-links.js # Ignore the Docusaurus website subdirectory docs/** \ No newline at end of file diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index 4dfefe6e77..6d6e731f94 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -417,26 +417,67 @@ jobs: docker stop talawa-admin-app-container docker rm talawa-admin-app-container + generate-docs: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Checkout the Repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: '22.x' + + - name: Install Dependencies + run: npm install + + - name: Generate Documentation + run: npm run generate-docs + + - name: Commit and Push Changes + env: + HEAD_REF: ${{ github.head_ref }} + run: | + if [[ $(git status --porcelain) ]]; then + echo "Changes detected. Auto-committing updates." + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + git add --all + git commit -m "Auto-generate documentation" + if ! git push origin HEAD:"$HEAD_REF"; then + echo "Failed to push changes. Please check if you have the correct permissions." + exit 1 + fi + else + echo "No changes detected." + fi Test-Docusaurus-Deployment: name: Test Deployment to https://docs-admin.talawa.io runs-on: ubuntu-latest needs: [Docker-Start-Check, Start-App-Without-Docker] - # Run only if the develop-postgres branch and not dependabot + # Run only if the develop-postgres branch and not dependabot if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.base.ref == 'develop-postgres' }} steps: - - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 + - name: Checkout the Repository + uses: actions/checkout@v4 + + - name: Set up Node.js + uses: actions/setup-node@v4 with: - node-version: '22.x' - cache: yarn - cache-dependency-path: 'docs/' - # Run Docusaurus in the ./docs directory + node-version: '20.x' + - name: Install dependencies working-directory: ./docs - run: yarn install --frozen-lockfile + run: npm install + - name: Test building the website working-directory: ./docs - run: yarn build + run: npm run build Check-Target-Branch: if: ${{ github.actor != 'dependabot[bot]' }} @@ -516,4 +557,4 @@ jobs: - name: Run docstring compliance check run: | source venv/bin/activate - python .github/workflows/scripts/check_docstrings.py --directories .github + python .github/workflows/scripts/check_docstrings.py --directories .github \ No newline at end of file diff --git a/docs/docs/auto-docs/App/functions/default.md b/docs/docs/auto-docs/App/functions/default.md new file mode 100644 index 0000000000..65caa3ddb9 --- /dev/null +++ b/docs/docs/auto-docs/App/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/App.tsx:74](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/App.tsx#L74) + +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. +- **Plugins**: It dynamically loads additional routes for any installed plugins. +- **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. + +## Returns + +`JSX.Element` + +The rendered routes and components of the application. diff --git a/docs/docs/auto-docs/Constant/constant/variables/AUTH_TOKEN.md b/docs/docs/auto-docs/Constant/constant/variables/AUTH_TOKEN.md new file mode 100644 index 0000000000..0f9d4549fd --- /dev/null +++ b/docs/docs/auto-docs/Constant/constant/variables/AUTH_TOKEN.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: AUTH\_TOKEN + +> `const` **AUTH\_TOKEN**: `""` = `''` + +Defined in: [src/Constant/constant.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/Constant/constant.ts#L1) diff --git a/docs/docs/auto-docs/Constant/constant/variables/BACKEND_URL.md b/docs/docs/auto-docs/Constant/constant/variables/BACKEND_URL.md new file mode 100644 index 0000000000..c49a1189d3 --- /dev/null +++ b/docs/docs/auto-docs/Constant/constant/variables/BACKEND_URL.md @@ -0,0 +1,9 @@ +[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/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/Constant/constant.ts#L2) diff --git a/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_BACKEND_WEBSOCKET_URL.md b/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_BACKEND_WEBSOCKET_URL.md new file mode 100644 index 0000000000..848244d12a --- /dev/null +++ b/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_BACKEND_WEBSOCKET_URL.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REACT\_APP\_BACKEND\_WEBSOCKET\_URL + +> `const` **REACT\_APP\_BACKEND\_WEBSOCKET\_URL**: `string` + +Defined in: [src/Constant/constant.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/Constant/constant.ts#L6) diff --git a/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_CUSTOM_PORT.md b/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_CUSTOM_PORT.md new file mode 100644 index 0000000000..c307ff75f3 --- /dev/null +++ b/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_CUSTOM_PORT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REACT\_APP\_CUSTOM\_PORT + +> `const` **REACT\_APP\_CUSTOM\_PORT**: `string` = `process.env.PORT` + +Defined in: [src/Constant/constant.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/Constant/constant.ts#L5) diff --git a/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_USE_RECAPTCHA.md b/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_USE_RECAPTCHA.md new file mode 100644 index 0000000000..637e7328e0 --- /dev/null +++ b/docs/docs/auto-docs/Constant/constant/variables/REACT_APP_USE_RECAPTCHA.md @@ -0,0 +1,9 @@ +[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/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/Constant/constant.ts#L4) diff --git a/docs/docs/auto-docs/Constant/constant/variables/RECAPTCHA_SITE_KEY.md b/docs/docs/auto-docs/Constant/constant/variables/RECAPTCHA_SITE_KEY.md new file mode 100644 index 0000000000..774d1ef1d8 --- /dev/null +++ b/docs/docs/auto-docs/Constant/constant/variables/RECAPTCHA_SITE_KEY.md @@ -0,0 +1,9 @@ +[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/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/Constant/constant.ts#L3) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/CREATE_ACTION_ITEM_CATEGORY_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/CREATE_ACTION_ITEM_CATEGORY_MUTATION.md new file mode 100644 index 0000000000..0af8ffa700 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/CREATE_ACTION_ITEM_CATEGORY_MUTATION.md @@ -0,0 +1,23 @@ +[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/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L11) + +GraphQL mutation to create an action item category. + +## Param + +Name of the ActionItemCategory. + +## Param + +Disabled status of the ActionItemCategory. + +## Param + +Organization to which the ActionItemCategory belongs. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/UPDATE_ACTION_ITEM_CATEGORY_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/UPDATE_ACTION_ITEM_CATEGORY_MUTATION.md new file mode 100644 index 0000000000..18c17642f9 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/UPDATE_ACTION_ITEM_CATEGORY_MUTATION.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ACTION\_ITEM\_CATEGORY\_MUTATION + +> `const` **UPDATE\_ACTION\_ITEM\_CATEGORY\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/ActionItemCategoryMutations.ts:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L35) + +GraphQL mutation to update an action item category. + +## Param + +The id of the ActionItemCategory to be updated. + +## Param + +Updated name of the ActionItemCategory. + +## Param + +Updated disabled status of the ActionItemCategory. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/CREATE_ACTION_ITEM_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/CREATE_ACTION_ITEM_MUTATION.md new file mode 100644 index 0000000000..0cb28108b7 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/CREATE_ACTION_ITEM_MUTATION.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_ACTION\_ITEM\_MUTATION + +> `const` **CREATE\_ACTION\_ITEM\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/ActionItemMutations.ts#L14) + +GraphQL mutation to create an action item. + +## Param + +ActionItemCategory to which the ActionItem is related. + +## Param + +User to whom the ActionItem is assigned. + +## Param + +Notes prior to completion. + +## Param + +Due date. + +## Param + +Event to which the ActionItem is related. + +## Param + +Hours allotted for the ActionItem. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/DELETE_ACTION_ITEM_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/DELETE_ACTION_ITEM_MUTATION.md new file mode 100644 index 0000000000..4083d0057f --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/DELETE_ACTION_ITEM_MUTATION.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_ACTION\_ITEM\_MUTATION + +> `const` **DELETE\_ACTION\_ITEM\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:88](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/ActionItemMutations.ts#L88) + +GraphQL mutation to delete an action item. + +## Param + +Id of the ActionItem to be updated. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/UPDATE_ACTION_ITEM_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/UPDATE_ACTION_ITEM_MUTATION.md new file mode 100644 index 0000000000..5e3f8596e7 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/UPDATE_ACTION_ITEM_MUTATION.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ACTION\_ITEM\_MUTATION + +> `const` **UPDATE\_ACTION\_ITEM\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/ActionItemMutations.ts:52](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/ActionItemMutations.ts#L52) + +GraphQL mutation to update an action item. + +## Param + +Id of the ActionItem to be updated. + +## Param + +User to whom the ActionItem is assigned. + +## Param + +Notes prior to completion. + +## Param + +Notes on completion. + +## Param + +Due date. + +## Param + +Completion date. + +## Param + +Whether the ActionItem has been completed. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/CREATE_AGENDA_ITEM_CATEGORY_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/CREATE_AGENDA_ITEM_CATEGORY_MUTATION.md new file mode 100644 index 0000000000..afd0626f35 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/CREATE_AGENDA_ITEM_CATEGORY_MUTATION.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_AGENDA\_ITEM\_CATEGORY\_MUTATION + +> `const` **CREATE\_AGENDA\_ITEM\_CATEGORY\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/AgendaCategoryMutations.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/AgendaCategoryMutations.ts#L9) + +GraphQL mutation to create an agenda category. + +## Param + +Name, Description, OrganizationID of the AgendaCategory. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/DELETE_AGENDA_ITEM_CATEGORY_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/DELETE_AGENDA_ITEM_CATEGORY_MUTATION.md new file mode 100644 index 0000000000..eca2111794 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/DELETE_AGENDA_ITEM_CATEGORY_MUTATION.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_AGENDA\_ITEM\_CATEGORY\_MUTATION + +> `const` **DELETE\_AGENDA\_ITEM\_CATEGORY\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/AgendaCategoryMutations.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/AgendaCategoryMutations.ts#L23) + +GraphQL mutation to delete an agenda category. + +## Param + +The ID of the AgendaCategory to be deleted. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/UPDATE_AGENDA_ITEM_CATEGORY_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/UPDATE_AGENDA_ITEM_CATEGORY_MUTATION.md new file mode 100644 index 0000000000..cf1c0d9bd1 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/AgendaCategoryMutations/variables/UPDATE_AGENDA_ITEM_CATEGORY_MUTATION.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_AGENDA\_ITEM\_CATEGORY\_MUTATION + +> `const` **UPDATE\_AGENDA\_ITEM\_CATEGORY\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/AgendaCategoryMutations.ts:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/AgendaCategoryMutations.ts#L36) + +GraphQL mutation to update an agenda category. + +## Param + +The ID of the AgendaCategory to be updated. + +## Param + +Updated Name, Description, OrganizationID of the AgendaCategory. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/CREATE_AGENDA_ITEM_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/CREATE_AGENDA_ITEM_MUTATION.md new file mode 100644 index 0000000000..61716759c8 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/CREATE_AGENDA_ITEM_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_AGENDA\_ITEM\_MUTATION + +> `const` **CREATE\_AGENDA\_ITEM\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/AgendaItemMutations.ts#L3) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/DELETE_AGENDA_ITEM_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/DELETE_AGENDA_ITEM_MUTATION.md new file mode 100644 index 0000000000..d268e8f58b --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/DELETE_AGENDA_ITEM_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_AGENDA\_ITEM\_MUTATION + +> `const` **DELETE\_AGENDA\_ITEM\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/AgendaItemMutations.ts#L12) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/UPDATE_AGENDA_ITEM_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/UPDATE_AGENDA_ITEM_MUTATION.md new file mode 100644 index 0000000000..89efb8f8f4 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/UPDATE_AGENDA_ITEM_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_AGENDA\_ITEM\_MUTATION + +> `const` **UPDATE\_AGENDA\_ITEM\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/AgendaItemMutations.ts#L20) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/CREATE_CAMPAIGN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/CREATE_CAMPAIGN_MUTATION.md new file mode 100644 index 0000000000..c3d457d0dd --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/CREATE_CAMPAIGN_MUTATION.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_CAMPAIGN\_MUTATION + +> `const` **CREATE\_CAMPAIGN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/CampaignMutation.ts:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/UPDATE_CAMPAIGN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/UPDATE_CAMPAIGN_MUTATION.md new file mode 100644 index 0000000000..e4ecb7bcd8 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/UPDATE_CAMPAIGN_MUTATION.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_CAMPAIGN\_MUTATION + +> `const` **UPDATE\_CAMPAIGN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/CampaignMutation.ts:53](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/CampaignMutation.ts#L53) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/CREATE_COMMENT_POST.md b/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/CREATE_COMMENT_POST.md new file mode 100644 index 0000000000..07c8990dd3 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/CREATE_COMMENT_POST.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_COMMENT\_POST + +> `const` **CREATE\_COMMENT\_POST**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/CommentMutations.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/LIKE_COMMENT.md b/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/LIKE_COMMENT.md new file mode 100644 index 0000000000..b6a23c24bc --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/LIKE_COMMENT.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: LIKE\_COMMENT + +> `const` **LIKE\_COMMENT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/CommentMutations.ts:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/CommentMutations.ts#L37) + +GraphQL mutation to like a comment. + +## Param + +The ID of the comment to be liked. + +## Returns + +The liked comment object. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/UNLIKE_COMMENT.md b/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/UNLIKE_COMMENT.md new file mode 100644 index 0000000000..8f5e65ea56 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/UNLIKE_COMMENT.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: UNLIKE\_COMMENT + +> `const` **UNLIKE\_COMMENT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/CommentMutations.ts:52](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/CommentMutations.ts#L52) + +GraphQL mutation to unlike a comment. + +## Param + +The ID of the comment to be unliked. + +## Returns + +The unliked comment object. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/ADD_EVENT_ATTENDEE.md b/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/ADD_EVENT_ATTENDEE.md new file mode 100644 index 0000000000..086470392d --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/ADD_EVENT_ATTENDEE.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_EVENT\_ATTENDEE + +> `const` **ADD\_EVENT\_ATTENDEE**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/MARK_CHECKIN.md b/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/MARK_CHECKIN.md new file mode 100644 index 0000000000..49412b6325 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/MARK_CHECKIN.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: MARK\_CHECKIN + +> `const` **MARK\_CHECKIN**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventAttendeeMutations.ts#L43) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/REMOVE_EVENT_ATTENDEE.md b/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/REMOVE_EVENT_ATTENDEE.md new file mode 100644 index 0000000000..f33f740885 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/REMOVE_EVENT_ATTENDEE.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: REMOVE\_EVENT\_ATTENDEE + +> `const` **REMOVE\_EVENT\_ATTENDEE**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventAttendeeMutations.ts#L27) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/ADD_VOLUNTEER.md b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/ADD_VOLUNTEER.md new file mode 100644 index 0000000000..19345740d6 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/ADD_VOLUNTEER.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_VOLUNTEER + +> `const` **ADD\_VOLUNTEER**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventVolunteerMutation.ts#L11) + +GraphQL mutation to create an event volunteer. + +## Param + +The data required to create an event volunteer. + +## Returns + +The ID of the created event volunteer. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_GROUP.md b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_GROUP.md new file mode 100644 index 0000000000..5df8604ca9 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_GROUP.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_VOLUNTEER\_GROUP + +> `const` **CREATE\_VOLUNTEER\_GROUP**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:48](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventVolunteerMutation.ts#L48) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_MEMBERSHIP.md b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_MEMBERSHIP.md new file mode 100644 index 0000000000..547fd44e5b --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_MEMBERSHIP.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_VOLUNTEER\_MEMBERSHIP + +> `const` **CREATE\_VOLUNTEER\_MEMBERSHIP**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:90](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventVolunteerMutation.ts#L90) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER.md b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER.md new file mode 100644 index 0000000000..23aecced30 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_VOLUNTEER + +> `const` **DELETE\_VOLUNTEER**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventVolunteerMutation.ts#L26) + +GraphQL mutation to delete an event volunteer. + +## Param + +The ID of the event volunteer being deleted. + +## Returns + +The ID of the deleted event volunteer. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_GROUP.md b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_GROUP.md new file mode 100644 index 0000000000..25ef9760f7 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_GROUP.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_VOLUNTEER\_GROUP + +> `const` **DELETE\_VOLUNTEER\_GROUP**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:82](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventVolunteerMutation.ts#L82) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_GROUP.md b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_GROUP.md new file mode 100644 index 0000000000..52dd67195d --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_GROUP.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_VOLUNTEER\_GROUP + +> `const` **UPDATE\_VOLUNTEER\_GROUP**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:64](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventVolunteerMutation.ts#L64) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_MEMBERSHIP.md b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_MEMBERSHIP.md new file mode 100644 index 0000000000..8d4b41e833 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_MEMBERSHIP.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_VOLUNTEER\_MEMBERSHIP + +> `const` **UPDATE\_VOLUNTEER\_MEMBERSHIP**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:106](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/EventVolunteerMutation.ts#L106) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/CREATE_FUND_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/CREATE_FUND_MUTATION.md new file mode 100644 index 0000000000..f4e2c92d04 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/CREATE_FUND_MUTATION.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_FUND\_MUTATION + +> `const` **CREATE\_FUND\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/FundMutation.ts:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/FundMutation.ts#L14) + +GraphQL mutation to create a new fund. + +## Param + +The name of the fund. + +## Param + +The organization ID the fund is associated with. + +## Param + +The reference number of the fund. + +## Param + +Whether the fund is tax deductible. + +## Param + +Whether the fund is archived. + +## Param + +Whether the fund is the default. + +## Returns + +The ID of the created fund. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/UPDATE_FUND_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/UPDATE_FUND_MUTATION.md new file mode 100644 index 0000000000..a6f09c3d78 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/UPDATE_FUND_MUTATION.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_FUND\_MUTATION + +> `const` **UPDATE\_FUND\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/FundMutation.ts:49](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/FundMutation.ts#L49) + +GraphQL mutation to update a fund. + +## Param + +The ID of the fund being updated. + +## Param + +The name of the fund. + +## Param + +The reference number of the fund. + +## Param + +Whether the fund is tax deductible. + +## Param + +Whether the fund is archived. + +## Param + +Whether the fund is the default. + +## Returns + +The ID of the updated fund. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/ADD_CUSTOM_FIELD.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/ADD_CUSTOM_FIELD.md new file mode 100644 index 0000000000..e0ceb53a77 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/ADD_CUSTOM_FIELD.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_CUSTOM\_FIELD + +> `const` **ADD\_CUSTOM\_FIELD**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:237](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L237) + +GraphQL mutation to add a custom field to an organization. + +## Param + +The ID of the organization where the custom field is being added. + +## Param + +The type of the custom field (e.g., String, Number). + +## Param + +The name of the custom field. + +## Returns + +The added organization custom field object. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/ADD_USER_TO_GROUP_CHAT.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/ADD_USER_TO_GROUP_CHAT.md new file mode 100644 index 0000000000..93587d18aa --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/ADD_USER_TO_GROUP_CHAT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_USER\_TO\_GROUP\_CHAT + +> `const` **ADD\_USER\_TO\_GROUP\_CHAT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:82](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L82) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CANCEL_MEMBERSHIP_REQUEST.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CANCEL_MEMBERSHIP_REQUEST.md new file mode 100644 index 0000000000..39c9f74b51 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CANCEL_MEMBERSHIP_REQUEST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CANCEL\_MEMBERSHIP\_REQUEST + +> `const` **CANCEL\_MEMBERSHIP\_REQUEST**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:295](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L295) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_CHAT.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_CHAT.md new file mode 100644 index 0000000000..2c4d66f386 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_CHAT.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_CHAT + +> `const` **CREATE\_CHAT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L60) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_SAMPLE_ORGANIZATION_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_SAMPLE_ORGANIZATION_MUTATION.md new file mode 100644 index 0000000000..161a0e9c71 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_SAMPLE_ORGANIZATION_MUTATION.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_SAMPLE\_ORGANIZATION\_MUTATION + +> `const` **CREATE\_SAMPLE\_ORGANIZATION\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L34) + +GraphQL mutation to create a sample organization. + +## Returns + +The created sample organization object. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/EDIT_CHAT_MESSAGE.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/EDIT_CHAT_MESSAGE.md new file mode 100644 index 0000000000..c63006078c --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/EDIT_CHAT_MESSAGE.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EDIT\_CHAT\_MESSAGE + +> `const` **EDIT\_CHAT\_MESSAGE**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:106](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L106) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/JOIN_PUBLIC_ORGANIZATION.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/JOIN_PUBLIC_ORGANIZATION.md new file mode 100644 index 0000000000..76758dd86b --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/JOIN_PUBLIC_ORGANIZATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: JOIN\_PUBLIC\_ORGANIZATION + +> `const` **JOIN\_PUBLIC\_ORGANIZATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:287](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L287) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MARK_CHAT_MESSAGES_AS_READ.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MARK_CHAT_MESSAGES_AS_READ.md new file mode 100644 index 0000000000..99608369d1 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MARK_CHAT_MESSAGES_AS_READ.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MARK\_CHAT\_MESSAGES\_AS\_READ + +> `const` **MARK\_CHAT\_MESSAGES\_AS\_READ**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:90](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L90) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MESSAGE_SENT_TO_CHAT.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MESSAGE_SENT_TO_CHAT.md new file mode 100644 index 0000000000..a4d0e6d0d4 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MESSAGE_SENT_TO_CHAT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MESSAGE\_SENT\_TO\_CHAT + +> `const` **MESSAGE\_SENT\_TO\_CHAT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:164](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L164) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/PLUGIN_SUBSCRIPTION.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/PLUGIN_SUBSCRIPTION.md new file mode 100644 index 0000000000..c8c54437c0 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/PLUGIN_SUBSCRIPTION.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: PLUGIN\_SUBSCRIPTION + +> `const` **PLUGIN\_SUBSCRIPTION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:202](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L202) + +GraphQL subscription to listen for updates on plugins. + +## Returns + +An object containing information about the updated plugin. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_CUSTOM_FIELD.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_CUSTOM_FIELD.md new file mode 100644 index 0000000000..6e31562b08 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_CUSTOM_FIELD.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: REMOVE\_CUSTOM\_FIELD + +> `const` **REMOVE\_CUSTOM\_FIELD**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:260](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L260) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_SAMPLE_ORGANIZATION_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_SAMPLE_ORGANIZATION_MUTATION.md new file mode 100644 index 0000000000..279798d71c --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_SAMPLE_ORGANIZATION_MUTATION.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: REMOVE\_SAMPLE\_ORGANIZATION\_MUTATION + +> `const` **REMOVE\_SAMPLE\_ORGANIZATION\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L46) + +GraphQL mutation to remove a sample organization. + +## Returns + +The removed sample organization object. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MEMBERSHIP_REQUEST.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MEMBERSHIP_REQUEST.md new file mode 100644 index 0000000000..b70ae221e9 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MEMBERSHIP_REQUEST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: SEND\_MEMBERSHIP\_REQUEST + +> `const` **SEND\_MEMBERSHIP\_REQUEST**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:272](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L272) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MESSAGE_TO_CHAT.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MESSAGE_TO_CHAT.md new file mode 100644 index 0000000000..5cb2696530 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MESSAGE_TO_CHAT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: SEND\_MESSAGE\_TO\_CHAT + +> `const` **SEND\_MESSAGE\_TO\_CHAT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:126](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L126) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/TOGGLE_PINNED_POST.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/TOGGLE_PINNED_POST.md new file mode 100644 index 0000000000..1bec3fee14 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/TOGGLE_PINNED_POST.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: TOGGLE\_PINNED\_POST + +> `const` **TOGGLE\_PINNED\_POST**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:220](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L220) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_CHAT.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_CHAT.md new file mode 100644 index 0000000000..831db4c644 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_CHAT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_CHAT + +> `const` **UPDATE\_CHAT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/OrganizationMutations.ts:98](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/OrganizationMutations.ts#L98) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_USER_ROLE_IN_ORG_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_USER_ROLE_IN_ORG_MUTATION.md new file mode 100644 index 0000000000..56dd069350 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_USER_ROLE_IN_ORG_MUTATION.md @@ -0,0 +1,27 @@ +[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/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/CREATE_PlEDGE.md b/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/CREATE_PlEDGE.md new file mode 100644 index 0000000000..1ee7ee97ad --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/CREATE_PlEDGE.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_PlEDGE + +> `const` **CREATE\_PlEDGE**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/PledgeMutation.ts:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/PledgeMutation.ts#L14) + +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 currency of the pledge. + +## Param + +The start date of the pledge. + +## Param + +The end date of the pledge. + +## Param + +The IDs of the users associated with the pledge. + +## Returns + +The ID of the created pledge. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/DELETE_PLEDGE.md b/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/DELETE_PLEDGE.md new file mode 100644 index 0000000000..bdfb74f474 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/DELETE_PLEDGE.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_PLEDGE + +> `const` **DELETE\_PLEDGE**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/PledgeMutation.ts:78](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/PledgeMutation.ts#L78) + +GraphQL mutation to delete a pledge. + +## Param + +The ID of the pledge being deleted. + +## Returns + +Whether the pledge was successfully deleted. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/UPDATE_PLEDGE.md b/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/UPDATE_PLEDGE.md new file mode 100644 index 0000000000..63156624ef --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/UPDATE_PLEDGE.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_PLEDGE + +> `const` **UPDATE\_PLEDGE**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/PledgeMutation.ts:48](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/PledgeMutation.ts#L48) + +GraphQL mutation to update a pledge. + +## Param + +The ID of the pledge being updated. + +## Param + +The amount of the pledge. + +## Param + +The currency of the pledge. + +## Param + +The start date of the pledge. + +## Param + +The end date of the pledge. + +## Returns + +The ID of the updated pledge. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ADD_PEOPLE_TO_TAG.md b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ADD_PEOPLE_TO_TAG.md new file mode 100644 index 0000000000..ea23f591fe --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ADD_PEOPLE_TO_TAG.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_PEOPLE\_TO\_TAG + +> `const` **ADD\_PEOPLE\_TO\_TAG**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/TagMutations.ts:83](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/TagMutations.ts#L83) + +GraphQL mutation to add people to tag. + +## Param + +Id of the tag to be assigned. + +## Param + +Ids of the users to assign to. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ASSIGN_TO_TAGS.md b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ASSIGN_TO_TAGS.md new file mode 100644 index 0000000000..e8e3d45dc5 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ASSIGN_TO_TAGS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: ASSIGN\_TO\_TAGS + +> `const` **ASSIGN\_TO\_TAGS**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/TagMutations.ts:98](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/TagMutations.ts#L98) + +GraphQL mutation to assign people to multiple tags. + +## Param + +Id of the current tag. + +## Param + +Ids of the selected tags to be assined. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/CREATE_USER_TAG.md b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/CREATE_USER_TAG.md new file mode 100644 index 0000000000..dda1e44a40 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/CREATE_USER_TAG.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_USER\_TAG + +> `const` **CREATE\_USER\_TAG**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/TagMutations.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/TagMutations.ts#L12) + +GraphQL mutation to create a user tag. + +## Param + +Name of the tag. + +## Param + +Color of the tag. + +## Param + +Id of the parent tag. + +## Param + +Organization to which the tag belongs. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_FROM_TAGS.md b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_FROM_TAGS.md new file mode 100644 index 0000000000..af47d3596a --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_FROM_TAGS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: REMOVE\_FROM\_TAGS + +> `const` **REMOVE\_FROM\_TAGS**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/TagMutations.ts:115](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/TagMutations.ts#L115) + +GraphQL mutation to remove people from multiple tags. + +## Param + +Id of the current tag. + +## Param + +Ids of the selected tags to be removed from. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_USER_TAG.md b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_USER_TAG.md new file mode 100644 index 0000000000..81adbe2227 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_USER_TAG.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: REMOVE\_USER\_TAG + +> `const` **REMOVE\_USER\_TAG**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/TagMutations.ts:68](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/TagMutations.ts#L68) + +GraphQL mutation to remove a user tag. + +## Param + +Id of the tag to be removed . diff --git a/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UNASSIGN_USER_TAG.md b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UNASSIGN_USER_TAG.md new file mode 100644 index 0000000000..d274d65ef8 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UNASSIGN_USER_TAG.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: UNASSIGN\_USER\_TAG + +> `const` **UNASSIGN\_USER\_TAG**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/TagMutations.ts:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/TagMutations.ts#L39) + +GraphQL mutation to unsssign a user tag from a user. + +## Param + +Id the tag. + +## Param + +Id of the user to be unassigned. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UPDATE_USER_TAG.md b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UPDATE_USER_TAG.md new file mode 100644 index 0000000000..d92ffbf79c --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UPDATE_USER_TAG.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_USER\_TAG + +> `const` **UPDATE\_USER\_TAG**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/TagMutations.ts:54](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/TagMutations.ts#L54) + +GraphQL mutation to update a user tag. + +## Param + +Id the tag. + +## Param + +Updated name of the tag. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/CREATE_VENUE_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/CREATE_VENUE_MUTATION.md new file mode 100644 index 0000000000..4d34ee7f30 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/CREATE_VENUE_MUTATION.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_VENUE\_MUTATION + +> `const` **CREATE\_VENUE\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/VenueMutations.ts:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/DELETE_VENUE_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/DELETE_VENUE_MUTATION.md new file mode 100644 index 0000000000..b101e49ef5 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/DELETE_VENUE_MUTATION.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_VENUE\_MUTATION + +> `const` **DELETE\_VENUE\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/VenueMutations.ts:73](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/VenueMutations.ts#L73) + +GraphQL mutation to delete a venue. + +## Param + +The id of the Venue to be deleted. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/UPDATE_VENUE_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/UPDATE_VENUE_MUTATION.md new file mode 100644 index 0000000000..9cf801b346 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/UPDATE_VENUE_MUTATION.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_VENUE\_MUTATION + +> `const` **UPDATE\_VENUE\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/VenueMutations.ts:45](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/VenueMutations.ts#L45) + +GraphQL mutation to update a venue. + +## Param + +The id of the Venue to be updated. + +## Param + +Ineteger representing capacity of venue. + +## Param + +Description of the venue. + +## Param + +Image file for the venue. + +## Param + +Name of the venue. diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ACCEPT_ORGANIZATION_REQUEST_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ACCEPT_ORGANIZATION_REQUEST_MUTATION.md new file mode 100644 index 0000000000..db9797d951 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ACCEPT_ORGANIZATION_REQUEST_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ACCEPT\_ORGANIZATION\_REQUEST\_MUTATION + +> `const` **ACCEPT\_ORGANIZATION\_REQUEST\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L33) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADDRESS_DETAILS_FRAGMENT.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADDRESS_DETAILS_FRAGMENT.md new file mode 100644 index 0000000000..20a375ab4f --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADDRESS_DETAILS_FRAGMENT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ADDRESS\_DETAILS\_FRAGMENT + +> `const` **ADDRESS\_DETAILS\_FRAGMENT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:70](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L70) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_ADMIN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_ADMIN_MUTATION.md new file mode 100644 index 0000000000..e32c7ca9ee --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_ADMIN_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_ADMIN\_MUTATION + +> `const` **ADD\_ADMIN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:351](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L351) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_ADVERTISEMENT_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_ADVERTISEMENT_MUTATION.md new file mode 100644 index 0000000000..0867f690a1 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_ADVERTISEMENT_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_ADVERTISEMENT\_MUTATION + +> `const` **ADD\_ADVERTISEMENT\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:486](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L486) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_MEMBER_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_MEMBER_MUTATION.md new file mode 100644 index 0000000000..cb1a8c94f4 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_MEMBER_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_MEMBER\_MUTATION + +> `const` **ADD\_MEMBER\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:361](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L361) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_PLUGIN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_PLUGIN_MUTATION.md new file mode 100644 index 0000000000..47e3243db6 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ADD_PLUGIN_MUTATION.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_PLUGIN\_MUTATION + +> `const` **ADD\_PLUGIN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:468](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L468) + +## Remarks + +used `createPlugin` to add new Plugin in database diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/BLOCK_USER_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/BLOCK_USER_MUTATION.md new file mode 100644 index 0000000000..5d99bfabb0 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/BLOCK_USER_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: BLOCK\_USER\_MUTATION + +> `const` **BLOCK\_USER\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L13) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_EVENT_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_EVENT_MUTATION.md new file mode 100644 index 0000000000..9edc14bc8a --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_EVENT_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_EVENT\_MUTATION + +> `const` **CREATE\_EVENT\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:265](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L265) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MUTATION.md new file mode 100644 index 0000000000..d250240de3 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_ORGANIZATION\_MUTATION + +> `const` **CREATE\_ORGANIZATION\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:227](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L227) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_POST_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_POST_MUTATION.md new file mode 100644 index 0000000000..370bbdc5ba --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_POST_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_POST\_MUTATION + +> `const` **CREATE\_POST\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:371](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L371) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ADVERTISEMENT_BY_ID.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ADVERTISEMENT_BY_ID.md new file mode 100644 index 0000000000..f52669336d --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ADVERTISEMENT_BY_ID.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_ADVERTISEMENT\_BY\_ID + +> `const` **DELETE\_ADVERTISEMENT\_BY\_ID**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:536](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L536) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_EVENT_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_EVENT_MUTATION.md new file mode 100644 index 0000000000..ed48e19326 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_EVENT_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_EVENT\_MUTATION + +> `const` **DELETE\_EVENT\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:321](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L321) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ORGANIZATION_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ORGANIZATION_MUTATION.md new file mode 100644 index 0000000000..d4933b43df --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ORGANIZATION_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_ORGANIZATION\_MUTATION + +> `const` **DELETE\_ORGANIZATION\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:253](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L253) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_POST_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_POST_MUTATION.md new file mode 100644 index 0000000000..c1d925836e --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_POST_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: DELETE\_POST\_MUTATION + +> `const` **DELETE\_POST\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:397](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L397) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DONATE_TO_ORGANIZATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DONATE_TO_ORGANIZATION.md new file mode 100644 index 0000000000..bbfa1aed92 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DONATE_TO_ORGANIZATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: DONATE\_TO\_ORGANIZATION + +> `const` **DONATE\_TO\_ORGANIZATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:663](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L663) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/FORGOT_PASSWORD_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/FORGOT_PASSWORD_MUTATION.md new file mode 100644 index 0000000000..bc1b486a5f --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/FORGOT_PASSWORD_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: FORGOT\_PASSWORD\_MUTATION + +> `const` **FORGOT\_PASSWORD\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:413](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L413) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/GENERATE_OTP_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/GENERATE_OTP_MUTATION.md new file mode 100644 index 0000000000..7bb6f6f5a0 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/GENERATE_OTP_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: GENERATE\_OTP\_MUTATION + +> `const` **GENERATE\_OTP\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:405](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L405) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LIKE_POST.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LIKE_POST.md new file mode 100644 index 0000000000..310a7c71d7 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LIKE_POST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: LIKE\_POST + +> `const` **LIKE\_POST**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:621](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L621) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LOGIN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LOGIN_MUTATION.md new file mode 100644 index 0000000000..6b0c25aa25 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LOGIN_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: LOGIN\_MUTATION + +> `const` **LOGIN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:175](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L175) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RECAPTCHA_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RECAPTCHA_MUTATION.md new file mode 100644 index 0000000000..de66e6d109 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RECAPTCHA_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: RECAPTCHA\_MUTATION + +> `const` **RECAPTCHA\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:219](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L219) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REFRESH_TOKEN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REFRESH_TOKEN_MUTATION.md new file mode 100644 index 0000000000..8efbe2eafd --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REFRESH_TOKEN_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REFRESH\_TOKEN\_MUTATION + +> `const` **REFRESH\_TOKEN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:200](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L200) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REGISTER_EVENT.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REGISTER_EVENT.md new file mode 100644 index 0000000000..08255fa8a5 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REGISTER_EVENT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REGISTER\_EVENT + +> `const` **REGISTER\_EVENT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:637](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L637) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REJECT_ORGANIZATION_REQUEST_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REJECT_ORGANIZATION_REQUEST_MUTATION.md new file mode 100644 index 0000000000..6837d05ecf --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REJECT_ORGANIZATION_REQUEST_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REJECT\_ORGANIZATION\_REQUEST\_MUTATION + +> `const` **REJECT\_ORGANIZATION\_REQUEST\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L23) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_ADMIN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_ADMIN_MUTATION.md new file mode 100644 index 0000000000..f6767bf4be --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_ADMIN_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REMOVE\_ADMIN\_MUTATION + +> `const` **REMOVE\_ADMIN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:333](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L333) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_MEMBER_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_MEMBER_MUTATION.md new file mode 100644 index 0000000000..d0071d0fac --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_MEMBER_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REMOVE\_MEMBER\_MUTATION + +> `const` **REMOVE\_MEMBER\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:342](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L342) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RESET_COMMUNITY.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RESET_COMMUNITY.md new file mode 100644 index 0000000000..16ee2f16f6 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RESET_COMMUNITY.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: RESET\_COMMUNITY + +> `const` **RESET\_COMMUNITY**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:657](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L657) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REVOKE_REFRESH_TOKEN.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REVOKE_REFRESH_TOKEN.md new file mode 100644 index 0000000000..6e67adcebe --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REVOKE_REFRESH_TOKEN.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REVOKE\_REFRESH\_TOKEN + +> `const` **REVOKE\_REFRESH\_TOKEN**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:211](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L211) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SIGNUP_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SIGNUP_MUTATION.md new file mode 100644 index 0000000000..bb2e222251 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SIGNUP_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: SIGNUP\_MUTATION + +> `const` **SIGNUP\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:147](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L147) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNBLOCK_USER_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNBLOCK_USER_MUTATION.md new file mode 100644 index 0000000000..e3f02c9ffd --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNBLOCK_USER_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UNBLOCK\_USER\_MUTATION + +> `const` **UNBLOCK\_USER\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L3) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNLIKE_POST.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNLIKE_POST.md new file mode 100644 index 0000000000..b4e0556ef4 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNLIKE_POST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UNLIKE\_POST + +> `const` **UNLIKE\_POST**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:629](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L629) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ADVERTISEMENT_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ADVERTISEMENT_MUTATION.md new file mode 100644 index 0000000000..8fb073df50 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ADVERTISEMENT_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ADVERTISEMENT\_MUTATION + +> `const` **UPDATE\_ADVERTISEMENT\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:511](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L511) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_COMMUNITY.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_COMMUNITY.md new file mode 100644 index 0000000000..eab047f5ec --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_COMMUNITY.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_COMMUNITY + +> `const` **UPDATE\_COMMUNITY**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:645](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L645) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_EVENT_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_EVENT_MUTATION.md new file mode 100644 index 0000000000..8b492bea17 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_EVENT_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_EVENT\_MUTATION + +> `const` **UPDATE\_EVENT\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:567](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L567) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_INSTALL_STATUS_PLUGIN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_INSTALL_STATUS_PLUGIN_MUTATION.md new file mode 100644 index 0000000000..91a47659f8 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_INSTALL_STATUS_PLUGIN_MUTATION.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_INSTALL\_STATUS\_PLUGIN\_MUTATION + +> `const` **UPDATE\_INSTALL\_STATUS\_PLUGIN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:434](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L434) + +## Remarks + +used to toggle `installStatus` (boolean value) of a Plugin diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORGANIZATION_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORGANIZATION_MUTATION.md new file mode 100644 index 0000000000..255d0ff2ef --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORGANIZATION_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ORGANIZATION\_MUTATION + +> `const` **UPDATE\_ORGANIZATION\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L43) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORG_STATUS_PLUGIN_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORG_STATUS_PLUGIN_MUTATION.md new file mode 100644 index 0000000000..c247aaefad --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORG_STATUS_PLUGIN_MUTATION.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ORG\_STATUS\_PLUGIN\_MUTATION + +> `const` **UPDATE\_ORG\_STATUS\_PLUGIN\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:451](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L451) + +## Remarks + +used `updatePluginStatus`to add or remove the current Organization the in the plugin list `uninstalledOrgs` diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_POST_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_POST_MUTATION.md new file mode 100644 index 0000000000..f5cfc48919 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_POST_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_POST\_MUTATION + +> `const` **UPDATE\_POST\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:545](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L545) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_SESSION_TIMEOUT.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_SESSION_TIMEOUT.md new file mode 100644 index 0000000000..32a2aa21cf --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_SESSION_TIMEOUT.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_SESSION\_TIMEOUT + +> `const` **UPDATE\_SESSION\_TIMEOUT**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:651](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L651) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_MUTATION.md new file mode 100644 index 0000000000..4d35e3a054 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_USER\_MUTATION + +> `const` **UPDATE\_USER\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:85](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L85) diff --git a/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_PASSWORD_MUTATION.md b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_PASSWORD_MUTATION.md new file mode 100644 index 0000000000..89f250c72d --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_PASSWORD_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_USER\_PASSWORD\_MUTATION + +> `const` **UPDATE\_USER\_PASSWORD\_MUTATION**: `DocumentNode` + +Defined in: [src/GraphQl/Mutations/mutations.ts:125](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Mutations/mutations.ts#L125) diff --git a/docs/docs/auto-docs/GraphQl/Queries/ActionItemCategoryQueries/variables/ACTION_ITEM_CATEGORY_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/ActionItemCategoryQueries/variables/ACTION_ITEM_CATEGORY_LIST.md new file mode 100644 index 0000000000..7f679ca0c6 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/ActionItemCategoryQueries/variables/ACTION_ITEM_CATEGORY_LIST.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: ACTION\_ITEM\_CATEGORY\_LIST + +> `const` **ACTION\_ITEM\_CATEGORY\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/ActionItemCategoryQueries.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/ActionItemCategoryQueries.ts#L10) + +GraphQL query to retrieve action item categories by organization. + +## Param + +The ID of the organization for which action item categories are being retrieved. + +## Returns + +The list of action item categories associated with the organization. diff --git a/docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEMS_BY_USER.md b/docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEMS_BY_USER.md new file mode 100644 index 0000000000..6bfc23dea9 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEMS_BY_USER.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ACTION\_ITEMS\_BY\_USER + +> `const` **ACTION\_ITEMS\_BY\_USER**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/ActionItemQueries.ts:78](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/ActionItemQueries.ts#L78) diff --git a/docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEM_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEM_LIST.md new file mode 100644 index 0000000000..dee8e9c7e2 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEM_LIST.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: ACTION\_ITEM\_LIST + +> `const` **ACTION\_ITEM\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/ActionItemQueries.ts:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/AgendaCategoryQueries/variables/AGENDA_ITEM_CATEGORY_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/AgendaCategoryQueries/variables/AGENDA_ITEM_CATEGORY_LIST.md new file mode 100644 index 0000000000..2ffdcccea0 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/AgendaCategoryQueries/variables/AGENDA_ITEM_CATEGORY_LIST.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: AGENDA\_ITEM\_CATEGORY\_LIST + +> `const` **AGENDA\_ITEM\_CATEGORY\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/AgendaCategoryQueries.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/AgendaItemQueries/variables/AgendaItemByEvent.md b/docs/docs/auto-docs/GraphQl/Queries/AgendaItemQueries/variables/AgendaItemByEvent.md new file mode 100644 index 0000000000..bbca645a16 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/AgendaItemQueries/variables/AgendaItemByEvent.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: AgendaItemByEvent + +> `const` **AgendaItemByEvent**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/AgendaItemQueries.ts:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/AgendaItemQueries.ts#L39) diff --git a/docs/docs/auto-docs/GraphQl/Queries/AgendaItemQueries/variables/AgendaItemByOrganization.md b/docs/docs/auto-docs/GraphQl/Queries/AgendaItemQueries/variables/AgendaItemByOrganization.md new file mode 100644 index 0000000000..7935671465 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/AgendaItemQueries/variables/AgendaItemByOrganization.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: AgendaItemByOrganization + +> `const` **AgendaItemByOrganization**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/AgendaItemQueries.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/AgendaItemQueries.ts#L3) diff --git a/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_GROUP_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_GROUP_LIST.md new file mode 100644 index 0000000000..5028a1a756 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_GROUP_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EVENT\_VOLUNTEER\_GROUP\_LIST + +> `const` **EVENT\_VOLUNTEER\_GROUP\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/EventVolunteerQueries.ts#L41) diff --git a/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_LIST.md new file mode 100644 index 0000000000..aae9bb15bc --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_LIST.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: EVENT\_VOLUNTEER\_LIST + +> `const` **EVENT\_VOLUNTEER\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/USER_VOLUNTEER_MEMBERSHIP.md b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/USER_VOLUNTEER_MEMBERSHIP.md new file mode 100644 index 0000000000..17a5214aad --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/USER_VOLUNTEER_MEMBERSHIP.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_VOLUNTEER\_MEMBERSHIP + +> `const` **USER\_VOLUNTEER\_MEMBERSHIP**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:89](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/EventVolunteerQueries.ts#L89) diff --git a/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/VOLUNTEER_RANKING.md b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/VOLUNTEER_RANKING.md new file mode 100644 index 0000000000..a070a40849 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/VOLUNTEER_RANKING.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: VOLUNTEER\_RANKING + +> `const` **VOLUNTEER\_RANKING**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:120](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/EventVolunteerQueries.ts#L120) diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_ADMINS_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_ADMINS_LIST.md new file mode 100644 index 0000000000..ac477cd4a9 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_ADMINS_LIST.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_ADMINS\_LIST + +> `const` **ORGANIZATION\_ADMINS\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:314](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L314) + +GraphQL query to retrieve the list of admins for a specific organization. + +## Param + +The ID of the organization for which admins are being retrieved. + +## Returns + +The list of admins associated with the organization. diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_ADVERTISEMENT_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_ADVERTISEMENT_LIST.md new file mode 100644 index 0000000000..df2837495a --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_ADVERTISEMENT_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_ADVERTISEMENT\_LIST + +> `const` **ORGANIZATION\_ADVERTISEMENT\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:134](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L134) diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_FUNDS.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_FUNDS.md new file mode 100644 index 0000000000..6d8269affc --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_FUNDS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_FUNDS + +> `const` **ORGANIZATION\_FUNDS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:335](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L335) + +GraphQL query to retrieve the list of members for a specific organization. + +## Param + +The ID of the organization for which members are being retrieved. + +## Returns + +The list of members associated with the organization. diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_POST_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_POST_LIST.md new file mode 100644 index 0000000000..94c9799e54 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_POST_LIST.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_POST\_LIST + +> `const` **ORGANIZATION\_POST\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L15) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_USER_TAGS_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_USER_TAGS_LIST.md new file mode 100644 index 0000000000..99c8ded7e2 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_USER_TAGS_LIST.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_USER\_TAGS\_LIST + +> `const` **ORGANIZATION\_USER\_TAGS\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:83](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L83) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_CREATED_ORGANIZATIONS.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_CREATED_ORGANIZATIONS.md new file mode 100644 index 0000000000..42c53f33f3 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_CREATED_ORGANIZATIONS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_CREATED\_ORGANIZATIONS + +> `const` **USER\_CREATED\_ORGANIZATIONS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:276](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L276) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_JOINED_ORGANIZATIONS.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_JOINED_ORGANIZATIONS.md new file mode 100644 index 0000000000..725f48a467 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_JOINED_ORGANIZATIONS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_JOINED\_ORGANIZATIONS + +> `const` **USER\_JOINED\_ORGANIZATIONS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:238](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L238) + +GraphQL query to retrieve organizations joined by a user. + +## Param + +The ID of the user for which joined organizations are being retrieved. + +## Returns + +The list of organizations joined by the user. diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_ORGANIZATION_CONNECTION.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_ORGANIZATION_CONNECTION.md new file mode 100644 index 0000000000..c04d2f0793 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_ORGANIZATION_CONNECTION.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_ORGANIZATION\_CONNECTION + +> `const` **USER\_ORGANIZATION\_CONNECTION**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:182](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L182) + +GraphQL query to retrieve organizations based on user connection. + +## 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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/VENUE_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/VENUE_LIST.md new file mode 100644 index 0000000000..b1c0428a01 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/VENUE_LIST.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: VENUE\_LIST + +> `const` **VENUE\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/OrganizationQueries.ts:357](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/OrganizationQueries.ts#L357) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ADVERTISEMENTS_GET.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ADVERTISEMENTS_GET.md new file mode 100644 index 0000000000..9148c258c0 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ADVERTISEMENTS_GET.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: ADVERTISEMENTS\_GET + +> `const` **ADVERTISEMENTS\_GET**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L27) + +GraphQL query to retrieve a list of advertisements. + +## Returns + +The list of advertisements with details such as ID, name, type, organization ID, link, start date, and end date. diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHATS_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHATS_LIST.md new file mode 100644 index 0000000000..04fb3a6828 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHATS_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CHATS\_LIST + +> `const` **CHATS\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:304](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L304) diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHAT_BY_ID.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHAT_BY_ID.md new file mode 100644 index 0000000000..2eb4a10b0b --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHAT_BY_ID.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: CHAT\_BY\_ID + +> `const` **CHAT\_BY\_ID**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:156](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L156) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/GROUP_CHAT_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/GROUP_CHAT_LIST.md new file mode 100644 index 0000000000..ffba1a13b1 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/GROUP_CHAT_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: GROUP\_CHAT\_LIST + +> `const` **GROUP\_CHAT\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:210](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L210) diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/IS_SAMPLE_ORGANIZATION_QUERY.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/IS_SAMPLE_ORGANIZATION_QUERY.md new file mode 100644 index 0000000000..16b8908f1d --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/IS_SAMPLE_ORGANIZATION_QUERY.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: IS\_SAMPLE\_ORGANIZATION\_QUERY + +> `const` **IS\_SAMPLE\_ORGANIZATION\_QUERY**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:366](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L366) + +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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ORGANIZATION_CUSTOM_FIELDS.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ORGANIZATION_CUSTOM_FIELDS.md new file mode 100644 index 0000000000..4cb1e5f3fe --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ORGANIZATION_CUSTOM_FIELDS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_CUSTOM\_FIELDS + +> `const` **ORGANIZATION\_CUSTOM\_FIELDS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:379](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L379) + +GraphQL query to retrieve custom fields for a specific organization. + +## Param + +The ID of the organization for which custom fields are being retrieved. + +## Returns + +The list of custom fields associated with the organization, including details such as ID, type, and name. diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ORGANIZATION_EVENTS_CONNECTION.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ORGANIZATION_EVENTS_CONNECTION.md new file mode 100644 index 0000000000..774f6152d6 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/ORGANIZATION_EVENTS_CONNECTION.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_EVENTS\_CONNECTION + +> `const` **ORGANIZATION\_EVENTS\_CONNECTION**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:59](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L59) + +GraphQL query to retrieve a list of events based on organization connection. + +## Param + +The ID of the organization for which events are being retrieved. + +## Param + +Optional. Filter events by title containing a specified string. + +## Param + +Optional. Filter events by description containing a specified string. + +## Param + +Optional. Filter events by location containing a specified string. + +## Param + +Optional. Number of events to retrieve in the first batch. + +## Param + +Optional. Number of events to skip before starting to collect the result set. + +## Returns + +The list of events associated with the organization based on the applied filters. diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/PLUGIN_GET.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/PLUGIN_GET.md new file mode 100644 index 0000000000..5e644024f5 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/PLUGIN_GET.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Variable: PLUGIN\_GET + +> `const` **PLUGIN\_GET**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L9) + +GraphQL query to retrieve a list of plugins. + +## Returns + +The list of plugins with details such as ID, name, creator, description, and uninstalled organizations. diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/UNREAD_CHAT_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/UNREAD_CHAT_LIST.md new file mode 100644 index 0000000000..ddf034b98d --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/UNREAD_CHAT_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UNREAD\_CHAT\_LIST + +> `const` **UNREAD\_CHAT\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:257](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L257) diff --git a/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/USER_EVENTS_VOLUNTEER.md b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/USER_EVENTS_VOLUNTEER.md new file mode 100644 index 0000000000..378928bfdf --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/USER_EVENTS_VOLUNTEER.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_EVENTS\_VOLUNTEER + +> `const` **USER\_EVENTS\_VOLUNTEER**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/PlugInQueries.ts:102](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/PlugInQueries.ts#L102) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ADMIN_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ADMIN_LIST.md new file mode 100644 index 0000000000..3e6c9b8c26 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ADMIN_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ADMIN\_LIST + +> `const` **ADMIN\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:707](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L707) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/BLOCK_PAGE_MEMBER_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/BLOCK_PAGE_MEMBER_LIST.md new file mode 100644 index 0000000000..9d42e0b786 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/BLOCK_PAGE_MEMBER_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: BLOCK\_PAGE\_MEMBER\_LIST + +> `const` **BLOCK\_PAGE\_MEMBER\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:451](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L451) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/CHECK_AUTH.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/CHECK_AUTH.md new file mode 100644 index 0000000000..bd3b07cb64 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/CHECK_AUTH.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CHECK\_AUTH + +> `const` **CHECK\_AUTH**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L5) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_ATTENDEES.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_ATTENDEES.md new file mode 100644 index 0000000000..25275103cd --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_ATTENDEES.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EVENT\_ATTENDEES + +> `const` **EVENT\_ATTENDEES**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:313](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L313) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_CHECKINS.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_CHECKINS.md new file mode 100644 index 0000000000..7cd7861a2b --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_CHECKINS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EVENT\_CHECKINS + +> `const` **EVENT\_CHECKINS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:341](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L341) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_DETAILS.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_DETAILS.md new file mode 100644 index 0000000000..c23662b28c --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_DETAILS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EVENT\_DETAILS + +> `const` **EVENT\_DETAILS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:268](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L268) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_FEEDBACKS.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_FEEDBACKS.md new file mode 100644 index 0000000000..27ded61c0f --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_FEEDBACKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EVENT\_FEEDBACKS + +> `const` **EVENT\_FEEDBACKS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:361](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L361) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_REGISTRANTS.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_REGISTRANTS.md new file mode 100644 index 0000000000..2ccb9ff148 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_REGISTRANTS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EVENT\_REGISTRANTS + +> `const` **EVENT\_REGISTRANTS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:331](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L331) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_DATA.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_DATA.md new file mode 100644 index 0000000000..302da5146c --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_DATA.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: GET\_COMMUNITY\_DATA + +> `const` **GET\_COMMUNITY\_DATA**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:839](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L839) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_SESSION_TIMEOUT_DATA.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_SESSION_TIMEOUT_DATA.md new file mode 100644 index 0000000000..099d4410ed --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_SESSION_TIMEOUT_DATA.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: GET\_COMMUNITY\_SESSION\_TIMEOUT\_DATA + +> `const` **GET\_COMMUNITY\_SESSION\_TIMEOUT\_DATA**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:860](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L860) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERSHIP_REQUEST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERSHIP_REQUEST.md new file mode 100644 index 0000000000..fcc37a33ca --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERSHIP_REQUEST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MEMBERSHIP\_REQUEST + +> `const` **MEMBERSHIP\_REQUEST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:724](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L724) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST.md new file mode 100644 index 0000000000..cfa909da07 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MEMBERS\_LIST + +> `const` **MEMBERS\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:432](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L432) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md new file mode 100644 index 0000000000..2a666a29aa --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATIONS\_LIST + +> `const` **ORGANIZATIONS\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:376](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L376) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_MEMBER_CONNECTION_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_MEMBER_CONNECTION_LIST.md new file mode 100644 index 0000000000..d73bf20bed --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_MEMBER_CONNECTION_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATIONS\_MEMBER\_CONNECTION\_LIST + +> `const` **ORGANIZATIONS\_MEMBER\_CONNECTION\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:478](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L478) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_CONNECTION_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_CONNECTION_LIST.md new file mode 100644 index 0000000000..9c0766d4ae --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_CONNECTION_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_CONNECTION\_LIST + +> `const` **ORGANIZATION\_CONNECTION\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:67](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L67) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_DONATION_CONNECTION_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_DONATION_CONNECTION_LIST.md new file mode 100644 index 0000000000..68612838f0 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_DONATION_CONNECTION_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_DONATION\_CONNECTION\_LIST + +> `const` **ORGANIZATION\_DONATION\_CONNECTION\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:686](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L686) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_CONNECTION_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_CONNECTION_LIST.md new file mode 100644 index 0000000000..6a6e3dc163 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_CONNECTION_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_EVENT\_CONNECTION\_LIST + +> `const` **ORGANIZATION\_EVENT\_CONNECTION\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:630](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L630) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_LIST.md new file mode 100644 index 0000000000..767f15c4e7 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_EVENT\_LIST + +> `const` **ORGANIZATION\_EVENT\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:611](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L611) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_LIST.md new file mode 100644 index 0000000000..aab34d54a7 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ORGANIZATION\_LIST + +> `const` **ORGANIZATION\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L35) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/RECURRING_EVENTS.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/RECURRING_EVENTS.md new file mode 100644 index 0000000000..a6de0bcb6f --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/RECURRING_EVENTS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: RECURRING\_EVENTS + +> `const` **RECURRING\_EVENTS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:299](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L299) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USERS_CONNECTION_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USERS_CONNECTION_LIST.md new file mode 100644 index 0000000000..5c93801f7e --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USERS_CONNECTION_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USERS\_CONNECTION\_LIST + +> `const` **USERS\_CONNECTION\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:750](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L750) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_DETAILS.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_DETAILS.md new file mode 100644 index 0000000000..a94b8ddcdd --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_DETAILS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_DETAILS + +> `const` **USER\_DETAILS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:522](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L522) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST.md new file mode 100644 index 0000000000..ab4e7410b3 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_LIST + +> `const` **USER\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:109](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L109) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_FOR_TABLE.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_FOR_TABLE.md new file mode 100644 index 0000000000..1f3729d176 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_FOR_TABLE.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_LIST\_FOR\_TABLE + +> `const` **USER\_LIST\_FOR\_TABLE**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:205](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L205) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_REQUEST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_REQUEST.md new file mode 100644 index 0000000000..fdd8f071f3 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_REQUEST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_LIST\_REQUEST + +> `const` **USER\_LIST\_REQUEST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:225](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L225) diff --git a/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_ORGANIZATION_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_ORGANIZATION_LIST.md new file mode 100644 index 0000000000..af47ff65ca --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_ORGANIZATION_LIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_ORGANIZATION\_LIST + +> `const` **USER\_ORGANIZATION\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/Queries.ts:508](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/Queries.ts#L508) diff --git a/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN.md b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN.md new file mode 100644 index 0000000000..1bae141313 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: FUND\_CAMPAIGN + +> `const` **FUND\_CAMPAIGN**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/fundQueries.ts:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/fundQueries.ts#L39) diff --git a/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN_PLEDGE.md b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN_PLEDGE.md new file mode 100644 index 0000000000..6cc93118cb --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN_PLEDGE.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: FUND\_CAMPAIGN\_PLEDGE + +> `const` **FUND\_CAMPAIGN\_PLEDGE**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/fundQueries.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/fundQueries.ts#L60) diff --git a/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_LIST.md b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_LIST.md new file mode 100644 index 0000000000..ac73cf5fae --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_LIST.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: FUND\_LIST + +> `const` **FUND\_LIST**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/fundQueries.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/fundQueries.ts#L11) + +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 filter to search for a specific member. + +## Returns + +The list of members associated with the organization. diff --git a/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_FUND_CAMPAIGNS.md b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_FUND_CAMPAIGNS.md new file mode 100644 index 0000000000..d23837db03 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_FUND_CAMPAIGNS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_FUND\_CAMPAIGNS + +> `const` **USER\_FUND\_CAMPAIGNS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/fundQueries.ts:91](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/fundQueries.ts#L91) diff --git a/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_PLEDGES.md b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_PLEDGES.md new file mode 100644 index 0000000000..bb389afdd1 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_PLEDGES.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_PLEDGES + +> `const` **USER\_PLEDGES**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/fundQueries.ts:107](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/GraphQl/Queries/fundQueries.ts#L107) diff --git a/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_ASSIGNED_MEMBERS.md b/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_ASSIGNED_MEMBERS.md new file mode 100644 index 0000000000..ab1a47c45c --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_ASSIGNED_MEMBERS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_TAGS\_ASSIGNED\_MEMBERS + +> `const` **USER\_TAGS\_ASSIGNED\_MEMBERS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/userTagQueries.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_MEMBERS_TO_ASSIGN_TO.md b/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_MEMBERS_TO_ASSIGN_TO.md new file mode 100644 index 0000000000..086140920a --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_MEMBERS_TO_ASSIGN_TO.md @@ -0,0 +1,19 @@ +[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/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAG_SUB_TAGS.md b/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAG_SUB_TAGS.md new file mode 100644 index 0000000000..0a62efdfe4 --- /dev/null +++ b/docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAG_SUB_TAGS.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_TAG\_SUB\_TAGS + +> `const` **USER\_TAG\_SUB\_TAGS**: `DocumentNode` + +Defined in: [src/GraphQl/Queries/userTagQueries.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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. diff --git a/docs/docs/auto-docs/components/AddOn/AddOn/functions/default.md b/docs/docs/auto-docs/components/AddOn/AddOn/functions/default.md new file mode 100644 index 0000000000..220a70341f --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/AddOn/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/AddOn/AddOn.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/AddOn.tsx#L22) + +The AddOn component is used to wrap children within a plugin container. +It also accepts additional properties (`extras` and `name`) to allow for +extensibility and custom naming. + +## Parameters + +### \_\_namedParameters + +`InterfaceAddOnProps` + +## Returns + +`JSX.Element` + +The JSX element representing the AddOn component. diff --git a/docs/docs/auto-docs/components/AddOn/core/AddOnEntry/AddOnEntry/functions/default.md b/docs/docs/auto-docs/components/AddOn/core/AddOnEntry/AddOnEntry/functions/default.md new file mode 100644 index 0000000000..0c1c85de10 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/core/AddOnEntry/AddOnEntry/functions/default.md @@ -0,0 +1,41 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/AddOn/core/AddOnEntry/AddOnEntry.tsx:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/core/AddOnEntry/AddOnEntry.tsx#L46) + +A React component that represents an add-on entry, displaying its details and allowing installation or uninstallation. + +## Parameters + +### props + +`InterfaceAddOnEntryProps` + +The properties for the component. + +## Returns + +`JSX.Element` + +A JSX element containing the add-on entry. + +## Example + +```tsx + {}} +/> +``` diff --git a/docs/docs/auto-docs/components/AddOn/core/AddOnEntry/AddOnEntryMocks/variables/ADD_ON_ENTRY_MOCK.md b/docs/docs/auto-docs/components/AddOn/core/AddOnEntry/AddOnEntryMocks/variables/ADD_ON_ENTRY_MOCK.md new file mode 100644 index 0000000000..ed32c17e89 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/core/AddOnEntry/AddOnEntryMocks/variables/ADD_ON_ENTRY_MOCK.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Variable: ADD\_ON\_ENTRY\_MOCK + +> `const` **ADD\_ON\_ENTRY\_MOCK**: `object`[] + +Defined in: [src/components/AddOn/core/AddOnEntry/AddOnEntryMocks.ts:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/core/AddOnEntry/AddOnEntryMocks.ts#L13) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `UPDATE_INSTALL_STATUS_PLUGIN_MUTATION` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'1'` + +#### request.variables.orgId + +> **orgId**: `string` = `'undefined'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.updatePluginStatus + +> **updatePluginStatus**: `object` = `updatePluginStatus` + +#### result.data.updatePluginStatus.\_id + +> **\_id**: `string` = `'123'` + +#### result.data.updatePluginStatus.pluginCreatedBy + +> **pluginCreatedBy**: `string` = `'John Doe'` + +#### result.data.updatePluginStatus.pluginDesc + +> **pluginDesc**: `string` = `'This is a sample plugin description.'` + +#### result.data.updatePluginStatus.pluginName + +> **pluginName**: `string` = `'Sample Plugin'` + +#### result.data.updatePluginStatus.uninstalledOrgs + +> **uninstalledOrgs**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/components/AddOn/core/AddOnRegister/AddOnRegister/functions/default.md b/docs/docs/auto-docs/components/AddOn/core/AddOnRegister/AddOnRegister/functions/default.md new file mode 100644 index 0000000000..98cdf02568 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/core/AddOnRegister/AddOnRegister/functions/default.md @@ -0,0 +1,30 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/AddOn/core/AddOnRegister/AddOnRegister.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/core/AddOnRegister/AddOnRegister.tsx#L38) + +A React component for registering a new add-on plugin. + +This component: +- Displays a button to open a modal for plugin registration. +- Contains a form in the modal for entering plugin details. +- Uses GraphQL mutation to register the plugin. +- Uses `react-i18next` for localization and `react-toastify` for notifications. +- Redirects to the organization list page if no `orgId` is found in the URL. + +## Parameters + +### \_\_namedParameters + +`InterfaceAddOnRegisterProps` + +## Returns + +`JSX.Element` + +A JSX element containing the button and modal for plugin registration. diff --git a/docs/docs/auto-docs/components/AddOn/core/AddOnStore/AddOnStore/functions/default.md b/docs/docs/auto-docs/components/AddOn/core/AddOnStore/AddOnStore/functions/default.md new file mode 100644 index 0000000000..d47d622b88 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/core/AddOnStore/AddOnStore/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/AddOn/core/AddOnStore/AddOnStore.tsx:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/core/AddOnStore/AddOnStore.tsx#L37) + +Component for managing and displaying plugins in the store. + +This component: +- Displays a search input and filter options. +- Uses tabs to switch between available and installed plugins. +- Fetches plugins from a GraphQL endpoint and filters them based on search criteria. +- Utilizes Redux store to manage plugin data. + +## Returns + +`JSX.Element` + +A JSX element containing the UI for the add-on store. diff --git a/docs/docs/auto-docs/components/AddOn/support/components/Action/Action/functions/default.md b/docs/docs/auto-docs/components/AddOn/support/components/Action/Action/functions/default.md new file mode 100644 index 0000000000..2426ea3674 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/support/components/Action/Action/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/AddOn/support/components/Action/Action.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/components/Action/Action.tsx#L29) + +A React component that renders a labeled container for embedded actions. + +## Parameters + +### props + +`InterfaceActionProps` + +The properties for the component. + +## Returns + +`JSX.Element` + +A JSX element containing the label and child elements. + +## Example + +```ts + + + +``` diff --git a/docs/docs/auto-docs/components/AddOn/support/components/MainContent/MainContent/functions/default.md b/docs/docs/auto-docs/components/AddOn/support/components/MainContent/MainContent/functions/default.md new file mode 100644 index 0000000000..7c1661926b --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/support/components/MainContent/MainContent/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/AddOn/support/components/MainContent/MainContent.tsx:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/components/MainContent/MainContent.tsx#L25) + +A React component that renders a main content container with additional styles. + +## Parameters + +### props + +`InterfaceMainContentProps` + +The properties for the component. + +## Returns + +`JSX.Element` + +A JSX element containing the main content container with the provided child elements. + +## Example + +```ts + +

Main content goes here

+ +``` diff --git a/docs/docs/auto-docs/components/AddOn/support/components/SidePanel/SidePanel/functions/default.md b/docs/docs/auto-docs/components/AddOn/support/components/SidePanel/SidePanel/functions/default.md new file mode 100644 index 0000000000..d1853c7091 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/support/components/SidePanel/SidePanel/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/AddOn/support/components/SidePanel/SidePanel.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/components/SidePanel/SidePanel.tsx#L30) + +A React component that renders a side panel with an optional collapse state. + +## Parameters + +### props + +`InterfaceSidePanelProps` + +The properties for the component. + +## Returns + +`JSX.Element` + +A JSX element containing the side panel with the provided child elements. + +## Example + +```ts + +

Side panel content

+ +``` diff --git a/docs/docs/auto-docs/components/AddOn/support/services/Plugin.helper/classes/default.md b/docs/docs/auto-docs/components/AddOn/support/services/Plugin.helper/classes/default.md new file mode 100644 index 0000000000..ecac6ef569 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/support/services/Plugin.helper/classes/default.md @@ -0,0 +1,75 @@ +[Admin Docs](/) + +*** + +# Class: default + +Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/services/Plugin.helper.ts#L5) + +Helper class for managing plugin-related tasks such as fetching store data, installed plugins, and generating plugin links. + +## Constructors + +### new default() + +> **new default**(): [`default`](default.md) + +#### Returns + +[`default`](default.md) + +## Methods + +### fetchInstalled() + +> **fetchInstalled**(): `Promise`\<`any`\> + +Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/services/Plugin.helper.ts#L21) + +Fetches the list of installed plugins from a local server. + +#### Returns + +`Promise`\<`any`\> + +A promise that resolves to the installed plugins data in JSON format. + +*** + +### fetchStore() + +> **fetchStore**(): `Promise`\<`any`\> + +Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/services/Plugin.helper.ts#L11) + +Fetches the store data from a local server. + +#### Returns + +`Promise`\<`any`\> + +A promise that resolves to the store data in JSON format. + +*** + +### generateLinks() + +> **generateLinks**(`plugins`): `object`[] + +Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/services/Plugin.helper.ts#L32) + +Generates an array of links for the enabled plugins. + +#### Parameters + +##### plugins + +`any`[] + +An array of plugin objects. + +#### Returns + +`object`[] + +An array of objects containing the name and URL of each enabled plugin. diff --git a/docs/docs/auto-docs/components/AddOn/support/services/Render.helper/classes/default.md b/docs/docs/auto-docs/components/AddOn/support/services/Render.helper/classes/default.md new file mode 100644 index 0000000000..9ab1f4b4f6 --- /dev/null +++ b/docs/docs/auto-docs/components/AddOn/support/services/Render.helper/classes/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Class: default + +Defined in: [src/components/AddOn/support/services/Render.helper.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddOn/support/services/Render.helper.ts#L1) + +## Constructors + +### new default() + +> **new default**(): [`default`](default.md) + +#### Returns + +[`default`](default.md) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md new file mode 100644 index 0000000000..c6bdf8ccf6 --- /dev/null +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L42) + +## Parameters + +### props + +[`InterfaceAddPeopleToTagProps`](../interfaces/InterfaceAddPeopleToTagProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md new file mode 100644 index 0000000000..cfc9e230ea --- /dev/null +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md @@ -0,0 +1,57 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAddPeopleToTagProps + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L28) + +Props for the `AddPeopleToTag` component. + +## Properties + +### addPeopleToTagModalIsOpen + +> **addPeopleToTagModalIsOpen**: `boolean` + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L29) + +*** + +### hideAddPeopleToTagModal() + +> **hideAddPeopleToTagModal**: () => `void` + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L30) + +#### Returns + +`void` + +*** + +### refetchAssignedMembersData() + +> **refetchAssignedMembersData**: () => `void` + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L31) + +#### Returns + +`void` + +*** + +### t + +> **t**: `TFunction`\<`"manageTag"`\> + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L32) + +*** + +### tCommon + +> **tCommon**: `TFunction`\<`"common"`\> + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L33) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..d48d0aefcb --- /dev/null +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[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/AddPeopleToTag/AddPeopleToTagsMocks.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L5) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..f6801d82e6 --- /dev/null +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS_ERROR.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: `object`[] + +Defined in: [src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:277](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/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` = `''` diff --git a/docs/docs/auto-docs/components/Advertisements/Advertisements/functions/default.md b/docs/docs/auto-docs/components/Advertisements/Advertisements/functions/default.md new file mode 100644 index 0000000000..ac5bcae727 --- /dev/null +++ b/docs/docs/auto-docs/components/Advertisements/Advertisements/functions/default.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/Advertisements/Advertisements.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Advertisements/Advertisements.tsx#L14) + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry/functions/default.md b/docs/docs/auto-docs/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry/functions/default.md new file mode 100644 index 0000000000..52b5dc8b11 --- /dev/null +++ b/docs/docs/auto-docs/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry/functions/default.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx#L31) + +Component for displaying an advertisement entry. +Allows viewing, editing, and deleting of the advertisement. + +## Parameters + +### props + +`InterfaceAddOnEntryProps` + +Component properties + +## Returns + +`JSX.Element` + +The rendered component diff --git a/docs/docs/auto-docs/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister/functions/default.md b/docs/docs/auto-docs/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister/functions/default.md new file mode 100644 index 0000000000..01d262840d --- /dev/null +++ b/docs/docs/auto-docs/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister/functions/default.md @@ -0,0 +1,34 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx#L60) + +Component for registering or editing an advertisement. + +## Parameters + +### props + +`InterfaceAddOnRegisterProps` + +Contains form status, advertisement details, and a function to update parent state. + +## Returns + +`JSX.Element` + +A JSX element that renders a form inside a modal for creating or editing an advertisement. + +## Example + +```tsx + console.log(value)} +/> +``` diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainer/functions/default.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainer/functions/default.md new file mode 100644 index 0000000000..b6a6d05346 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainer/functions/default.md @@ -0,0 +1,45 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/AgendaCategory/AgendaCategoryContainer.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaCategory/AgendaCategoryContainer.tsx#L34) + +Component for displaying and managing agenda item categories. + +## Parameters + +### props + +Contains agenda category data and functions for data management. + +#### agendaCategoryConnection + +`"Organization"` + +#### agendaCategoryData + +[`InterfaceAgendaItemCategoryInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md)[] + +#### agendaCategoryRefetch + +() => `void` + +## Returns + +`JSX.Element` + +A JSX element that renders agenda item categories with options to preview, edit, and delete. + +## Example + +```tsx + +``` diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS.md new file mode 100644 index 0000000000..ba58dcfe15 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `deleteAgendaCategoryId`: `undefined`; `input`: \{ `description`: `string`; `name`: `string`; \}; `updateAgendaCategoryId`: `string`; \}; \}; `result`: \{ `data`: \{ `deleteAgendaCategory`: `undefined`; `updateAgendaCategory`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `deleteAgendaCategoryId`: `string`; `input`: `undefined`; `updateAgendaCategoryId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `deleteAgendaCategory`: \{ `_id`: `string`; \}; `updateAgendaCategory`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/AgendaCategory/AgendaCategoryContainerMocks.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaCategory/AgendaCategoryContainerMocks.ts#L6) diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS_ERROR_MUTATIONS.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS_ERROR_MUTATIONS.md new file mode 100644 index 0000000000..a57e2addd7 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS_ERROR_MUTATIONS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_MUTATIONS + +> `const` **MOCKS\_ERROR\_MUTATIONS**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `deleteAgendaCategoryId`: `undefined`; `input`: \{ `description`: `string`; `name`: `string`; \}; `updateAgendaCategoryId`: `string`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `deleteAgendaCategoryId`: `string`; `input`: `undefined`; `updateAgendaCategoryId`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/AgendaCategory/AgendaCategoryContainerMocks.ts:81](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaCategory/AgendaCategoryContainerMocks.ts#L81) diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props.md new file mode 100644 index 0000000000..1c048cc351 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: props + +> `const` **props**: `object` + +Defined in: [src/components/AgendaCategory/AgendaCategoryContainerProps.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaCategory/AgendaCategoryContainerProps.ts#L4) + +## Type declaration + +### agendaCategoryConnection + +> **agendaCategoryConnection**: `"Organization"` + +### agendaCategoryData + +> **agendaCategoryData**: `object`[] + +### agendaCategoryRefetch + +> **agendaCategoryRefetch**: `Mock` diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props2.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props2.md new file mode 100644 index 0000000000..87855ee96c --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props2.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: props2 + +> `const` **props2**: `object` + +Defined in: [src/components/AgendaCategory/AgendaCategoryContainerProps.ts:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaCategory/AgendaCategoryContainerProps.ts#L31) + +## Type declaration + +### agendaCategoryConnection + +> **agendaCategoryConnection**: `"Organization"` + +### agendaCategoryData + +> **agendaCategoryData**: `any`[] = `[]` + +### agendaCategoryRefetch + +> **agendaCategoryRefetch**: `Mock` diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainer/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainer/functions/default.md new file mode 100644 index 0000000000..dbd8a573bf --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainer/functions/default.md @@ -0,0 +1,41 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/AgendaItems/AgendaItemsContainer.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsContainer.tsx#L32) + +Component for displaying and managing agenda items. +Supports drag-and-drop functionality, and includes modals for previewing, +updating, and deleting agenda items. + +## Parameters + +### props + +The props for the component. + +#### agendaItemCategories + +[`InterfaceAgendaItemCategoryInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md)[] + +#### agendaItemConnection + +`"Event"` + +#### agendaItemData + +[`InterfaceAgendaItemInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemInfo.md)[] + +#### agendaItemRefetch + +() => `void` + +## Returns + +`JSX.Element` + +JSX.Element diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS.md new file mode 100644 index 0000000000..405b4f928f --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: \{ `description`: `string`; `title`: `string`; \}; `removeAgendaItemId`: `undefined`; `updateAgendaItemId`: `string`; \}; \}; `result`: \{ `data`: \{ `removeAgendaItem`: `undefined`; `updateAgendaItem`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `removeAgendaItemId`: `string`; `updateAgendaItemId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `removeAgendaItem`: \{ `_id`: `string`; \}; `updateAgendaItem`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/AgendaItems/AgendaItemsContainerMocks.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsContainerMocks.ts#L6) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..31ee4b5da3 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: \{ `description`: `string`; `title`: `string`; \}; `removeAgendaItemId`: `undefined`; `updateAgendaItemId`: `string`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `removeAgendaItemId`: `string`; `updateAgendaItemId`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/AgendaItems/AgendaItemsContainerMocks.ts:96](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsContainerMocks.ts#L96) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props.md new file mode 100644 index 0000000000..20a7813b76 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Variable: props + +> `const` **props**: `object` + +Defined in: [src/components/AgendaItems/AgendaItemsContainerProps.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsContainerProps.ts#L4) + +## Type declaration + +### agendaItemCategories + +> **agendaItemCategories**: `object`[] + +### agendaItemConnection + +> **agendaItemConnection**: `"Event"` + +### agendaItemData + +> **agendaItemData**: `object`[] + +### agendaItemRefetch + +> **agendaItemRefetch**: `Mock` diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props2.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props2.md new file mode 100644 index 0000000000..8d19592b7f --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props2.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Variable: props2 + +> `const` **props2**: `object` + +Defined in: [src/components/AgendaItems/AgendaItemsContainerProps.ts:97](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsContainerProps.ts#L97) + +## Type declaration + +### agendaItemCategories + +> **agendaItemCategories**: `any`[] = `[]` + +### agendaItemConnection + +> **agendaItemConnection**: `"Event"` + +### agendaItemData + +> **agendaItemData**: `any`[] = `[]` + +### agendaItemRefetch + +> **agendaItemRefetch**: `Mock` diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsCreateModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsCreateModal/functions/default.md new file mode 100644 index 0000000000..d70f0e19e5 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsCreateModal/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/AgendaItems/AgendaItemsCreateModal.tsx:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsCreateModal.tsx#L43) + +Component for creating a new agenda item. +Displays a modal form where users can input details for a new agenda item, including title, description, duration, categories, URLs, and attachments. + +## Parameters + +### props + +`InterfaceAgendaItemsCreateModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsDeleteModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsDeleteModal/functions/default.md new file mode 100644 index 0000000000..e023f3fffb --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsDeleteModal/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/AgendaItems/AgendaItemsDeleteModal.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsDeleteModal.tsx#L23) + +Modal component for confirming the deletion of an agenda item. +Displays a confirmation dialog when a user attempts to delete an agenda item. + +## Parameters + +### props + +`InterfaceAgendaItemsDeleteModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsPreviewModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsPreviewModal/functions/default.md new file mode 100644 index 0000000000..be45b5d740 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsPreviewModal/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/AgendaItems/AgendaItemsPreviewModal.tsx:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsPreviewModal.tsx#L41) + +Modal component for previewing details of an agenda item. +Displays the details of the selected agenda item, including its categories, title, description, duration, creator, URLs, and attachments. +Also provides options to update or delete the agenda item. + +## Parameters + +### props + +`InterfaceAgendaItemsPreviewModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsUpdateModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsUpdateModal/functions/default.md new file mode 100644 index 0000000000..9c1630b524 --- /dev/null +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsUpdateModal/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/AgendaItems/AgendaItemsUpdateModal.tsx:49](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/AgendaItems/AgendaItemsUpdateModal.tsx#L49) + +Modal component for updating details of an agenda item. +Provides a form to update the agenda item's title, description, duration, categories, URLs, and attachments. +Also includes functionality to add, remove URLs and attachments. + +## Parameters + +### props + +`InterfaceAgendaItemsUpdateModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/Avatar/Avatar/functions/default.md b/docs/docs/auto-docs/components/Avatar/Avatar/functions/default.md new file mode 100644 index 0000000000..5a9523ce1c --- /dev/null +++ b/docs/docs/auto-docs/components/Avatar/Avatar/functions/default.md @@ -0,0 +1,24 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/Avatar/Avatar.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Avatar/Avatar.tsx#L29) + +A component that generates and displays an avatar based on the provided name. +The avatar is generated using the DiceBear library with the initials style. + +## Parameters + +### \_\_namedParameters + +`InterfaceAvatarProps` + +## Returns + +`Element` + +JSX.Element - The rendered avatar image component. diff --git a/docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md b/docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md new file mode 100644 index 0000000000..5aadd13385 --- /dev/null +++ b/docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx#L29) + +A dropdown component that allows users to change the application's language. +It updates the user's language preference in the backend and stores the selection in cookies. + +## Parameters + +### props + +`InterfaceChangeLanguageDropDownProps` + +The properties for customizing the dropdown component. + +## Returns + +`Element` + +JSX.Element - The rendered dropdown component for changing languages. diff --git a/docs/docs/auto-docs/components/CheckIn/CheckInModal/functions/CheckInModal.md b/docs/docs/auto-docs/components/CheckIn/CheckInModal/functions/CheckInModal.md new file mode 100644 index 0000000000..064fcb55ca --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/CheckInModal/functions/CheckInModal.md @@ -0,0 +1,24 @@ +[Admin Docs](/) + +*** + +# Function: CheckInModal() + +> **CheckInModal**(`__namedParameters`): `Element` + +Defined in: [src/components/CheckIn/CheckInModal.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/CheckInModal.tsx#L26) + +Modal component for managing event check-ins. Displays a list of attendees +and their check-in statuses, allowing for filtering by user name. + +## Parameters + +### \_\_namedParameters + +[`InterfaceModalProp`](../../types/interfaces/InterfaceModalProp.md) + +## Returns + +`Element` + +JSX.Element - The rendered modal component. diff --git a/docs/docs/auto-docs/components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md b/docs/docs/auto-docs/components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md new file mode 100644 index 0000000000..dce3d254ce --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: CheckInWrapper() + +> **CheckInWrapper**(`eventId`): `Element` + +Defined in: [src/components/CheckIn/CheckInWrapper.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/CheckInWrapper.tsx#L17) + +Wrapper component that displays a button to open the CheckInModal. + +## Parameters + +### eventId + +`PropType` + +The ID of the event for which check-in management is being handled. + +## Returns + +`Element` + +JSX.Element - The rendered CheckInWrapper component. diff --git a/docs/docs/auto-docs/components/CheckIn/TableRow/functions/TableRow.md b/docs/docs/auto-docs/components/CheckIn/TableRow/functions/TableRow.md new file mode 100644 index 0000000000..2e7b6b1a47 --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/TableRow/functions/TableRow.md @@ -0,0 +1,30 @@ +[Admin Docs](/) + +*** + +# Function: TableRow() + +> **TableRow**(`__namedParameters`): `Element` + +Defined in: [src/components/CheckIn/TableRow.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/TableRow.tsx#L19) + +Component that represents a single row in the check-in table. +Allows users to mark themselves as checked in and download a tag if they are already checked in. + +## Parameters + +### \_\_namedParameters + +#### data + +[`InterfaceTableCheckIn`](../../types/interfaces/InterfaceTableCheckIn.md) + +#### refetch + +() => `void` + +## Returns + +`Element` + +JSX.Element - The rendered TableRow component. diff --git a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationSuccess.md b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationSuccess.md new file mode 100644 index 0000000000..72452690a9 --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationSuccess.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Variable: checkInMutationSuccess + +> `const` **checkInMutationSuccess**: `object`[] + +Defined in: [src/components/CheckIn/mocks.ts:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/mocks.ts#L46) + +## 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.\_id + +> **\_id**: `string` = `'123'` diff --git a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationUnsuccess.md b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationUnsuccess.md new file mode 100644 index 0000000000..da3a6c13b9 --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationUnsuccess.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: checkInMutationUnsuccess + +> `const` **checkInMutationUnsuccess**: `object`[] + +Defined in: [src/components/CheckIn/mocks.ts:65](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/mocks.ts#L65) + +## 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'` diff --git a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInQueryMock.md b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInQueryMock.md new file mode 100644 index 0000000000..75d233e740 --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInQueryMock.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: checkInQueryMock + +> `const` **checkInQueryMock**: `object`[] + +Defined in: [src/components/CheckIn/mocks.ts:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/mocks.ts#L34) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_CHECKINS` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'event123'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: [`InterfaceAttendeeQueryResponse`](../../types/interfaces/InterfaceAttendeeQueryResponse.md) = `checkInQueryData` diff --git a/docs/docs/auto-docs/components/CheckIn/tagTemplate/variables/tagTemplate.md b/docs/docs/auto-docs/components/CheckIn/tagTemplate/variables/tagTemplate.md new file mode 100644 index 0000000000..65e231f07e --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/tagTemplate/variables/tagTemplate.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: tagTemplate + +> `const` **tagTemplate**: `Template` + +Defined in: [src/components/CheckIn/tagTemplate.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/tagTemplate.ts#L4) diff --git a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeCheckIn.md b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeCheckIn.md new file mode 100644 index 0000000000..cac1d03144 --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeCheckIn.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAttendeeCheckIn + +Defined in: [src/components/CheckIn/types.ts:7](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L7) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/components/CheckIn/types.ts:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L8) + +*** + +### checkIn + +> **checkIn**: `object` + +Defined in: [src/components/CheckIn/types.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L10) + +#### \_id + +> **\_id**: `string` + +#### time + +> **time**: `string` + +*** + +### user + +> **user**: [`InterfaceUser`](InterfaceUser.md) + +Defined in: [src/components/CheckIn/types.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L9) diff --git a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeQueryResponse.md b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeQueryResponse.md new file mode 100644 index 0000000000..cf37ef064c --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeQueryResponse.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAttendeeQueryResponse + +Defined in: [src/components/CheckIn/types.ts:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L16) + +## Properties + +### event + +> **event**: `object` + +Defined in: [src/components/CheckIn/types.ts:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L17) + +#### \_id + +> **\_id**: `string` + +#### attendeesCheckInStatus + +> **attendeesCheckInStatus**: [`InterfaceAttendeeCheckIn`](InterfaceAttendeeCheckIn.md)[] diff --git a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceModalProp.md b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceModalProp.md new file mode 100644 index 0000000000..827d8401ab --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceModalProp.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceModalProp + +Defined in: [src/components/CheckIn/types.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L23) + +## Properties + +### eventId + +> **eventId**: `string` + +Defined in: [src/components/CheckIn/types.ts:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L25) + +*** + +### handleClose() + +> **handleClose**: () => `void` + +Defined in: [src/components/CheckIn/types.ts:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L26) + +#### Returns + +`void` + +*** + +### show + +> **show**: `boolean` + +Defined in: [src/components/CheckIn/types.ts:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L24) diff --git a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableCheckIn.md b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableCheckIn.md new file mode 100644 index 0000000000..104b86046a --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableCheckIn.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceTableCheckIn + +Defined in: [src/components/CheckIn/types.ts:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L29) + +## Properties + +### checkIn + +> **checkIn**: `object` + +Defined in: [src/components/CheckIn/types.ts:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L33) + +#### \_id + +> **\_id**: `string` + +#### time + +> **time**: `string` + +*** + +### eventId + +> **eventId**: `string` + +Defined in: [src/components/CheckIn/types.ts:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L37) + +*** + +### id + +> **id**: `string` + +Defined in: [src/components/CheckIn/types.ts:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L30) + +*** + +### name + +> **name**: `string` + +Defined in: [src/components/CheckIn/types.ts:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L31) + +*** + +### userId + +> **userId**: `string` + +Defined in: [src/components/CheckIn/types.ts:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L32) diff --git a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableData.md b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableData.md new file mode 100644 index 0000000000..9d00ff3203 --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableData.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceTableData + +Defined in: [src/components/CheckIn/types.ts:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L40) + +## Properties + +### checkInData + +> **checkInData**: [`InterfaceTableCheckIn`](InterfaceTableCheckIn.md) + +Defined in: [src/components/CheckIn/types.ts:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L43) + +*** + +### id + +> **id**: `string` + +Defined in: [src/components/CheckIn/types.ts:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L42) + +*** + +### userName + +> **userName**: `string` + +Defined in: [src/components/CheckIn/types.ts:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L41) diff --git a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceUser.md b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceUser.md new file mode 100644 index 0000000000..27322973b1 --- /dev/null +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceUser.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUser + +Defined in: [src/components/CheckIn/types.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L1) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/components/CheckIn/types.ts:2](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L2) + +*** + +### firstName + +> **firstName**: `string` + +Defined in: [src/components/CheckIn/types.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L3) + +*** + +### lastName + +> **lastName**: `string` + +Defined in: [src/components/CheckIn/types.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CheckIn/types.ts#L4) diff --git a/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/functions/default.md b/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/functions/default.md new file mode 100644 index 0000000000..bf2c8a59ec --- /dev/null +++ b/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L24) + +A collapsible dropdown component that toggles visibility of sub-targets. + +## Parameters + +### \_\_namedParameters + +[`InterfaceCollapsibleDropdown`](../interfaces/InterfaceCollapsibleDropdown.md) + +## Returns + +`Element` + +JSX.Element - The rendered CollapsibleDropdown component. diff --git a/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/interfaces/InterfaceCollapsibleDropdown.md b/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/interfaces/InterfaceCollapsibleDropdown.md new file mode 100644 index 0000000000..341a9d24f0 --- /dev/null +++ b/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/interfaces/InterfaceCollapsibleDropdown.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCollapsibleDropdown + +Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L9) + +## Properties + +### setShowDropdown + +> **setShowDropdown**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> + +Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L12) + +*** + +### showDropdown + +> **showDropdown**: `boolean` + +Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L10) + +*** + +### target + +> **target**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md) + +Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L11) diff --git a/docs/docs/auto-docs/components/ContriStats/ContriStats/functions/default.md b/docs/docs/auto-docs/components/ContriStats/ContriStats/functions/default.md new file mode 100644 index 0000000000..bfc596a513 --- /dev/null +++ b/docs/docs/auto-docs/components/ContriStats/ContriStats/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/ContriStats/ContriStats.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/ContriStats/ContriStats.tsx#L22) + +A component that displays contribution statistics. + +## Parameters + +### \_\_namedParameters + +`InterfaceContriStatsProps` + +## Returns + +`JSX.Element` + +JSX.Element - The rendered component displaying the contribution stats. diff --git a/docs/docs/auto-docs/components/CurrentHourIndicator/CurrentHourIndicator/functions/default.md b/docs/docs/auto-docs/components/CurrentHourIndicator/CurrentHourIndicator/functions/default.md new file mode 100644 index 0000000000..4067eac036 --- /dev/null +++ b/docs/docs/auto-docs/components/CurrentHourIndicator/CurrentHourIndicator/functions/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/CurrentHourIndicator/CurrentHourIndicator.tsx:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/CurrentHourIndicator/CurrentHourIndicator.tsx#L9) + +A component that displays an indicator for the current hour. + +## Returns + +`Element` + +JSX.Element - The rendered component showing the current hour indicator. diff --git a/docs/docs/auto-docs/components/DynamicDropDown/DynamicDropDown/functions/default.md b/docs/docs/auto-docs/components/DynamicDropDown/DynamicDropDown/functions/default.md new file mode 100644 index 0000000000..d355e607f9 --- /dev/null +++ b/docs/docs/auto-docs/components/DynamicDropDown/DynamicDropDown/functions/default.md @@ -0,0 +1,30 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**\<`T`\>(`__namedParameters`): `Element` + +Defined in: [src/components/DynamicDropDown/DynamicDropDown.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/DynamicDropDown/DynamicDropDown.tsx#L34) + +A dynamic dropdown component that allows users to select an option. + +This component renders a dropdown with a toggle button. Clicking the button +opens a menu with options. When an option is selected, it updates the form state. + +## Type Parameters + +• **T** *extends* `Record`\<`string`, `unknown`\> + +## Parameters + +### \_\_namedParameters + +`InterfaceChangeDropDownProps`\<`T`\> + +## Returns + +`Element` + +JSX.Element - The rendered dropdown component. diff --git a/docs/docs/auto-docs/components/EditCustomFieldDropDown/EditCustomFieldDropDown/functions/default.md b/docs/docs/auto-docs/components/EditCustomFieldDropDown/EditCustomFieldDropDown/functions/default.md new file mode 100644 index 0000000000..985487ab5a --- /dev/null +++ b/docs/docs/auto-docs/components/EditCustomFieldDropDown/EditCustomFieldDropDown/functions/default.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/EditCustomFieldDropDown/EditCustomFieldDropDown.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EditCustomFieldDropDown/EditCustomFieldDropDown.tsx#L33) + +A dropdown component for editing custom field types. + +This component displays a dropdown menu that allows users to select a custom field type. +It shows the current type of the field and provides a list of available types to choose from. +When a new type is selected, it updates the custom field data. + +## Parameters + +### \_\_namedParameters + +`InterfaceEditCustomFieldDropDownProps` + +## Returns + +`Element` + +JSX.Element - The rendered dropdown component. diff --git a/docs/docs/auto-docs/components/EventCalendar/EventCalendar/functions/default.md b/docs/docs/auto-docs/components/EventCalendar/EventCalendar/functions/default.md new file mode 100644 index 0000000000..2a5fae3850 --- /dev/null +++ b/docs/docs/auto-docs/components/EventCalendar/EventCalendar/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/EventCalendar/EventCalendar.tsx:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventCalendar/EventCalendar.tsx#L58) + +## Parameters + +### props + +`InterfaceCalendarProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/EventCalendar/EventHeader/functions/default.md b/docs/docs/auto-docs/components/EventCalendar/EventHeader/functions/default.md new file mode 100644 index 0000000000..9bc2063c3d --- /dev/null +++ b/docs/docs/auto-docs/components/EventCalendar/EventHeader/functions/default.md @@ -0,0 +1,24 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/EventCalendar/EventHeader.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventCalendar/EventHeader.tsx#L27) + +EventHeader component displays the header for the event calendar. +It includes a search field, view type dropdown, event type dropdown, and a button to create an event. + +## Parameters + +### \_\_namedParameters + +`InterfaceEventHeaderProps` + +## Returns + +`JSX.Element` + +JSX.Element - The rendered EventHeader component. diff --git a/docs/docs/auto-docs/components/EventCalendar/YearlyEventCalender/functions/default.md b/docs/docs/auto-docs/components/EventCalendar/YearlyEventCalender/functions/default.md new file mode 100644 index 0000000000..bf86516f7e --- /dev/null +++ b/docs/docs/auto-docs/components/EventCalendar/YearlyEventCalender/functions/default.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/EventCalendar/YearlyEventCalender.tsx:95](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventCalendar/YearlyEventCalender.tsx#L95) + +Calendar component to display events for a selected year. + +This component renders a yearly calendar with navigation to view previous and next years. +It displays events for each day, with functionality to expand and view details of events. + +## Parameters + +### props + +`InterfaceCalendarProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +JSX.Element - The rendered calendar component. diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/holidays.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/holidays.md new file mode 100644 index 0000000000..e0b967a5bf --- /dev/null +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/holidays.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: holidays + +> `const` **holidays**: `object`[] + +Defined in: [src/components/EventCalendar/constants.js:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventCalendar/constants.js#L1) + +## Type declaration + +### date + +> **date**: `string` = `'05-01'` + +### month + +> **month**: `string` = `'May'` + +### name + +> **name**: `string` = `'May Day / Labour Day'` diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/hours.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/hours.md new file mode 100644 index 0000000000..fe33761385 --- /dev/null +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/hours.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: hours + +> `const` **hours**: `string`[] + +Defined in: [src/components/EventCalendar/constants.js:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventCalendar/constants.js#L31) diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/months.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/months.md new file mode 100644 index 0000000000..7f4d8eda16 --- /dev/null +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/months.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: months + +> `const` **months**: `string`[] + +Defined in: [src/components/EventCalendar/constants.js:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventCalendar/constants.js#L17) diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/weekdays.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/weekdays.md new file mode 100644 index 0000000000..5d0fbb92a1 --- /dev/null +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/weekdays.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: weekdays + +> `const` **weekdays**: `string`[] + +Defined in: [src/components/EventCalendar/constants.js:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventCalendar/constants.js#L16) diff --git a/docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreen/functions/default.md b/docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreen/functions/default.md new file mode 100644 index 0000000000..4f5b4e0273 --- /dev/null +++ b/docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreen/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/EventDashboardScreen/EventDashboardScreen.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventDashboardScreen/EventDashboardScreen.tsx#L21) + +The EventDashboardScreen component is the main dashboard view for event management. +It includes navigation, a sidebar, and a profile dropdown. + +## Returns + +`Element` + +JSX.Element - The rendered EventDashboardScreen component. diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCard/functions/default.md b/docs/docs/auto-docs/components/EventListCard/EventListCard/functions/default.md new file mode 100644 index 0000000000..139e4a92f3 --- /dev/null +++ b/docs/docs/auto-docs/components/EventListCard/EventListCard/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/EventListCard/EventListCard.tsx:45](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L45) + +Component that displays an event card with a modal for event details. + +## Parameters + +### props + +[`InterfaceEventListCardProps`](../interfaces/InterfaceEventListCardProps.md) + +The props for the EventListCard component. + +## Returns + +`JSX.Element` + +The rendered EventListCard component. diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCard/interfaces/InterfaceEventListCardProps.md b/docs/docs/auto-docs/components/EventListCard/EventListCard/interfaces/InterfaceEventListCardProps.md new file mode 100644 index 0000000000..b475450aee --- /dev/null +++ b/docs/docs/auto-docs/components/EventListCard/EventListCard/interfaces/InterfaceEventListCardProps.md @@ -0,0 +1,181 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceEventListCardProps + +Defined in: [src/components/EventListCard/EventListCard.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L11) + +Props for the EventListCard component. + +## Properties + +### allDay + +> **allDay**: `boolean` + +Defined in: [src/components/EventListCard/EventListCard.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L23) + +*** + +### creator? + +> `optional` **creator**: `object` + +Defined in: [src/components/EventListCard/EventListCard.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L32) + +#### \_id + +> **\_id**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### endDate + +> **endDate**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L20) + +*** + +### endTime + +> **endTime**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L22) + +*** + +### eventDescription + +> **eventDescription**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L18) + +*** + +### eventLocation + +> **eventLocation**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L16) + +*** + +### eventName + +> **eventName**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L17) + +*** + +### id + +> **id**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L15) + +*** + +### isPublic + +> **isPublic**: `boolean` + +Defined in: [src/components/EventListCard/EventListCard.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L27) + +*** + +### isRecurringEventException + +> **isRecurringEventException**: `boolean` + +Defined in: [src/components/EventListCard/EventListCard.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L26) + +*** + +### isRegisterable + +> **isRegisterable**: `boolean` + +Defined in: [src/components/EventListCard/EventListCard.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L28) + +*** + +### key + +> **key**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L14) + +*** + +### recurrenceRule + +> **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) + +Defined in: [src/components/EventListCard/EventListCard.tsx:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L25) + +*** + +### recurring + +> **recurring**: `boolean` + +Defined in: [src/components/EventListCard/EventListCard.tsx:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L24) + +*** + +### refetchEvents()? + +> `optional` **refetchEvents**: () => `void` + +Defined in: [src/components/EventListCard/EventListCard.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L12) + +#### Returns + +`void` + +*** + +### registrants? + +> `optional` **registrants**: `object`[] + +Defined in: [src/components/EventListCard/EventListCard.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L29) + +#### \_id + +> **\_id**: `string` + +*** + +### startDate + +> **startDate**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L19) + +*** + +### startTime + +> **startTime**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L21) + +*** + +### userRole? + +> `optional` **userRole**: `string` + +Defined in: [src/components/EventListCard/EventListCard.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCard.tsx#L13) diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..8d103b5bd8 --- /dev/null +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/ERROR_MOCKS.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: `object`[] + +Defined in: [src/components/EventListCard/EventListCardMocks.ts:191](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCardMocks.ts#L191) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `DELETE_EVENT_MUTATION` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'1'` diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/MOCKS.md new file mode 100644 index 0000000000..c119ac80e3 --- /dev/null +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `undefined`; `description`: `undefined`; `endDate`: `undefined`; `endTime`: `undefined`; `eventId`: `undefined`; `frequency`: `undefined`; `id`: `string`; `interval`: `undefined`; `isPublic`: `undefined`; `isRegisterable`: `undefined`; `location`: `undefined`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `undefined`; `recurringEventDeleteType`: `undefined`; `recurringEventUpdateType`: `undefined`; `startDate`: `undefined`; `startTime`: `undefined`; `title`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `undefined`; `removeEvent`: \{ `_id`: `string`; \}; `updateEvent`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `undefined`; `description`: `undefined`; `endDate`: `undefined`; `endTime`: `undefined`; `eventId`: `undefined`; `frequency`: `undefined`; `id`: `string`; `interval`: `undefined`; `isPublic`: `undefined`; `isRegisterable`: `undefined`; `location`: `undefined`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `undefined`; `recurringEventDeleteType`: `string`; `recurringEventUpdateType`: `undefined`; `startDate`: `undefined`; `startTime`: `undefined`; `title`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `undefined`; `removeEvent`: \{ `_id`: `string`; \}; `updateEvent`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `description`: `string`; `endDate`: `string`; `endTime`: `undefined`; `eventId`: `undefined`; `frequency`: `undefined`; `id`: `string`; `interval`: `undefined`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `boolean`; `recurringEventDeleteType`: `undefined`; `recurringEventUpdateType`: `undefined`; `startDate`: `string`; `startTime`: `undefined`; `title`: `string`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `undefined`; `removeEvent`: `undefined`; `updateEvent`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `description`: `string`; `endDate`: `string`; `endTime`: `string`; `eventId`: `undefined`; `frequency`: `undefined`; `id`: `string`; `interval`: `undefined`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `boolean`; `recurringEventDeleteType`: `undefined`; `recurringEventUpdateType`: `undefined`; `startDate`: `string`; `startTime`: `string`; `title`: `string`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `undefined`; `removeEvent`: `undefined`; `updateEvent`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `description`: `string`; `endDate`: `string`; `endTime`: `undefined`; `eventId`: `undefined`; `frequency`: `string`; `id`: `string`; `interval`: `number`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `recurrenceEndDate`: `any`; `recurrenceStartDate`: `string`; `recurring`: `boolean`; `recurringEventDeleteType`: `undefined`; `recurringEventUpdateType`: `string`; `startDate`: `string`; `startTime`: `undefined`; `title`: `string`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `string`[]; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `undefined`; `removeEvent`: `undefined`; `updateEvent`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `description`: `string`; `endDate`: `string`; `endTime`: `undefined`; `eventId`: `undefined`; `frequency`: `string`; `id`: `string`; `interval`: `number`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `recurrenceEndDate`: `string`; `recurrenceStartDate`: `string`; `recurring`: `boolean`; `recurringEventDeleteType`: `undefined`; `recurringEventUpdateType`: `string`; `startDate`: `string`; `startTime`: `undefined`; `title`: `string`; `weekDayOccurenceInMonth`: `number`; `weekDays`: `string`[]; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `undefined`; `removeEvent`: `undefined`; `updateEvent`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `description`: `string`; `endDate`: `string`; `endTime`: `undefined`; `eventId`: `undefined`; `frequency`: `string`; `id`: `string`; `interval`: `number`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `recurrenceEndDate`: `any`; `recurrenceStartDate`: `string`; `recurring`: `boolean`; `recurringEventDeleteType`: `undefined`; `recurringEventUpdateType`: `string`; `startDate`: `string`; `startTime`: `undefined`; `title`: `string`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `undefined`; `removeEvent`: `undefined`; `updateEvent`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `undefined`; `description`: `undefined`; `endDate`: `undefined`; `endTime`: `undefined`; `eventId`: `string`; `frequency`: `undefined`; `id`: `undefined`; `interval`: `undefined`; `isPublic`: `undefined`; `isRegisterable`: `undefined`; `location`: `undefined`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `undefined`; `recurringEventDeleteType`: `undefined`; `recurringEventUpdateType`: `undefined`; `startDate`: `undefined`; `startTime`: `undefined`; `title`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `registerForEvent`: `object`[]; `removeEvent`: `undefined`; `updateEvent`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/EventListCard/EventListCardMocks.ts:7](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCardMocks.ts#L7) diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCardModals/functions/default.md b/docs/docs/auto-docs/components/EventListCard/EventListCardModals/functions/default.md new file mode 100644 index 0000000000..232a6d21a3 --- /dev/null +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardModals/functions/default.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/EventListCard/EventListCardModals.tsx:72](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCardModals.tsx#L72) + +The `EventListCardModals` component displays the modals related to events, such as viewing, +updating, and deleting events. + +## Parameters + +### props + +`InterfaceEventListCardModalProps` + +The properties for the component. + +## Returns + +`JSX.Element` + +A JSX element containing the event modals. diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCardProps/variables/props.md b/docs/docs/auto-docs/components/EventListCard/EventListCardProps/variables/props.md new file mode 100644 index 0000000000..e90301d69b --- /dev/null +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardProps/variables/props.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: props + +> `const` **props**: [`InterfaceEventListCardProps`](../../EventListCard/interfaces/InterfaceEventListCardProps.md)[] + +Defined in: [src/components/EventListCard/EventListCardProps.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventListCard/EventListCardProps.ts#L4) diff --git a/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITHOUT_TIME.md b/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITHOUT_TIME.md new file mode 100644 index 0000000000..2a993303bb --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITHOUT_TIME.md @@ -0,0 +1,99 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_WITHOUT\_TIME + +> `const` **MOCKS\_WITHOUT\_TIME**: `object`[] + +Defined in: [src/components/EventManagement/Dashboard/EventDashboard.mocks.ts:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/Dashboard/EventDashboard.mocks.ts#L34) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_DETAILS` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'event123'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.event + +> **event**: `object` + +#### result.data.event.\_id + +> **\_id**: `string` = `'event123'` + +#### result.data.event.allDay + +> **allDay**: `boolean` = `true` + +#### result.data.event.attendees + +> **attendees**: `object`[] + +#### result.data.event.creator + +> **creator**: `object` + +#### result.data.event.creator.\_id + +> **\_id**: `string` = `'creator1'` + +#### result.data.event.creator.firstName + +> **firstName**: `string` = `'John'` + +#### result.data.event.creator.lastName + +> **lastName**: `string` = `'Doe'` + +#### result.data.event.description + +> **description**: `string` = `'Test Description'` + +#### result.data.event.endDate + +> **endDate**: `string` = `'2024-01-02'` + +#### result.data.event.endTime + +> **endTime**: `any` = `null` + +#### result.data.event.location + +> **location**: `string` = `'India'` + +#### result.data.event.recurring + +> **recurring**: `boolean` = `false` + +#### result.data.event.startDate + +> **startDate**: `string` = `'2024-01-01'` + +#### result.data.event.startTime + +> **startTime**: `any` = `null` + +#### result.data.event.title + +> **title**: `string` = `'Test Event'` diff --git a/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITH_TIME.md b/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITH_TIME.md new file mode 100644 index 0000000000..44476e15e3 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITH_TIME.md @@ -0,0 +1,99 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_WITH\_TIME + +> `const` **MOCKS\_WITH\_TIME**: `object`[] + +Defined in: [src/components/EventManagement/Dashboard/EventDashboard.mocks.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/Dashboard/EventDashboard.mocks.ts#L3) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_DETAILS` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'event123'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.event + +> **event**: `object` + +#### result.data.event.\_id + +> **\_id**: `string` = `'event123'` + +#### result.data.event.allDay + +> **allDay**: `boolean` = `false` + +#### result.data.event.attendees + +> **attendees**: `object`[] + +#### result.data.event.creator + +> **creator**: `object` + +#### result.data.event.creator.\_id + +> **\_id**: `string` = `'creator1'` + +#### result.data.event.creator.firstName + +> **firstName**: `string` = `'John'` + +#### result.data.event.creator.lastName + +> **lastName**: `string` = `'Doe'` + +#### result.data.event.description + +> **description**: `string` = `'Test Description'` + +#### result.data.event.endDate + +> **endDate**: `string` = `'2024-01-02'` + +#### result.data.event.endTime + +> **endTime**: `string` = `'17:00:00'` + +#### result.data.event.location + +> **location**: `string` = `'India'` + +#### result.data.event.recurring + +> **recurring**: `boolean` = `false` + +#### result.data.event.startDate + +> **startDate**: `string` = `'2024-01-01'` + +#### result.data.event.startTime + +> **startTime**: `string` = `'09:00:00'` + +#### result.data.event.title + +> **title**: `string` = `'Test Event'` diff --git a/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard/functions/default.md b/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard/functions/default.md new file mode 100644 index 0000000000..d31188d1a3 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard/functions/default.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/EventManagement/Dashboard/EventDashboard.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/Dashboard/EventDashboard.tsx#L20) + +Component that displays event details. + +## Parameters + +### props + +The props for the EventDashboard component. + +#### eventId + +`string` + +## Returns + +`Element` + +The rendered EventDashboard component. diff --git a/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItems/functions/default.md b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItems/functions/default.md new file mode 100644 index 0000000000..eaeadb8cc3 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItems/functions/default.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItems.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAgendaItems/EventAgendaItems.tsx#L33) + +Component to manage and display agenda items for a specific event. + +## Parameters + +### props + +The component props. + +#### eventId + +`string` + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..23dcd5c802 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `organizationId`: `string`; `relatedEventId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `agendaItemByEvent`: `undefined`; `agendaItemCategoriesByOrganization`: `object`[]; `createAgendaItem`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `organizationId`: `undefined`; `relatedEventId`: `string`; \}; \}; `result`: \{ `data`: \{ `agendaItemByEvent`: `object`[]; `agendaItemCategoriesByOrganization`: `undefined`; `createAgendaItem`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: \{ `attachments`: `any`[]; `categories`: `string`[]; `description`: `string`; `duration`: `string`; `organizationId`: `string`; `relatedEventId`: `string`; `sequence`: `number`; `title`: `string`; `urls`: `any`[]; \}; `organizationId`: `undefined`; `relatedEventId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `agendaItemByEvent`: `undefined`; `agendaItemCategoriesByOrganization`: `undefined`; `createAgendaItem`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts#L6) diff --git a/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS_ERROR_MUTATION.md b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS_ERROR_MUTATION.md new file mode 100644 index 0000000000..4e041a78e4 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS_ERROR_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_MUTATION + +> `const` **MOCKS\_ERROR\_MUTATION**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: \{ `attachments`: `any`[]; `categories`: `string`[]; `description`: `string`; `duration`: `string`; `organizationId`: `string`; `relatedEventId`: `string`; `sequence`: `number`; `title`: `string`; `urls`: `any`[]; \}; `organizationId`: `undefined`; `relatedEventId`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `organizationId`: `undefined`; `relatedEventId`: `string`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `organizationId`: `string`; `relatedEventId`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:97](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts#L97) diff --git a/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS_ERROR_QUERY.md b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS_ERROR_QUERY.md new file mode 100644 index 0000000000..5e38062c32 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS_ERROR_QUERY.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_QUERY + +> `const` **MOCKS\_ERROR\_QUERY**: `any`[] = `[]` + +Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:133](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts#L133) diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/Attendance.mocks/variables/MOCKS.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/Attendance.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..2533ff4170 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/Attendance.mocks/variables/MOCKS.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: `object`[] + +Defined in: [src/components/EventManagement/EventAttendance/Attendance.mocks.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/Attendance.mocks.ts#L3) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_ATTENDEES` + +#### request.variables + +> **variables**: `object` = `{}` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.event + +> **event**: `object` + +#### result.data.event.attendees + +> **attendees**: `object`[] diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/Attendance.mocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/Attendance.mocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..d48c2b8b15 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/Attendance.mocks/variables/MOCKS_ERROR.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: `object`[] + +Defined in: [src/components/EventManagement/EventAttendance/Attendance.mocks.ts:54](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/Attendance.mocks.ts#L54) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_ATTENDEES` + +#### request.variables + +> **variables**: `object` = `{}` diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/AttendedEventList/functions/default.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/AttendedEventList/functions/default.md new file mode 100644 index 0000000000..11241109f2 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/AttendedEventList/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/EventManagement/EventAttendance/AttendedEventList.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/AttendedEventList.tsx#L16) + +Component to display a list of events attended by a member + +## Parameters + +### props + +`InterfaceEventsAttended` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +A table row containing event details with a link to the event diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventAttendance/functions/default.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventAttendance/functions/default.md new file mode 100644 index 0000000000..2e7a31182a --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventAttendance/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/EventManagement/EventAttendance/EventAttendance.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/EventAttendance.tsx#L34) + +Component to manage and display event attendance information +Includes filtering and sorting functionality for attendees + +## Returns + +`JSX.Element` + +JSX element containing the event attendance interface diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventStatistics/functions/AttendanceStatisticsModal.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventStatistics/functions/AttendanceStatisticsModal.md new file mode 100644 index 0000000000..562a301dd5 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventStatistics/functions/AttendanceStatisticsModal.md @@ -0,0 +1,34 @@ +[Admin Docs](/) + +*** + +# Function: AttendanceStatisticsModal() + +> **AttendanceStatisticsModal**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/EventManagement/EventAttendance/EventStatistics.tsx:50](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/EventStatistics.tsx#L50) + +Component to display statistical information about event attendance +Shows metrics like total attendees, filtering options, and attendance trends + +## Parameters + +### props + +[`InterfaceAttendanceStatisticsModalProps`](../../InterfaceEvents/interfaces/InterfaceAttendanceStatisticsModalProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +JSX element with event statistics dashboard diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceAttendanceStatisticsModalProps.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceAttendanceStatisticsModalProps.md new file mode 100644 index 0000000000..598d99c413 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceAttendanceStatisticsModalProps.md @@ -0,0 +1,73 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAttendanceStatisticsModalProps + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L1) + +## Properties + +### handleClose() + +> **handleClose**: () => `void` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L3) + +#### Returns + +`void` + +*** + +### memberData + +> **memberData**: [`InterfaceMember`](InterfaceMember.md)[] + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L9) + +*** + +### show + +> **show**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:2](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L2) + +*** + +### statistics + +> **statistics**: `object` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L4) + +#### attendanceRate + +> **attendanceRate**: `number` + +#### membersAttended + +> **membersAttended**: `number` + +#### totalMembers + +> **totalMembers**: `number` + +*** + +### t() + +> **t**: (`key`) => `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L10) + +#### Parameters + +##### key + +`string` + +#### Returns + +`string` diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceEvent.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceEvent.md new file mode 100644 index 0000000000..b71a7576c5 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceEvent.md @@ -0,0 +1,187 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceEvent + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L35) + +## Properties + +### \_\_typename + +> **\_\_typename**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:66](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L66) + +*** + +### \_id + +> **\_id**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L36) + +*** + +### allDay + +> **allDay**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L44) + +*** + +### attendees + +> **attendees**: `object`[] + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L58) + +#### \_id + +> **\_id**: `string` + +#### birthDate + +> **birthDate**: `string` + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### gender + +> **gender**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### description + +> **description**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L38) + +*** + +### endDate + +> **endDate**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L40) + +*** + +### endTime + +> **endTime**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L43) + +*** + +### isPublic + +> **isPublic**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:56](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L56) + +*** + +### isRecurringEventException + +> **isRecurringEventException**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L55) + +*** + +### isRegisterable + +> **isRegisterable**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:57](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L57) + +*** + +### location + +> **location**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L41) + +*** + +### recurrenceRule + +> **recurrenceRule**: `object` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L46) + +#### count? + +> `optional` **count**: `number` + +#### frequency + +> **frequency**: `string` + +#### interval + +> **interval**: `number` + +#### recurrenceEndDate? + +> `optional` **recurrenceEndDate**: `string` + +#### recurrenceStartDate + +> **recurrenceStartDate**: `string` + +#### weekDayOccurenceInMonth? + +> `optional` **weekDayOccurenceInMonth**: `number` + +#### weekDays + +> **weekDays**: `string`[] + +*** + +### recurring + +> **recurring**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:45](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L45) + +*** + +### startDate + +> **startDate**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L39) + +*** + +### startTime + +> **startTime**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L42) + +*** + +### title + +> **title**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L37) diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceMember.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceMember.md new file mode 100644 index 0000000000..1d6c61337a --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceMember.md @@ -0,0 +1,95 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceMember + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L13) + +## Properties + +### \_\_typename + +> **\_\_typename**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L23) + +*** + +### \_id + +> **\_id**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L24) + +*** + +### birthDate + +> **birthDate**: `Date` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L22) + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L14) + +*** + +### email + +> **email**: `` `${string}@${string}.${string}` `` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L17) + +*** + +### eventsAttended? + +> `optional` **eventsAttended**: `object`[] + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L19) + +#### \_id + +> **\_id**: `string` + +*** + +### firstName + +> **firstName**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L15) + +*** + +### gender + +> **gender**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L18) + +*** + +### lastName + +> **lastName**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L16) + +*** + +### tagsAssignedWith + +> **tagsAssignedWith**: `object` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L25) + +#### edges + +> **edges**: `object`[] diff --git a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceRecurringEvent.md b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceRecurringEvent.md new file mode 100644 index 0000000000..2f359bb5c3 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceRecurringEvent.md @@ -0,0 +1,87 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceRecurringEvent + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:69](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L69) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:70](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L70) + +*** + +### attendees + +> **attendees**: `object`[] + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:76](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L76) + +#### \_id + +> **\_id**: `string` + +#### gender + +> **gender**: `"MALE"` \| `"FEMALE"` \| `"OTHER"` \| `"PREFER_NOT_TO_SAY"` + +*** + +### endDate + +> **endDate**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:73](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L73) + +*** + +### frequency + +> **frequency**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:74](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L74) + +*** + +### interval + +> **interval**: `number` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:75](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L75) + +*** + +### isPublic + +> **isPublic**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:80](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L80) + +*** + +### isRegisterable + +> **isRegisterable**: `boolean` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:81](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L81) + +*** + +### startDate + +> **startDate**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:72](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L72) + +*** + +### title + +> **title**: `string` + +Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:71](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L71) diff --git a/docs/docs/auto-docs/components/EventManagement/EventRegistrant/EventRegistrants/functions/default.md b/docs/docs/auto-docs/components/EventManagement/EventRegistrant/EventRegistrants/functions/default.md new file mode 100644 index 0000000000..df14e22059 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventRegistrant/EventRegistrants/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/EventManagement/EventRegistrant/EventRegistrants.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventRegistrant/EventRegistrants.tsx#L34) + +Component to manage and display event registrant information +Includes adding new registrants and check-in functionality for registrants + +## Returns + +`JSX.Element` + +JSX element containing the event attendance interface diff --git a/docs/docs/auto-docs/components/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCKS.md b/docs/docs/auto-docs/components/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCKS.md new file mode 100644 index 0000000000..e49916ba0f --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: REGISTRANTS\_MOCKS + +> `const` **REGISTRANTS\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `eventId`: `string`; `id`: `undefined`; \}; \}; `result`: \{ `data`: \{ `event`: `undefined`; `getEventAttendeesByEventId`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `eventId`: `undefined`; `id`: `string`; \}; \}; `result`: \{ `data`: \{ `event`: \{ `attendees`: `object`[]; \}; `getEventAttendeesByEventId`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/EventManagement/EventRegistrant/Registrations.mocks.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventRegistrant/Registrations.mocks.ts#L3) diff --git a/docs/docs/auto-docs/components/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCKS_ERROR.md b/docs/docs/auto-docs/components/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCKS_ERROR.md new file mode 100644 index 0000000000..3ca4814c23 --- /dev/null +++ b/docs/docs/auto-docs/components/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCKS_ERROR.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Variable: REGISTRANTS\_MOCKS\_ERROR + +> `const` **REGISTRANTS\_MOCKS\_ERROR**: `object`[] + +Defined in: [src/components/EventManagement/EventRegistrant/Registrations.mocks.ts:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventManagement/EventRegistrant/Registrations.mocks.ts#L58) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_REGISTRANTS` + +#### request.variables + +> **variables**: `object` + +#### request.variables.eventId + +> **eventId**: `string` = `'event123'` diff --git a/docs/docs/auto-docs/components/EventRegistrantsModal/AddOnSpotAttendee/functions/default.md b/docs/docs/auto-docs/components/EventRegistrantsModal/AddOnSpotAttendee/functions/default.md new file mode 100644 index 0000000000..2b0d3c6ac4 --- /dev/null +++ b/docs/docs/auto-docs/components/EventRegistrantsModal/AddOnSpotAttendee/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/EventRegistrantsModal/AddOnSpotAttendee.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventRegistrantsModal/AddOnSpotAttendee.tsx#L21) + +Modal component for adding on-spot attendees to an event + +## Parameters + +### props + +[`InterfaceAddOnSpotAttendeeProps`](../../../../utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +Modal component with form for adding new attendee diff --git a/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsModal/functions/EventRegistrantsModal.md b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsModal/functions/EventRegistrantsModal.md new file mode 100644 index 0000000000..b954afc534 --- /dev/null +++ b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsModal/functions/EventRegistrantsModal.md @@ -0,0 +1,24 @@ +[Admin Docs](/) + +*** + +# Function: EventRegistrantsModal() + +> **EventRegistrantsModal**(`props`): `Element` + +Defined in: [src/components/EventRegistrantsModal/EventRegistrantsModal.tsx:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventRegistrantsModal/EventRegistrantsModal.tsx#L44) + +Modal component for managing event registrants. +Allows adding and removing attendees from an event. + +## Parameters + +### props + +`ModalPropType` + +## Returns + +`Element` + +JSX element representing the modal. diff --git a/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md new file mode 100644 index 0000000000..424e087c60 --- /dev/null +++ b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: EventRegistrantsWrapper() + +> **EventRegistrantsWrapper**(`__namedParameters`): `Element` + +Defined in: [src/components/EventRegistrantsModal/EventRegistrantsWrapper.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventRegistrantsModal/EventRegistrantsWrapper.tsx#L20) + +Wrapper component that displays a button to show the event registrants modal. + +## Parameters + +### \_\_namedParameters + +`PropType` + +## Returns + +`Element` + +JSX element representing the wrapper with a button to show the modal. diff --git a/docs/docs/auto-docs/components/EventStats/EventStats/functions/EventStats.md b/docs/docs/auto-docs/components/EventStats/EventStats/functions/EventStats.md new file mode 100644 index 0000000000..87f75e6b45 --- /dev/null +++ b/docs/docs/auto-docs/components/EventStats/EventStats/functions/EventStats.md @@ -0,0 +1,24 @@ +[Admin Docs](/) + +*** + +# Function: EventStats() + +> **EventStats**(`__namedParameters`): `Element` + +Defined in: [src/components/EventStats/EventStats.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventStats/EventStats.tsx#L27) + +Component that displays event statistics in a modal. +Shows feedback, reviews, and average rating for the event. + +## Parameters + +### \_\_namedParameters + +`ModalPropType` + +## Returns + +`Element` + +JSX element representing the event statistics modal. diff --git a/docs/docs/auto-docs/components/EventStats/EventStatsWrapper/functions/EventStatsWrapper.md b/docs/docs/auto-docs/components/EventStats/EventStatsWrapper/functions/EventStatsWrapper.md new file mode 100644 index 0000000000..82a133235f --- /dev/null +++ b/docs/docs/auto-docs/components/EventStats/EventStatsWrapper/functions/EventStatsWrapper.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: EventStatsWrapper() + +> **EventStatsWrapper**(`eventId`): `Element` + +Defined in: [src/components/EventStats/EventStatsWrapper.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventStats/EventStatsWrapper.tsx#L18) + +Wrapper component that displays a button to show event statistics. + +## Parameters + +### eventId + +`PropType` + +The ID of the event. + +## Returns + +`Element` + +JSX element representing the wrapper with a button to view event statistics. diff --git a/docs/docs/auto-docs/components/EventStats/Statistics/AverageRating/functions/AverageRating.md b/docs/docs/auto-docs/components/EventStats/Statistics/AverageRating/functions/AverageRating.md new file mode 100644 index 0000000000..b595b5db42 --- /dev/null +++ b/docs/docs/auto-docs/components/EventStats/Statistics/AverageRating/functions/AverageRating.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: AverageRating() + +> **AverageRating**(`data`): `Element` + +Defined in: [src/components/EventStats/Statistics/AverageRating.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventStats/Statistics/AverageRating.tsx#L33) + +Component that displays the average rating for an event. +Shows a rating value and a star rating icon. + +## Parameters + +### data + +`ModalPropType` + +Data containing the average feedback score to be displayed. + +## Returns + +`Element` + +JSX element representing the average rating card with a star rating. diff --git a/docs/docs/auto-docs/components/EventStats/Statistics/Feedback/functions/FeedbackStats.md b/docs/docs/auto-docs/components/EventStats/Statistics/Feedback/functions/FeedbackStats.md new file mode 100644 index 0000000000..3b95f4eb09 --- /dev/null +++ b/docs/docs/auto-docs/components/EventStats/Statistics/Feedback/functions/FeedbackStats.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: FeedbackStats() + +> **FeedbackStats**(`data`): `Element` + +Defined in: [src/components/EventStats/Statistics/Feedback.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventStats/Statistics/Feedback.tsx#L34) + +Component that displays a pie chart of feedback ratings for an event. +Shows how many people gave each rating. + +## Parameters + +### data + +`ModalPropType` + +Data containing event feedback to be displayed in the chart. + +## Returns + +`Element` + +JSX element representing the feedback analysis card with a pie chart. diff --git a/docs/docs/auto-docs/components/EventStats/Statistics/Review/functions/ReviewStats.md b/docs/docs/auto-docs/components/EventStats/Statistics/Review/functions/ReviewStats.md new file mode 100644 index 0000000000..963df51b2b --- /dev/null +++ b/docs/docs/auto-docs/components/EventStats/Statistics/Review/functions/ReviewStats.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: ReviewStats() + +> **ReviewStats**(`data`): `Element` + +Defined in: [src/components/EventStats/Statistics/Review.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/EventStats/Statistics/Review.tsx#L30) + +Component that displays reviews for an event. +Shows a list of reviews with ratings and text. + +## Parameters + +### data + +`ModalPropType` + +Data containing event feedback to be displayed. + +## Returns + +`Element` + +JSX element representing the reviews card. diff --git a/docs/docs/auto-docs/components/GroupChatDetails/GroupChatDetails/functions/default.md b/docs/docs/auto-docs/components/GroupChatDetails/GroupChatDetails/functions/default.md new file mode 100644 index 0000000000..6b15b0b87a --- /dev/null +++ b/docs/docs/auto-docs/components/GroupChatDetails/GroupChatDetails/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/GroupChatDetails/GroupChatDetails.tsx:120](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/GroupChatDetails/GroupChatDetails.tsx#L120) + +Component for displaying and managing group chat details. + +## Parameters + +### \_\_namedParameters + +`InterfaceGoroupChatDetailsProps` + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md b/docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md new file mode 100644 index 0000000000..a82ab5084c --- /dev/null +++ b/docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/HolidayCards/HolidayCard.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/HolidayCards/HolidayCard.tsx#L15) + +Component that displays a card with the name of a holiday. + +## Parameters + +### props + +`InterfaceHolidayList` + +Contains the holidayName to be displayed on the card. + +## Returns + +`Element` + +JSX element representing a card with the holiday name. diff --git a/docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md b/docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md new file mode 100644 index 0000000000..d0219f7612 --- /dev/null +++ b/docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/IconComponent/IconComponent.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/IconComponent/IconComponent.tsx#L39) + +Renders an icon based on the provided name. + +## Parameters + +### props + +[`InterfaceIconComponent`](../interfaces/InterfaceIconComponent.md) + +Contains the name of the icon and optional styles (fill, height, width). + +## Returns + +`Element` + +JSX element representing the icon. diff --git a/docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md b/docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md new file mode 100644 index 0000000000..afc97d2384 --- /dev/null +++ b/docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceIconComponent + +Defined in: [src/components/IconComponent/IconComponent.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/IconComponent/IconComponent.tsx#L27) + +## Properties + +### fill? + +> `optional` **fill**: `string` + +Defined in: [src/components/IconComponent/IconComponent.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/IconComponent/IconComponent.tsx#L29) + +*** + +### height? + +> `optional` **height**: `string` + +Defined in: [src/components/IconComponent/IconComponent.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/IconComponent/IconComponent.tsx#L30) + +*** + +### name + +> **name**: `string` + +Defined in: [src/components/IconComponent/IconComponent.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/IconComponent/IconComponent.tsx#L28) + +*** + +### width? + +> `optional` **width**: `string` + +Defined in: [src/components/IconComponent/IconComponent.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/IconComponent/IconComponent.tsx#L31) diff --git a/docs/docs/auto-docs/components/InfiniteScrollLoader/InfiniteScrollLoader/functions/default.md b/docs/docs/auto-docs/components/InfiniteScrollLoader/InfiniteScrollLoader/functions/default.md new file mode 100644 index 0000000000..8d09d65122 --- /dev/null +++ b/docs/docs/auto-docs/components/InfiniteScrollLoader/InfiniteScrollLoader/functions/default.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/InfiniteScrollLoader/InfiniteScrollLoader.tsx:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/InfiniteScrollLoader/InfiniteScrollLoader.tsx#L8) + +A Loader for infinite scroll. + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/functions/default.md b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/functions/default.md new file mode 100644 index 0000000000..d9d18cca13 --- /dev/null +++ b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawer/LeftDrawer.tsx#L24) + +LeftDrawer component for displaying navigation options. + +## Parameters + +### \_\_namedParameters + +[`InterfaceLeftDrawerProps`](../interfaces/InterfaceLeftDrawerProps.md) + +## Returns + +`Element` + +JSX element for the left navigation drawer. diff --git a/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/interfaces/InterfaceLeftDrawerProps.md b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/interfaces/InterfaceLeftDrawerProps.md new file mode 100644 index 0000000000..2d9cb220f3 --- /dev/null +++ b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/interfaces/InterfaceLeftDrawerProps.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceLeftDrawerProps + +Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawer/LeftDrawer.tsx#L12) + +## Properties + +### hideDrawer + +> **hideDrawer**: `boolean` + +Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawer/LeftDrawer.tsx#L13) + +*** + +### setHideDrawer + +> **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> + +Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawer/LeftDrawer.tsx#L14) diff --git a/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md new file mode 100644 index 0000000000..2e4ca32bd7 --- /dev/null +++ b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L35) + +LeftDrawerOrg component for displaying organization details and navigation options. + +## Parameters + +### \_\_namedParameters + +[`InterfaceLeftDrawerProps`](../interfaces/InterfaceLeftDrawerProps.md) + +## Returns + +`Element` + +JSX element for the left navigation drawer with organization details. diff --git a/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md new file mode 100644 index 0000000000..6bc19e51dc --- /dev/null +++ b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceLeftDrawerProps + +Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L18) + +## Properties + +### hideDrawer + +> **hideDrawer**: `boolean` + +Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L21) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L19) + +*** + +### setHideDrawer + +> **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> + +Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L22) + +*** + +### targets + +> **targets**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md)[] + +Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L20) diff --git a/docs/docs/auto-docs/components/Loader/Loader/functions/default.md b/docs/docs/auto-docs/components/Loader/Loader/functions/default.md new file mode 100644 index 0000000000..2403a47f44 --- /dev/null +++ b/docs/docs/auto-docs/components/Loader/Loader/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/Loader/Loader.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Loader/Loader.tsx#L17) + +Loader component for displaying a loading spinner. + +## Parameters + +### props + +`InterfaceLoaderProps` + +## Returns + +`Element` + +JSX element for a loading spinner. diff --git a/docs/docs/auto-docs/components/LoginPortalToggle/LoginPortalToggle/functions/default.md b/docs/docs/auto-docs/components/LoginPortalToggle/LoginPortalToggle/functions/default.md new file mode 100644 index 0000000000..20b9b1f727 --- /dev/null +++ b/docs/docs/auto-docs/components/LoginPortalToggle/LoginPortalToggle/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`onToggle`): `JSX.Element` + +Defined in: [src/components/LoginPortalToggle/LoginPortalToggle.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/LoginPortalToggle/LoginPortalToggle.tsx#L18) + +Component for toggling between admin and user login portals. + +## Parameters + +### onToggle + +`InterfaceLoginPortalToggleProps` + +Callback function to handle role changes ('admin' or 'user'). + +## Returns + +`JSX.Element` + +JSX element for login portal toggle. diff --git a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedByMember/functions/default.md b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedByMember/functions/default.md new file mode 100644 index 0000000000..7248555d10 --- /dev/null +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedByMember/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/MemberDetail/EventsAttendedByMember.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedByMember.tsx#L15) + +## Parameters + +### \_\_namedParameters + +`InterfaceEventsAttendedByMember` + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/functions/default.md b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/functions/default.md new file mode 100644 index 0000000000..1c5f70649d --- /dev/null +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L26) + +## Parameters + +### props + +[`InterfaceCardItem`](../interfaces/InterfaceCardItem.md) + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/interfaces/InterfaceCardItem.md b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/interfaces/InterfaceCardItem.md new file mode 100644 index 0000000000..238dc3b102 --- /dev/null +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/interfaces/InterfaceCardItem.md @@ -0,0 +1,86 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCardItem + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L16) + +Card component to display individual event attendance information +Shows event details including title, date, location and organization + +## Param + +Organization ID + +## Param + +Event ID + +## Param + +Event start date + +## Param + +Event title + +## Param + +Event location + +## Properties + +### creator? + +> `optional` **creator**: `string` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L20) + +*** + +### eventId? + +> `optional` **eventId**: `string` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L22) + +*** + +### location? + +> `optional` **location**: `string` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L21) + +*** + +### orgId? + +> `optional` **orgId**: `string` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L23) + +*** + +### startdate? + +> `optional` **startdate**: `string` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L19) + +*** + +### time? + +> `optional` **time**: `string` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L18) + +*** + +### title + +> **title**: `string` + +Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedCardItem.tsx#L17) diff --git a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedMemberModal/functions/default.md b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedMemberModal/functions/default.md new file mode 100644 index 0000000000..078414fe7f --- /dev/null +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedMemberModal/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/MemberDetail/EventsAttendedMemberModal.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/EventsAttendedMemberModal.tsx#L39) + +## Parameters + +### props + +`InterfaceEventsAttendedMemberModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/MemberDetail/customTableCell/functions/CustomTableCell.md b/docs/docs/auto-docs/components/MemberDetail/customTableCell/functions/CustomTableCell.md new file mode 100644 index 0000000000..27c86eaf97 --- /dev/null +++ b/docs/docs/auto-docs/components/MemberDetail/customTableCell/functions/CustomTableCell.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: CustomTableCell() + +> **CustomTableCell**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/MemberDetail/customTableCell.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberDetail/customTableCell.tsx#L13) + +Custom table cell component to display event details + +## Parameters + +### props + +#### eventId + +`string` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +TableRow component with event information diff --git a/docs/docs/auto-docs/components/MemberRequestCard/MemberRequestCard/functions/default.md b/docs/docs/auto-docs/components/MemberRequestCard/MemberRequestCard/functions/default.md new file mode 100644 index 0000000000..19c7b37b64 --- /dev/null +++ b/docs/docs/auto-docs/components/MemberRequestCard/MemberRequestCard/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/MemberRequestCard/MemberRequestCard.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/MemberRequestCard/MemberRequestCard.tsx#L31) + +Component for displaying and managing member requests. + +## Parameters + +### props + +`InterfaceMemberRequestCardProps` + +Properties for the member request card. + +## Returns + +`JSX.Element` + +JSX element for member request card. diff --git a/docs/docs/auto-docs/components/NotFound/NotFound/functions/default.md b/docs/docs/auto-docs/components/NotFound/NotFound/functions/default.md new file mode 100644 index 0000000000..f5f541a2a1 --- /dev/null +++ b/docs/docs/auto-docs/components/NotFound/NotFound/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/NotFound/NotFound.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/NotFound/NotFound.tsx#L18) + +Component to display a "Not Found" message. + +## Parameters + +### props + +`InterfaceNotFoundProps` + +## Returns + +`JSX.Element` + +JSX element for the "Not Found" page. diff --git a/docs/docs/auto-docs/components/OrgAdminListCard/OrgAdminListCard/functions/default.md b/docs/docs/auto-docs/components/OrgAdminListCard/OrgAdminListCard/functions/default.md new file mode 100644 index 0000000000..db74ae6aeb --- /dev/null +++ b/docs/docs/auto-docs/components/OrgAdminListCard/OrgAdminListCard/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrgAdminListCard/OrgAdminListCard.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgAdminListCard/OrgAdminListCard.tsx#L22) + +Component to confirm and handle the removal of an admin. + +## Parameters + +### props + +`InterfaceOrgPeopleListCardProps` + +## Returns + +`JSX.Element` + +JSX element for the removal confirmation modal. diff --git a/docs/docs/auto-docs/components/OrgContriCards/OrgContriCards/functions/default.md b/docs/docs/auto-docs/components/OrgContriCards/OrgContriCards/functions/default.md new file mode 100644 index 0000000000..7a74cc0fb1 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgContriCards/OrgContriCards/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrgContriCards/OrgContriCards.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgContriCards/OrgContriCards.tsx#L30) + +Component to display organization contribution cards + +This component shows the contribution details of a user in a card format. It includes +the user's name, email, contribution date, transaction ID, and the contribution amount. + +## Parameters + +### props + +`InterfaceOrgContriCardsProps` + +The properties passed to the component + +## Returns + +`JSX.Element` + +JSX.Element representing a contribution card diff --git a/docs/docs/auto-docs/components/OrgDelete/OrgDelete/functions/default.md b/docs/docs/auto-docs/components/OrgDelete/OrgDelete/functions/default.md new file mode 100644 index 0000000000..d7ba9047d0 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgDelete/OrgDelete/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/OrgDelete/OrgDelete.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgDelete/OrgDelete.tsx#L11) + +Component for displaying organization deletion message + +This component renders a message related to deleting an organization. + +## Returns + +`JSX.Element` + +JSX.Element representing the organization deletion message diff --git a/docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md new file mode 100644 index 0000000000..67b55d5aef --- /dev/null +++ b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrgListCard/OrgListCard.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgListCard/OrgListCard.tsx#L38) + +Component for displaying a list card for an organization + +This component renders a card that displays information about an organization, +including its name, address, members, and admins. It also provides a button +to manage the organization, navigating to the organization's dashboard. + +## Parameters + +### props + +[`InterfaceOrgListCardProps`](../interfaces/InterfaceOrgListCardProps.md) + +The properties passed to the component + +## Returns + +`JSX.Element` + +JSX.Element representing an organization list card diff --git a/docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardProps.md b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardProps.md new file mode 100644 index 0000000000..46f198b631 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardProps.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceOrgListCardProps + +Defined in: [src/components/OrgListCard/OrgListCard.tsx:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgListCard/OrgListCard.tsx#L24) + +Props for the OrgListCard component + +## Properties + +### data + +> **data**: [`InterfaceOrgConnectionInfoType`](../../../../utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md) + +Defined in: [src/components/OrgListCard/OrgListCard.tsx:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgListCard/OrgListCard.tsx#L25) diff --git a/docs/docs/auto-docs/components/OrgListCard/TruncatedText/functions/default.md b/docs/docs/auto-docs/components/OrgListCard/TruncatedText/functions/default.md new file mode 100644 index 0000000000..f310418b06 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgListCard/TruncatedText/functions/default.md @@ -0,0 +1,45 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgListCard/TruncatedText.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgListCard/TruncatedText.tsx#L31) + +A React functional component that displays text and truncates it with an ellipsis (`...`) +if the text exceeds the available width or the `maxWidthOverride` value. + +The component adjusts the truncation dynamically based on the available space +or the `maxWidthOverride` value. It also listens for window resize events to reapply truncation. + +## Parameters + +### props + +`InterfaceTruncatedTextProps` + +The props for the component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +A heading element (`
`) containing the truncated or full text. + +## Example + +```tsx + +``` diff --git a/docs/docs/auto-docs/components/OrgListCard/useDebounce/functions/default.md b/docs/docs/auto-docs/components/OrgListCard/useDebounce/functions/default.md new file mode 100644 index 0000000000..2640d6ed2a --- /dev/null +++ b/docs/docs/auto-docs/components/OrgListCard/useDebounce/functions/default.md @@ -0,0 +1,59 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**\<`T`\>(`callback`, `delay`): `object` + +Defined in: [src/components/OrgListCard/useDebounce.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgListCard/useDebounce.tsx#L12) + +A custom React hook for debouncing a callback function. +It delays the execution of the callback until after a specified delay has elapsed +since the last time the debounced function was invoked. + +## Type Parameters + +• **T** *extends* (...`args`) => `void` + +## Parameters + +### callback + +`T` + +The function to debounce. + +### delay + +`number` + +The delay in milliseconds to wait before invoking the callback. + +## Returns + +`object` + +An object with the `debouncedCallback` function and a `cancel` method to clear the timeout. + +### cancel() + +> **cancel**: () => `void` + +#### Returns + +`void` + +### debouncedCallback() + +> **debouncedCallback**: (...`args`) => `void` + +#### Parameters + +##### args + +...`Parameters`\<`T`\> + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/components/OrgPeopleListCard/OrgPeopleListCard/functions/default.md b/docs/docs/auto-docs/components/OrgPeopleListCard/OrgPeopleListCard/functions/default.md new file mode 100644 index 0000000000..5769026850 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgPeopleListCard/OrgPeopleListCard/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrgPeopleListCard/OrgPeopleListCard.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgPeopleListCard/OrgPeopleListCard.tsx#L30) + +Component for displaying a modal to remove a member from an organization + +This component shows a modal that confirms the removal of a member from the organization. +It performs the removal action and displays success or error messages. + +## Parameters + +### props + +`InterfaceOrgPeopleListCardProps` + +The properties passed to the component + +## Returns + +`JSX.Element` + +JSX.Element representing the organization people list card modal diff --git a/docs/docs/auto-docs/components/OrgPostCard/DeletePostModal/functions/default.md b/docs/docs/auto-docs/components/OrgPostCard/DeletePostModal/functions/default.md new file mode 100644 index 0000000000..7ce8693740 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgPostCard/DeletePostModal/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgPostCard/DeletePostModal.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgPostCard/DeletePostModal.tsx#L21) + +## Parameters + +### props + +`InterfaceDeletePostModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/OrgPostCard/OrgPostCard/functions/default.md b/docs/docs/auto-docs/components/OrgPostCard/OrgPostCard/functions/default.md new file mode 100644 index 0000000000..3bcb5e2a31 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgPostCard/OrgPostCard/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrgPostCard/OrgPostCard.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgPostCard/OrgPostCard.tsx#L29) + +## Parameters + +### props + +`InterfaceOrgPostCardProps` + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/CategoryModal/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/CategoryModal/functions/default.md new file mode 100644 index 0000000000..099db25a44 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/CategoryModal/functions/default.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L41) + +A modal component for creating and editing action item categories. + +## Parameters + +### props + +[`InterfaceActionItemCategoryModal`](../interfaces/InterfaceActionItemCategoryModal.md) + +The properties passed to the component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The `CategoryModal` component. diff --git a/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/CategoryModal/interfaces/InterfaceActionItemCategoryModal.md b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/CategoryModal/interfaces/InterfaceActionItemCategoryModal.md new file mode 100644 index 0000000000..ddc70052d3 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/CategoryModal/interfaces/InterfaceActionItemCategoryModal.md @@ -0,0 +1,72 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceActionItemCategoryModal + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L26) + +Props for the `CategoryModal` component. + +isOpen - The state of the modal. +hide - The function to hide the modal. +refetchCategories - The function to refetch the categories. +orgId - The organization ID. +category - The category to be edited. +mode - The mode of the modal. + +## Properties + +### category + +> **category**: [`InterfaceActionItemCategoryInfo`](../../../../../utils/interfaces/interfaces/InterfaceActionItemCategoryInfo.md) + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L31) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L28) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L27) + +*** + +### mode + +> **mode**: `"create"` \| `"edit"` + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L32) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L30) + +*** + +### refetchCategories() + +> **refetchCategories**: () => `void` + +Defined in: [src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/CategoryModal.tsx#L29) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategories/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategories/functions/default.md new file mode 100644 index 0000000000..6347d08898 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategories/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/ActionItemCategories/OrgActionItemCategories.tsx:61](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/OrgActionItemCategories.tsx#L61) + +Represents the component for managing organization action item categories. +This component allows creating, updating, enabling, and disabling action item categories. + +## Parameters + +### props + +`InterfaceActionItemCategoryProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS.md new file mode 100644 index 0000000000..fb4ed06705 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `isDisabled`: `undefined`; `name`: `undefined`; `orderBy`: `string`; `organizationId`: `string`; `where`: \{ `is_disabled`: `undefined`; `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `object`[]; `createActionItemCategory`: `undefined`; `updateActionItemCategory`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `isDisabled`: `undefined`; `name`: `undefined`; `orderBy`: `string`; `organizationId`: `string`; `where`: \{ `is_disabled`: `boolean`; `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `object`[]; `createActionItemCategory`: `undefined`; `updateActionItemCategory`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `isDisabled`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `undefined`; `createActionItemCategory`: \{ `_id`: `string`; \}; `updateActionItemCategory`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `string`; `isDisabled`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `undefined`; `createActionItemCategory`: `undefined`; `updateActionItemCategory`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts#L8) diff --git a/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_EMPTY.md b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_EMPTY.md new file mode 100644 index 0000000000..cc2093b1ec --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_EMPTY.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_EMPTY + +> `const` **MOCKS\_EMPTY**: `object`[] + +Defined in: [src/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts:236](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts#L236) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `ACTION_ITEM_CATEGORY_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orderBy + +> **orderBy**: `string` = `'createdAt_DESC'` + +#### request.variables.organizationId + +> **organizationId**: `string` = `'orgId'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.name\_contains + +> **name\_contains**: `string` = `''` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.actionItemCategoriesByOrganization + +> **actionItemCategoriesByOrganization**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..7c703c1a16 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `isDisabled`: `undefined`; `name`: `undefined`; `orderBy`: `string`; `organizationId`: `string`; `where`: \{ `name_contains`: `string`; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `isDisabled`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `string`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `string`; `isDisabled`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `undefined`; `where`: `undefined`; \}; \}; \})[] + +Defined in: [src/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts:254](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts#L254) diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryCreateModal/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryCreateModal/functions/default.md new file mode 100644 index 0000000000..1fface49ea --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryCreateModal/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/AgendaItemCategories/AgendaCategoryCreateModal.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/AgendaCategoryCreateModal.tsx#L38) + +AgendaCategoryCreateModal component is used to create the agenda category details like name, description + +## Parameters + +### props + +`InterfaceAgendaCategoryCreateModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +returns the AgendaCategoryCreateModal component diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryDeleteModal/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryDeleteModal/functions/default.md new file mode 100644 index 0000000000..ebba674cc6 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryDeleteModal/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/AgendaItemCategories/AgendaCategoryDeleteModal.tsx:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/AgendaCategoryDeleteModal.tsx#L25) + +AgendaCategoryDeleteModal component is used to delete the agenda category + +## Parameters + +### props + +`InterfaceAgendaCategoryDeleteModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +returns the AgendaCategoryDeleteModal component diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryPreviewModal/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryPreviewModal/functions/default.md new file mode 100644 index 0000000000..59f1529e97 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryPreviewModal/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/AgendaItemCategories/AgendaCategoryPreviewModal.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/AgendaCategoryPreviewModal.tsx#L38) + +AgendaCategoryPreviewModal component is used to preview the agenda category details like name, description, createdBy + +## Parameters + +### props + +`InterfaceAgendaCategoryPreviewModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +returns the AgendaCategoryPreviewModal component diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryUpdateModal/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryUpdateModal/functions/default.md new file mode 100644 index 0000000000..ed50ec069f --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/AgendaCategoryUpdateModal/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/AgendaItemCategories/AgendaCategoryUpdateModal.tsx:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/AgendaCategoryUpdateModal.tsx#L40) + +AgendaCategoryUpdateModal component is used to update the agenda category details like name, description + +## Parameters + +### props + +`InterfaceAgendaCategoryUpdateModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +returns the AgendaCategoryUpdateModal component diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory/functions/default.md new file mode 100644 index 0000000000..2c2c4ce65a --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory/functions/default.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategory.tsx#L31) + +Component for managing and displaying agenda item categories within an organization. + +This component allows users to view, create, and manage agenda item categories. It includes functionality for displaying categories, handling creation, and managing modal visibility. + +## Parameters + +### props + +`InterfaceAgendaCategoryProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered component. diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks/variables/MOCKS_ERROR_AGENDA_ITEM_CATEGORY_LIST_QUERY.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks/variables/MOCKS_ERROR_AGENDA_ITEM_CATEGORY_LIST_QUERY.md new file mode 100644 index 0000000000..9bfcad4061 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks/variables/MOCKS_ERROR_AGENDA_ITEM_CATEGORY_LIST_QUERY.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_AGENDA\_ITEM\_CATEGORY\_LIST\_QUERY + +> `const` **MOCKS\_ERROR\_AGENDA\_ITEM\_CATEGORY\_LIST\_QUERY**: `object`[] + +Defined in: [src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks.ts#L5) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `AGENDA_ITEM_CATEGORY_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.organizationId + +> **organizationId**: `string` = `'123'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.name\_contains + +> **name\_contains**: `string` = `''` diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks/variables/MOCKS_ERROR_MUTATION.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks/variables/MOCKS_ERROR_MUTATION.md new file mode 100644 index 0000000000..5939c3c6d4 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks/variables/MOCKS_ERROR_MUTATION.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_MUTATION + +> `const` **MOCKS\_ERROR\_MUTATION**: (\{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `organizationId`: `string`; `where`: \{ `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `agendaItemCategoriesByOrganization`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: \{ `description`: `string`; `name`: `string`; `organizationId`: `string`; \}; `organizationId`: `undefined`; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks.ts:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryErrorMocks.ts#L20) diff --git a/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryMocks/variables/MOCKS.md new file mode 100644 index 0000000000..eb8b391e2f --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: `undefined`; `organizationId`: `string`; `where`: \{ `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `agendaItemCategoriesByOrganization`: `object`[]; `createAgendaCategory`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `input`: \{ `description`: `string`; `name`: `string`; `organizationId`: `string`; \}; `organizationId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `agendaItemCategoriesByOrganization`: `undefined`; `createAgendaCategory`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryMocks.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/AgendaItemCategories/OrganizationAgendaCategoryMocks.ts#L5) diff --git a/docs/docs/auto-docs/components/OrgSettings/General/DeleteOrg/DeleteOrg/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/General/DeleteOrg/DeleteOrg/functions/default.md new file mode 100644 index 0000000000..91cf704942 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/General/DeleteOrg/DeleteOrg/functions/default.md @@ -0,0 +1,22 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/OrgSettings/General/DeleteOrg/DeleteOrg.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/General/DeleteOrg/DeleteOrg.tsx#L26) + +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 + +`JSX.Element` + +JSX.Element - The rendered component with delete functionality. diff --git a/docs/docs/auto-docs/components/OrgSettings/General/GeneralSettings/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/General/GeneralSettings/functions/default.md new file mode 100644 index 0000000000..7b2dc164e4 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/General/GeneralSettings/functions/default.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/OrgSettings/General/GeneralSettings.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/General/GeneralSettings.tsx#L23) + +A component for displaying general settings for an organization. + +## Parameters + +### props + +`InterfaceGeneralSettingsProps` + +The properties passed to the component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The `GeneralSettings` component. diff --git a/docs/docs/auto-docs/components/OrgSettings/General/OrgProfileFieldSettings/OrgProfileFieldSettings/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/General/OrgProfileFieldSettings/OrgProfileFieldSettings/functions/default.md new file mode 100644 index 0000000000..315eb605b3 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/General/OrgProfileFieldSettings/OrgProfileFieldSettings/functions/default.md @@ -0,0 +1,20 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/OrgSettings/General/OrgProfileFieldSettings/OrgProfileFieldSettings.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/General/OrgProfileFieldSettings/OrgProfileFieldSettings.tsx#L26) + +Component for managing organization profile field settings + +This component allows adding and removing custom fields for an organization. +It displays existing custom fields and provides a form to add new fields. + +## Returns + +`Element` + +JSX.Element representing the organization profile field settings diff --git a/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdate/functions/default.md b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdate/functions/default.md new file mode 100644 index 0000000000..25fea9b00e --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdate/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrgSettings/General/OrgUpdate/OrgUpdate.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/General/OrgUpdate/OrgUpdate.tsx#L36) + +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` + +Component props containing the organization ID. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS.md new file mode 100644 index 0000000000..3847cb1e03 --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `address`: `undefined`; `description`: `undefined`; `id`: `string`; `image`: `undefined`; `name`: `undefined`; `userRegistrationRequired`: `undefined`; `visibleInSearch`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; `updateOrganization`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `address`: \{ `city`: `string`; `countryCode`: `string`; `dependentLocality`: `string`; `line1`: `string`; `line2`: `string`; `postalCode`: `string`; `sortingCode`: `string`; `state`: `string`; \}; `description`: `string`; `id`: `string`; `image`: `File`; `name`: `string`; `userRegistrationRequired`: `boolean`; `visibleInSearch`: `boolean`; \}; \}; `result`: \{ `data`: \{ `organizations`: `undefined`; `updateOrganization`: \{ `_id`: `string`; `address`: \{ `city`: `string`; `countryCode`: `string`; `dependentLocality`: `string`; `line1`: `string`; `line2`: `string`; `postalCode`: `string`; `sortingCode`: `string`; `state`: `string`; \}; `description`: `string`; `name`: `string`; `userRegistrationRequired`: `boolean`; `visibleInSearch`: `boolean`; \}; \}; \}; \})[] + +Defined in: [src/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L4) diff --git a/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_ERROR_ORGLIST.md b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_ERROR_ORGLIST.md new file mode 100644 index 0000000000..82793237dd --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_ERROR_ORGLIST.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_ORGLIST + +> `const` **MOCKS\_ERROR\_ORGLIST**: `object`[] + +Defined in: [src/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:110](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L110) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `ORGANIZATIONS_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'123'` diff --git a/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_ERROR_UPDATE_ORGLIST.md b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_ERROR_UPDATE_ORGLIST.md new file mode 100644 index 0000000000..689c9ad3ef --- /dev/null +++ b/docs/docs/auto-docs/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_ERROR_UPDATE_ORGLIST.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_UPDATE\_ORGLIST + +> `const` **MOCKS\_ERROR\_UPDATE\_ORGLIST**: (\{ `erorr`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `address`: `undefined`; `description`: `undefined`; `id`: `string`; `image`: `undefined`; `name`: `undefined`; `userRegistrationRequired`: `undefined`; `visibleInSearch`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `erorr`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `address`: \{ `city`: `string`; `countryCode`: `string`; `dependentLocality`: `string`; `line1`: `string`; `line2`: `string`; `postalCode`: `string`; `sortingCode`: `string`; `state`: `string`; \}; `description`: `string`; `id`: `string`; `image`: `File`; `name`: `string`; `userRegistrationRequired`: `boolean`; `visibleInSearch`: `boolean`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:120](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L120) diff --git a/docs/docs/auto-docs/components/OrganizationCard/OrganizationCard/functions/default.md b/docs/docs/auto-docs/components/OrganizationCard/OrganizationCard/functions/default.md new file mode 100644 index 0000000000..f09658c9c6 --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationCard/OrganizationCard/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrganizationCard/OrganizationCard.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationCard/OrganizationCard.tsx#L18) + +Component to display an organization's card with its image and owner details. + +## Parameters + +### props + +`InterfaceOrganizationCardProps` + +Properties for the organization card. + +## Returns + +`JSX.Element` + +JSX element representing the organization card. diff --git a/docs/docs/auto-docs/components/OrganizationCardStart/OrganizationCardStart/functions/default.md b/docs/docs/auto-docs/components/OrganizationCardStart/OrganizationCardStart/functions/default.md new file mode 100644 index 0000000000..3d37fee8b8 --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationCardStart/OrganizationCardStart/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/OrganizationCardStart/OrganizationCardStart.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationCardStart/OrganizationCardStart.tsx#L18) + +Component to display a simplified card for an organization. + +## Parameters + +### props + +`InterfaceOrganizationCardStartProps` + +## Returns + +`JSX.Element` + +JSX element representing the organization card. diff --git a/docs/docs/auto-docs/components/OrganizationDashCards/CardItem/functions/default.md b/docs/docs/auto-docs/components/OrganizationDashCards/CardItem/functions/default.md new file mode 100644 index 0000000000..82e56a2556 --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationDashCards/CardItem/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L35) + +Component to display a card item with various types such as Event, Post, or MembershipRequest. + +## Parameters + +### props + +[`InterfaceCardItem`](../interfaces/InterfaceCardItem.md) + +Props for the CardItem component. + +## Returns + +`Element` + +JSX element representing the card item. diff --git a/docs/docs/auto-docs/components/OrganizationDashCards/CardItem/interfaces/InterfaceCardItem.md b/docs/docs/auto-docs/components/OrganizationDashCards/CardItem/interfaces/InterfaceCardItem.md new file mode 100644 index 0000000000..a24cc93cb6 --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationDashCards/CardItem/interfaces/InterfaceCardItem.md @@ -0,0 +1,81 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCardItem + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L14) + +Interface for the CardItem component's props. + +## Properties + +### creator? + +> `optional` **creator**: `object` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L20) + +#### \_id + +> **\_id**: `string` + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### enddate? + +> `optional` **enddate**: `string` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L19) + +*** + +### location? + +> `optional` **location**: `string` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L26) + +*** + +### startdate? + +> `optional` **startdate**: `string` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L18) + +*** + +### time? + +> `optional` **time**: `string` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L17) + +*** + +### title + +> **title**: `string` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L16) + +*** + +### type + +> **type**: `"Event"` \| `"Post"` \| `"MembershipRequest"` + +Defined in: [src/components/OrganizationDashCards/CardItem.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItem.tsx#L15) diff --git a/docs/docs/auto-docs/components/OrganizationDashCards/CardItemLoading/functions/default.md b/docs/docs/auto-docs/components/OrganizationDashCards/CardItemLoading/functions/default.md new file mode 100644 index 0000000000..00014bec8b --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationDashCards/CardItemLoading/functions/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/OrganizationDashCards/CardItemLoading.tsx:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/CardItemLoading.tsx#L8) + +CardItemLoading component is a loading state for the card item. It is used when the data is being fetched. + +## Returns + +`Element` + +JSX.Element diff --git a/docs/docs/auto-docs/components/OrganizationDashCards/DashboardCard/functions/default.md b/docs/docs/auto-docs/components/OrganizationDashCards/DashboardCard/functions/default.md new file mode 100644 index 0000000000..29e2a75824 --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationDashCards/DashboardCard/functions/default.md @@ -0,0 +1,33 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/OrganizationDashCards/DashboardCard.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/DashboardCard.tsx#L13) + +Dashboard card component is used to display the card with icon, title and count. + +## Parameters + +### props + +#### count + +`number` + +#### icon + +`ReactNode` + +#### title + +`string` + +## Returns + +`Element` + +Dashboard card component diff --git a/docs/docs/auto-docs/components/OrganizationDashCards/DashboardCardLoading/functions/default.md b/docs/docs/auto-docs/components/OrganizationDashCards/DashboardCardLoading/functions/default.md new file mode 100644 index 0000000000..df4634d5ce --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationDashCards/DashboardCardLoading/functions/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/OrganizationDashCards/DashboardCardLoading.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationDashCards/DashboardCardLoading.tsx#L10) + +Dashboard card loading component is a loading state for the dashboard card. It is used when the data is being fetched. + +## Returns + +`Element` + +JSX.Element diff --git a/docs/docs/auto-docs/components/OrganizationScreen/OrganizationScreen/functions/default.md b/docs/docs/auto-docs/components/OrganizationScreen/OrganizationScreen/functions/default.md new file mode 100644 index 0000000000..bec909a82b --- /dev/null +++ b/docs/docs/auto-docs/components/OrganizationScreen/OrganizationScreen/functions/default.md @@ -0,0 +1,22 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/OrganizationScreen/OrganizationScreen.tsx:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/OrganizationScreen/OrganizationScreen.tsx#L37) + +Component for the organization screen + +This component displays the organization screen and handles the layout +including a side drawer, header, and main content area. It adjusts +the layout based on the screen size and shows the appropriate content +based on the route. + +## Returns + +`Element` + +JSX.Element representing the organization screen diff --git a/docs/docs/auto-docs/components/Pagination/Pagination/functions/default.md b/docs/docs/auto-docs/components/Pagination/Pagination/functions/default.md new file mode 100644 index 0000000000..771e5f5c88 --- /dev/null +++ b/docs/docs/auto-docs/components/Pagination/Pagination/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/Pagination/Pagination.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Pagination/Pagination.tsx#L30) + +Pagination component for navigating between pages in a table. + +This component provides buttons to navigate to the first page, previous page, +next page, and last page of a table. The visibility and functionality of the +buttons are controlled based on the current page and the total number of items. + +## Parameters + +### props + +`InterfaceTablePaginationActionsProps` + +Component properties. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/components/PaginationList/PaginationList/functions/default.md b/docs/docs/auto-docs/components/PaginationList/PaginationList/functions/default.md new file mode 100644 index 0000000000..df06f0a44f --- /dev/null +++ b/docs/docs/auto-docs/components/PaginationList/PaginationList/functions/default.md @@ -0,0 +1,22 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/PaginationList/PaginationList.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/PaginationList/PaginationList.tsx#L31) + +A component that provides pagination controls for a table. +It uses different pagination styles based on screen size. + +## Parameters + +### \_\_namedParameters + +`InterfacePropsInterface` + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/components/ProfileDropdown/ProfileDropdown/functions/default.md b/docs/docs/auto-docs/components/ProfileDropdown/ProfileDropdown/functions/default.md new file mode 100644 index 0000000000..311e852279 --- /dev/null +++ b/docs/docs/auto-docs/components/ProfileDropdown/ProfileDropdown/functions/default.md @@ -0,0 +1,24 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/ProfileDropdown/ProfileDropdown.tsx:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/ProfileDropdown/ProfileDropdown.tsx#L24) + +Renders a profile dropdown menu for the user. + +This component displays the user's profile picture or an avatar, their name (truncated if necessary), +and their role (SuperAdmin, Admin, or User). It provides options to view the profile or log out. + +- If a user image is available, it displays that; otherwise, it shows an avatar. +- The displayed name is truncated if it exceeds a specified length. +- The logout function revokes the refresh token and clears local storage before redirecting to the home page. + +## Returns + +`Element` + +JSX.Element - The profile dropdown menu. diff --git a/docs/docs/auto-docs/components/RecurrenceOptions/CustomRecurrenceModal/functions/default.md b/docs/docs/auto-docs/components/RecurrenceOptions/CustomRecurrenceModal/functions/default.md new file mode 100644 index 0000000000..9e2da7e172 --- /dev/null +++ b/docs/docs/auto-docs/components/RecurrenceOptions/CustomRecurrenceModal/functions/default.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/RecurrenceOptions/CustomRecurrenceModal.tsx:54](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/RecurrenceOptions/CustomRecurrenceModal.tsx#L54) + +A modal for setting up custom recurrence rules. + +This component allows users to configure how often an event should repeat, and +when it should end. It includes options for daily, weekly, monthly, and yearly +recurrence, as well as specific end options. + +## Parameters + +### props + +`InterfaceCustomRecurrenceModalProps` + +The props object containing various configurations and state management functions. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The JSX element representing the CustomRecurrenceModal. diff --git a/docs/docs/auto-docs/components/RecurrenceOptions/RecurrenceOptions/functions/default.md b/docs/docs/auto-docs/components/RecurrenceOptions/RecurrenceOptions/functions/default.md new file mode 100644 index 0000000000..e7a4d84538 --- /dev/null +++ b/docs/docs/auto-docs/components/RecurrenceOptions/RecurrenceOptions/functions/default.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/RecurrenceOptions/RecurrenceOptions.tsx:49](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/RecurrenceOptions/RecurrenceOptions.tsx#L49) + +Renders a dropdown menu for selecting recurrence options. + +This component allows users to choose various recurrence rules (daily, weekly, monthly, yearly) for a given event. +It displays the current recurrence rule text and provides options to modify it, including a custom recurrence modal. + +The dropdown menu includes options for: +- Daily recurrence +- Weekly recurrence (including a specific day of the week or Monday to Friday) +- Monthly recurrence (on a specific day or occurrence) +- Yearly recurrence +- Custom recurrence (opens a modal for advanced settings) + +The displayed recurrence rule text is truncated if it exceeds a specified length, with an overlay showing the full text on hover. + +## Parameters + +### props + +`InterfaceRecurrenceOptionsProps` + +The properties to configure the recurrence options dropdown. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +JSX.Element - The recurrence options dropdown and the custom recurrence modal. diff --git a/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/functions/default.md b/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/functions/default.md new file mode 100644 index 0000000000..e094d4fbc0 --- /dev/null +++ b/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/RequestsTableItem/RequestsTableItem.tsx:45](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/RequestsTableItem/RequestsTableItem.tsx#L45) + +Renders a table row item for a membership request. + +This component displays user details and provides buttons to accept or reject +the membership request. It also handles showing success or error messages using +toast notifications. + +## Parameters + +### props + +`Props` + +The props object containing request details, index, and state reset function. + +## Returns + +`Element` + +The JSX element representing the RequestsTableItem. diff --git a/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/interfaces/InterfaceRequestsListItem.md b/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/interfaces/InterfaceRequestsListItem.md new file mode 100644 index 0000000000..d2e765fc57 --- /dev/null +++ b/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItem/interfaces/InterfaceRequestsListItem.md @@ -0,0 +1,37 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceRequestsListItem + +Defined in: [src/components/RequestsTableItem/RequestsTableItem.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/RequestsTableItem/RequestsTableItem.tsx#L16) + +Represents a membership request in the requests table. + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/components/RequestsTableItem/RequestsTableItem.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/RequestsTableItem/RequestsTableItem.tsx#L17) + +*** + +### user + +> **user**: `object` + +Defined in: [src/components/RequestsTableItem/RequestsTableItem.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/RequestsTableItem/RequestsTableItem.tsx#L18) + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` diff --git a/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItemMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItemMocks/variables/MOCKS.md new file mode 100644 index 0000000000..40e58ed982 --- /dev/null +++ b/docs/docs/auto-docs/components/RequestsTableItem/RequestsTableItemMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `acceptMembershipRequest`: \{ `_id`: `string`; \}; `rejectMembershipRequest`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `acceptMembershipRequest`: `undefined`; `rejectMembershipRequest`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/components/RequestsTableItem/RequestsTableItemMocks.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/RequestsTableItem/RequestsTableItemMocks.ts#L6) diff --git a/docs/docs/auto-docs/components/SecuredRoute/SecuredRoute/functions/default.md b/docs/docs/auto-docs/components/SecuredRoute/SecuredRoute/functions/default.md new file mode 100644 index 0000000000..716d2fbd29 --- /dev/null +++ b/docs/docs/auto-docs/components/SecuredRoute/SecuredRoute/functions/default.md @@ -0,0 +1,20 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/SecuredRoute/SecuredRoute.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/SecuredRoute/SecuredRoute.tsx#L16) + +A route guard that checks if the user is logged in and has the necessary permissions. + +If the user is logged in and has an admin role set, it renders the child routes. +Otherwise, it redirects to the home page or shows a 404 page if admin role is not set. + +## Returns + +`Element` + +The JSX element representing the secured route. diff --git a/docs/docs/auto-docs/components/SuperAdminScreen/SuperAdminScreen/functions/default.md b/docs/docs/auto-docs/components/SuperAdminScreen/SuperAdminScreen/functions/default.md new file mode 100644 index 0000000000..6d2e83010a --- /dev/null +++ b/docs/docs/auto-docs/components/SuperAdminScreen/SuperAdminScreen/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/SuperAdminScreen/SuperAdminScreen.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/SuperAdminScreen/SuperAdminScreen.tsx#L15) + +The SuperAdminScreen component manages the layout for the Super Admin screen, +including handling the sidebar visibility and page title based on the current route. + +## Returns + +`Element` + +The JSX element representing the Super Admin screen layout. diff --git a/docs/docs/auto-docs/components/TableLoader/TableLoader/functions/default.md b/docs/docs/auto-docs/components/TableLoader/TableLoader/functions/default.md new file mode 100644 index 0000000000..a4e00d8d6f --- /dev/null +++ b/docs/docs/auto-docs/components/TableLoader/TableLoader/functions/default.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/TableLoader/TableLoader.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TableLoader/TableLoader.tsx#L23) + +The TableLoader component displays a loading skeleton for tables. +It shows a specified number of rows and columns as placeholders +with a shimmering effect to indicate loading content. + +## Parameters + +### props + +[`InterfaceTableLoader`](../interfaces/InterfaceTableLoader.md) + +The properties for the TableLoader component. + +## Returns + +`Element` + +The JSX element representing the table loader. diff --git a/docs/docs/auto-docs/components/TableLoader/TableLoader/interfaces/InterfaceTableLoader.md b/docs/docs/auto-docs/components/TableLoader/TableLoader/interfaces/InterfaceTableLoader.md new file mode 100644 index 0000000000..e92b113d4a --- /dev/null +++ b/docs/docs/auto-docs/components/TableLoader/TableLoader/interfaces/InterfaceTableLoader.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceTableLoader + +Defined in: [src/components/TableLoader/TableLoader.tsx:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TableLoader/TableLoader.tsx#L5) + +## Properties + +### headerTitles? + +> `optional` **headerTitles**: `string`[] + +Defined in: [src/components/TableLoader/TableLoader.tsx:7](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TableLoader/TableLoader.tsx#L7) + +*** + +### noOfCols? + +> `optional` **noOfCols**: `number` + +Defined in: [src/components/TableLoader/TableLoader.tsx:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TableLoader/TableLoader.tsx#L8) + +*** + +### noOfRows + +> **noOfRows**: `number` + +Defined in: [src/components/TableLoader/TableLoader.tsx:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TableLoader/TableLoader.tsx#L6) diff --git a/docs/docs/auto-docs/components/TagActions/TagActions/functions/default.md b/docs/docs/auto-docs/components/TagActions/TagActions/functions/default.md new file mode 100644 index 0000000000..48327641c8 --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagActions/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/TagActions/TagActions.tsx:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActions.tsx#L44) + +## Parameters + +### props + +[`InterfaceTagActionsProps`](../interfaces/InterfaceTagActionsProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/TagActions/TagActions/interfaces/InterfaceTagActionsProps.md b/docs/docs/auto-docs/components/TagActions/TagActions/interfaces/InterfaceTagActionsProps.md new file mode 100644 index 0000000000..5322d403cd --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagActions/interfaces/InterfaceTagActionsProps.md @@ -0,0 +1,53 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceTagActionsProps + +Defined in: [src/components/TagActions/TagActions.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActions.tsx#L36) + +Props for the `AssignToTags` component. + +## Properties + +### hideTagActionsModal() + +> **hideTagActionsModal**: () => `void` + +Defined in: [src/components/TagActions/TagActions.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActions.tsx#L38) + +#### Returns + +`void` + +*** + +### t + +> **t**: `TFunction`\<`"manageTag"`\> + +Defined in: [src/components/TagActions/TagActions.tsx:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActions.tsx#L40) + +*** + +### tagActionsModalIsOpen + +> **tagActionsModalIsOpen**: `boolean` + +Defined in: [src/components/TagActions/TagActions.tsx:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActions.tsx#L37) + +*** + +### tagActionType + +> **tagActionType**: [`TagActionType`](../../../../utils/organizationTagsUtils/type-aliases/TagActionType.md) + +Defined in: [src/components/TagActions/TagActions.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActions.tsx#L39) + +*** + +### tCommon + +> **tCommon**: `TFunction`\<`"common"`\> + +Defined in: [src/components/TagActions/TagActions.tsx:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActions.tsx#L41) diff --git a/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..6f37f3434c --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `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`: \{ `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/TagActions/TagActionsMocks.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActionsMocks.ts#L9) diff --git a/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS_ERROR_ORGANIZATION_TAGS_QUERY.md b/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS_ERROR_ORGANIZATION_TAGS_QUERY.md new file mode 100644 index 0000000000..b0bd6383c5 --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS_ERROR_ORGANIZATION_TAGS_QUERY.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_ORGANIZATION\_TAGS\_QUERY + +> `const` **MOCKS\_ERROR\_ORGANIZATION\_TAGS\_QUERY**: `object`[] + +Defined in: [src/components/TagActions/TagActionsMocks.ts:622](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActionsMocks.ts#L622) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `ORGANIZATION_USER_TAGS_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.first + +> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` + +#### request.variables.id + +> **id**: `string` = `'123'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.name + +> **name**: `object` + +#### request.variables.where.name.starts\_with + +> **starts\_with**: `string` = `''` diff --git a/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY.md b/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY.md new file mode 100644 index 0000000000..cfeeb0b0a1 --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagActionsMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_SUBTAGS\_QUERY + +> `const` **MOCKS\_ERROR\_SUBTAGS\_QUERY**: (\{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `id`: `string`; `where`: \{ `name`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `id`: `string`; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/components/TagActions/TagActionsMocks.ts:636](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagActionsMocks.ts#L636) diff --git a/docs/docs/auto-docs/components/TagActions/TagNode/functions/default.md b/docs/docs/auto-docs/components/TagActions/TagNode/functions/default.md new file mode 100644 index 0000000000..24dbf2e299 --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagNode/functions/default.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/TagActions/TagNode.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagNode.tsx#L29) + +Renders the Tags which can be expanded to list subtags. + +## Parameters + +### props + +`InterfaceTagNodeProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/TagActions/TagNodeMocks/variables/MOCKS1.md b/docs/docs/auto-docs/components/TagActions/TagNodeMocks/variables/MOCKS1.md new file mode 100644 index 0000000000..05cac4edc9 --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagNodeMocks/variables/MOCKS1.md @@ -0,0 +1,9 @@ +[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/TagActions/TagNodeMocks.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/TagNodeMocks.ts#L3) diff --git a/docs/docs/auto-docs/components/TagActions/TagNodeMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY1.md b/docs/docs/auto-docs/components/TagActions/TagNodeMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY1.md new file mode 100644 index 0000000000..d3a99f9295 --- /dev/null +++ b/docs/docs/auto-docs/components/TagActions/TagNodeMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY1.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_SUBTAGS\_QUERY1 + +> `const` **MOCKS\_ERROR\_SUBTAGS\_QUERY1**: `object`[] + +Defined in: [src/components/TagActions/TagNodeMocks.ts:64](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/TagActions/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'` diff --git a/docs/docs/auto-docs/components/UpdateSession/UpdateSession/functions/default.md b/docs/docs/auto-docs/components/UpdateSession/UpdateSession/functions/default.md new file mode 100644 index 0000000000..4d1da8c834 --- /dev/null +++ b/docs/docs/auto-docs/components/UpdateSession/UpdateSession/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/UpdateSession/UpdateSession.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UpdateSession/UpdateSession.tsx#L29) + +## Parameters + +### props + +`TestInterfaceUpdateTimeoutProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/UserListCard/UserListCard/functions/default.md b/docs/docs/auto-docs/components/UserListCard/UserListCard/functions/default.md new file mode 100644 index 0000000000..3ee8f6943b --- /dev/null +++ b/docs/docs/auto-docs/components/UserListCard/UserListCard/functions/default.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserListCard/UserListCard.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserListCard/UserListCard.tsx#L27) + +The UserListCard component allows for adding a user as an admin in a specific organization. +It uses a button to trigger a mutation for updating the user's role. + +## Parameters + +### props + +`InterfaceUserListCardProps` + +The properties for the UserListCard component. + +## Returns + +`JSX.Element` + +The JSX element representing the user list card. diff --git a/docs/docs/auto-docs/components/UserPasswordUpdate/UserPasswordUpdate/functions/default.md b/docs/docs/auto-docs/components/UserPasswordUpdate/UserPasswordUpdate/functions/default.md new file mode 100644 index 0000000000..0ab118909d --- /dev/null +++ b/docs/docs/auto-docs/components/UserPasswordUpdate/UserPasswordUpdate/functions/default.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/UserPasswordUpdate/UserPasswordUpdate.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPasswordUpdate/UserPasswordUpdate.tsx#L23) + +UserUpdate component allows users to update their passwords. +It handles form submission and communicates with the backend to update the user's password. + +## Parameters + +### props + +`InterfaceUserPasswordUpdateProps` + +The properties for the UserUpdate component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The JSX element for updating user password. diff --git a/docs/docs/auto-docs/components/UserPasswordUpdate/UserPasswordUpdateMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/UserPasswordUpdate/UserPasswordUpdateMocks/variables/MOCKS.md new file mode 100644 index 0000000000..7bd080545d --- /dev/null +++ b/docs/docs/auto-docs/components/UserPasswordUpdate/UserPasswordUpdateMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `confirmNewPassword`: `string`; `newPassword`: `string`; `previousPassword`: `string`; \}; \}; `result`: \{ `data`: \{ `users`: `object`[]; \}; `errors`: `undefined`; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `confirmNewPassword`: `string`; `newPassword`: `string`; `previousPassword`: `string`; \}; \}; `result`: \{ `data`: `undefined`; `errors`: `object`[]; \}; \})[] + +Defined in: [src/components/UserPasswordUpdate/UserPasswordUpdateMocks.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPasswordUpdate/UserPasswordUpdateMocks.ts#L3) diff --git a/docs/docs/auto-docs/components/UserPortal/ChatRoom/ChatRoom/functions/default.md b/docs/docs/auto-docs/components/UserPortal/ChatRoom/ChatRoom/functions/default.md new file mode 100644 index 0000000000..5dbac17a54 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/ChatRoom/ChatRoom/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/ChatRoom/ChatRoom.tsx:100](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/ChatRoom/ChatRoom.tsx#L100) + +## Parameters + +### props + +`InterfaceChatRoomProps` + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/UserPortal/CommentCard/CommentCard/functions/default.md b/docs/docs/auto-docs/components/UserPortal/CommentCard/CommentCard/functions/default.md new file mode 100644 index 0000000000..22ff90ab54 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/CommentCard/CommentCard/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/CommentCard/CommentCard.tsx:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/CommentCard/CommentCard.tsx#L51) + +Displays a card for a single comment with options to like or dislike the comment. + +Shows the commenter's name, the comment text, and the number of likes. +Allows the user to like or dislike the comment. The button icon changes based on whether the comment is liked by the user. + +## Parameters + +### props + +`InterfaceCommentCardProps` + +The properties passed to the component. + +## Returns + +`JSX.Element` + +The rendered comment card component. diff --git a/docs/docs/auto-docs/components/UserPortal/ContactCard/ContactCard/functions/default.md b/docs/docs/auto-docs/components/UserPortal/ContactCard/ContactCard/functions/default.md new file mode 100644 index 0000000000..2f140715a0 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/ContactCard/ContactCard/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/ContactCard/ContactCard.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/ContactCard/ContactCard.tsx#L36) + +Displays a card for a contact in a contact list. + +Shows the contact's name, email, and an image or avatar. +The card changes background color based on whether it is selected. +Clicking on the card sets it as the selected contact and updates the contact name. + +## Parameters + +### props + +`InterfaceContactCardProps` + +The properties passed to the component. + +## Returns + +`JSX.Element` + +The rendered contact card component. diff --git a/docs/docs/auto-docs/components/UserPortal/CreateDirectChat/CreateDirectChat/functions/default.md b/docs/docs/auto-docs/components/UserPortal/CreateDirectChat/CreateDirectChat/functions/default.md new file mode 100644 index 0000000000..574b8b4c6a --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/CreateDirectChat/CreateDirectChat/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx#L60) + +## Parameters + +### \_\_namedParameters + +`InterfaceCreateDirectChatProps` + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/UserPortal/CreateGroupChat/CreateGroupChat/functions/default.md b/docs/docs/auto-docs/components/UserPortal/CreateGroupChat/CreateGroupChat/functions/default.md new file mode 100644 index 0000000000..50101b58c0 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/CreateGroupChat/CreateGroupChat/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `JSX.Element` + +Defined in: [src/components/UserPortal/CreateGroupChat/CreateGroupChat.tsx:63](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/CreateGroupChat/CreateGroupChat.tsx#L63) + +## Parameters + +### \_\_namedParameters + +`InterfaceCreateGroupChatProps` + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/UserPortal/DonationCard/DonationCard/functions/default.md b/docs/docs/auto-docs/components/UserPortal/DonationCard/DonationCard/functions/default.md new file mode 100644 index 0000000000..81dedec646 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/DonationCard/DonationCard/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/DonationCard/DonationCard.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/DonationCard/DonationCard.tsx#L19) + +Displays a card with details about a donation. + +Shows the donor's name, the amount donated, and the date of the donation. +Includes a button to view more details about the donation. + +## Parameters + +### props + +[`InterfaceDonationCardProps`](../../../../../screens/UserPortal/Donate/Donate/interfaces/InterfaceDonationCardProps.md) + +The properties passed to the component. + +## Returns + +`JSX.Element` + +The rendered donation card component. diff --git a/docs/docs/auto-docs/components/UserPortal/EventCard/EventCard/functions/default.md b/docs/docs/auto-docs/components/UserPortal/EventCard/EventCard/functions/default.md new file mode 100644 index 0000000000..4dad52135d --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/EventCard/EventCard/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/EventCard/EventCard.tsx:63](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/EventCard/EventCard.tsx#L63) + +Displays information about an event and provides an option to register for it. + +Shows the event's title, description, location, start and end dates and times, +creator's name, and registration status. Includes a button to register for the event +if the user is not already registered. + +## Parameters + +### props + +`InterfaceEventCardProps` + +The properties for the event card. + +## Returns + +`JSX.Element` + +The event card component. diff --git a/docs/docs/auto-docs/components/UserPortal/OrganizationCard/OrganizationCard/functions/default.md b/docs/docs/auto-docs/components/UserPortal/OrganizationCard/OrganizationCard/functions/default.md new file mode 100644 index 0000000000..b6df6cd4b2 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/OrganizationCard/OrganizationCard/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/OrganizationCard/OrganizationCard.tsx:73](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/OrganizationCard/OrganizationCard.tsx#L73) + +## Parameters + +### props + +`InterfaceOrganizationCardProps` + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/UserPortal/OrganizationNavbar/OrganizationNavbar/functions/default.md b/docs/docs/auto-docs/components/UserPortal/OrganizationNavbar/OrganizationNavbar/functions/default.md new file mode 100644 index 0000000000..48a6820765 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/OrganizationNavbar/OrganizationNavbar/functions/default.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/OrganizationNavbar/OrganizationNavbar.tsx:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/OrganizationNavbar/OrganizationNavbar.tsx#L44) + +Displays the organization navbar with navigation options, user settings, and language selection. + +The navbar includes: +- Organization branding and name. +- Navigation links for various plugins based on user permissions. +- Language dropdown for changing the interface language. +- User dropdown for accessing settings and logging out. + +## Parameters + +### props + +`InterfaceNavbarProps` + +The properties for the navbar. + +## Returns + +`JSX.Element` + +The organization navbar component. diff --git a/docs/docs/auto-docs/components/UserPortal/OrganizationSidebar/OrganizationSidebar/functions/default.md b/docs/docs/auto-docs/components/UserPortal/OrganizationSidebar/OrganizationSidebar/functions/default.md new file mode 100644 index 0000000000..3e00bd458c --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/OrganizationSidebar/OrganizationSidebar/functions/default.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/UserPortal/OrganizationSidebar/OrganizationSidebar.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/OrganizationSidebar/OrganizationSidebar.tsx#L36) + +OrganizationSidebar displays the sidebar for an organization, showing a list of members and events. + +This component fetches and displays: +- The top 3 members of the organization with their images and names. +- The top 3 upcoming events for the organization with their titles, start, and end dates. + +It includes: +- A link to view all members. +- A link to view all events. + +The sidebar handles loading states and displays appropriate messages while data is being fetched. + +## Returns + +`JSX.Element` + +JSX.Element representing the organization sidebar. diff --git a/docs/docs/auto-docs/components/UserPortal/PeopleCard/PeopleCard/functions/default.md b/docs/docs/auto-docs/components/UserPortal/PeopleCard/PeopleCard/functions/default.md new file mode 100644 index 0000000000..3e5088cbba --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/PeopleCard/PeopleCard/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/PeopleCard/PeopleCard.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/PeopleCard/PeopleCard.tsx#L30) + +PeopleCard component displays information about a person within an organization. + +It includes: +- An image of the person or a default image if none is provided. +- The serial number of the person. +- The person's name. +- The person's email address. +- The person's role within the organization, styled with a border. + +## Parameters + +### props + +`InterfaceOrganizationCardProps` + +The properties passed to the component. + +## Returns + +`JSX.Element` + +JSX.Element representing a card with the person's details. diff --git a/docs/docs/auto-docs/components/UserPortal/PostCard/PostCard/functions/default.md b/docs/docs/auto-docs/components/UserPortal/PostCard/PostCard/functions/default.md new file mode 100644 index 0000000000..e0525c48f6 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/PostCard/PostCard/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/PostCard/PostCard.tsx:69](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/PostCard/PostCard.tsx#L69) + +PostCard component displays an individual post, including its details, interactions, and comments. + +The component allows users to: +- View the post's details in a modal. +- Edit or delete the post. +- Like or unlike the post. +- Add comments to the post. +- Like or dislike individual comments. + +## Parameters + +### props + +[`InterfacePostCard`](../../../../../utils/interfaces/interfaces/InterfacePostCard.md) + +The properties passed to the component including post details, comments, and related actions. + +## Returns + +`JSX.Element` + +JSX.Element representing a post card with interactive features. diff --git a/docs/docs/auto-docs/components/UserPortal/PromotedPost/PromotedPost/functions/default.md b/docs/docs/auto-docs/components/UserPortal/PromotedPost/PromotedPost/functions/default.md new file mode 100644 index 0000000000..c93021d133 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/PromotedPost/PromotedPost/functions/default.md @@ -0,0 +1,30 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/PromotedPost/PromotedPost.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/PromotedPost/PromotedPost.tsx#L23) + +PromotedPost component displays a card representing promoted content. + +This component includes: +- A header with a star icon indicating the content is promoted. +- A title and description of the promoted content. +- An optional image associated with the promoted content. + +## Parameters + +### props + +`InterfacePostCardProps` + +Properties passed to the component including an image, title, and ID. + +## Returns + +`JSX.Element` + +JSX.Element representing a card with promoted content. diff --git a/docs/docs/auto-docs/components/UserPortal/Register/Register/functions/default.md b/docs/docs/auto-docs/components/UserPortal/Register/Register/functions/default.md new file mode 100644 index 0000000000..c245661094 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/Register/Register/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `JSX.Element` + +Defined in: [src/components/UserPortal/Register/Register.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/Register/Register.tsx#L22) + +## Parameters + +### props + +`InterfaceRegisterProps` + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser/functions/default.md b/docs/docs/auto-docs/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser/functions/default.md new file mode 100644 index 0000000000..8557a9cbe9 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser/functions/default.md @@ -0,0 +1,20 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser.tsx#L14) + +A component that guards routes by checking if the user is logged in. +If the user is logged in and does not have 'AdminFor' set, the child routes are rendered. +If the user is not logged in, they are redirected to the homepage. +If the user is logged in but has 'AdminFor' set, a 404 page is shown. + +## Returns + +`Element` + +JSX.Element - Rendered component based on user authentication and role. diff --git a/docs/docs/auto-docs/components/UserPortal/StartPostModal/StartPostModal/functions/default.md b/docs/docs/auto-docs/components/UserPortal/StartPostModal/StartPostModal/functions/default.md new file mode 100644 index 0000000000..c5ae6c4996 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/StartPostModal/StartPostModal/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/UserPortal/StartPostModal/StartPostModal.tsx:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/StartPostModal/StartPostModal.tsx#L40) + +A modal component for creating a new post. + +This modal includes: +- A form where users can input the content of the post. +- A preview of the image if provided. +- User's profile image and name displayed in the modal header. + +## Parameters + +### \_\_namedParameters + +`InterfaceStartPostModalProps` + +## Returns + +`Element` + +JSX.Element - The rendered modal component. diff --git a/docs/docs/auto-docs/components/UserPortal/UserNavbar/UserNavbar/functions/default.md b/docs/docs/auto-docs/components/UserPortal/UserNavbar/UserNavbar/functions/default.md new file mode 100644 index 0000000000..64709c0b0d --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/UserNavbar/UserNavbar/functions/default.md @@ -0,0 +1,22 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/UserPortal/UserNavbar/UserNavbar.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserNavbar/UserNavbar.tsx#L26) + +Navbar component for user-specific actions and settings. + +This component provides: +- A branding image and name. +- A dropdown for language selection. +- A dropdown for user actions including profile settings and logout. + +## Returns + +`JSX.Element` + +JSX.Element - The rendered Navbar component. diff --git a/docs/docs/auto-docs/components/UserPortal/UserProfile/EventsAttendedByUser/functions/EventsAttendedByUser.md b/docs/docs/auto-docs/components/UserPortal/UserProfile/EventsAttendedByUser/functions/EventsAttendedByUser.md new file mode 100644 index 0000000000..d45165cfb0 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/UserProfile/EventsAttendedByUser/functions/EventsAttendedByUser.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: EventsAttendedByUser() + +> **EventsAttendedByUser**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/UserPortal/UserProfile/EventsAttendedByUser.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserProfile/EventsAttendedByUser.tsx#L31) + +## Parameters + +### props + +`InterfaceUser` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/components/UserPortal/UserProfile/UserAddressFields/functions/UserAddressFields.md b/docs/docs/auto-docs/components/UserPortal/UserProfile/UserAddressFields/functions/UserAddressFields.md new file mode 100644 index 0000000000..be024bf6a0 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/UserProfile/UserAddressFields/functions/UserAddressFields.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: UserAddressFields() + +> **UserAddressFields**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/UserPortal/UserProfile/UserAddressFields.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserProfile/UserAddressFields.tsx#L26) + +Form component containing address-related input fields for user profile +Includes fields for address, city, state, and country + +## Parameters + +### props + +`InterfaceUserAddressFieldsProps` + +Component props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +Form group with address input fields diff --git a/docs/docs/auto-docs/components/UserPortal/UserSidebar/UserSidebar/functions/default.md b/docs/docs/auto-docs/components/UserPortal/UserSidebar/UserSidebar/functions/default.md new file mode 100644 index 0000000000..a2d2fbf308 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/UserSidebar/UserSidebar/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/UserPortal/UserSidebar/UserSidebar.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebar/UserSidebar.tsx#L28) + +Sidebar component for user navigation, including links to organizations and settings. + +Provides: +- A logo and title for the sidebar. +- Navigation buttons for "My Organizations" and "Settings". +- Dynamic styling based on the active route. + +## Parameters + +### \_\_namedParameters + +[`InterfaceUserSidebarProps`](../interfaces/InterfaceUserSidebarProps.md) + +## Returns + +`Element` + +JSX.Element - The rendered sidebar component. diff --git a/docs/docs/auto-docs/components/UserPortal/UserSidebar/UserSidebar/interfaces/InterfaceUserSidebarProps.md b/docs/docs/auto-docs/components/UserPortal/UserSidebar/UserSidebar/interfaces/InterfaceUserSidebarProps.md new file mode 100644 index 0000000000..ca470b994b --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/UserSidebar/UserSidebar/interfaces/InterfaceUserSidebarProps.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUserSidebarProps + +Defined in: [src/components/UserPortal/UserSidebar/UserSidebar.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebar/UserSidebar.tsx#L10) + +## Properties + +### hideDrawer + +> **hideDrawer**: `boolean` + +Defined in: [src/components/UserPortal/UserSidebar/UserSidebar.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebar/UserSidebar.tsx#L11) + +*** + +### setHideDrawer + +> **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> + +Defined in: [src/components/UserPortal/UserSidebar/UserSidebar.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebar/UserSidebar.tsx#L12) diff --git a/docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/functions/default.md b/docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/functions/default.md new file mode 100644 index 0000000000..dd32034534 --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx#L39) + +Sidebar component for user navigation within an organization. + +Provides: +- Branding with the Talawa logo. +- Displays the current organization's details. +- Navigation options with links and collapsible dropdowns. + +## Parameters + +### \_\_namedParameters + +[`InterfaceUserSidebarOrgProps`](../interfaces/InterfaceUserSidebarOrgProps.md) + +## Returns + +`Element` + +JSX.Element - The rendered sidebar component. diff --git a/docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/interfaces/InterfaceUserSidebarOrgProps.md b/docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/interfaces/InterfaceUserSidebarOrgProps.md new file mode 100644 index 0000000000..de7c0b759b --- /dev/null +++ b/docs/docs/auto-docs/components/UserPortal/UserSidebarOrg/UserSidebarOrg/interfaces/InterfaceUserSidebarOrgProps.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUserSidebarOrgProps + +Defined in: [src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx#L17) + +## Properties + +### hideDrawer + +> **hideDrawer**: `boolean` + +Defined in: [src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx#L20) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx#L18) + +*** + +### setHideDrawer + +> **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> + +Defined in: [src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx#L21) + +*** + +### targets + +> **targets**: [`TargetsType`](../../../../../state/reducers/routesReducer/type-aliases/TargetsType.md)[] + +Defined in: [src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserPortal/UserSidebarOrg/UserSidebarOrg.tsx#L19) diff --git a/docs/docs/auto-docs/components/UserProfileSettings/DeleteUser/functions/default.md b/docs/docs/auto-docs/components/UserProfileSettings/DeleteUser/functions/default.md new file mode 100644 index 0000000000..28b4706382 --- /dev/null +++ b/docs/docs/auto-docs/components/UserProfileSettings/DeleteUser/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/UserProfileSettings/DeleteUser.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserProfileSettings/DeleteUser.tsx#L12) + +DeleteUser component displays a card with a button to delete a user. +It includes a message and a button to trigger the delete action. + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The JSX element for the delete user card. diff --git a/docs/docs/auto-docs/components/UserProfileSettings/OtherSettings/functions/default.md b/docs/docs/auto-docs/components/UserProfileSettings/OtherSettings/functions/default.md new file mode 100644 index 0000000000..e925a00b09 --- /dev/null +++ b/docs/docs/auto-docs/components/UserProfileSettings/OtherSettings/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/UserProfileSettings/OtherSettings.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserProfileSettings/OtherSettings.tsx#L13) + +OtherSettings component displays a card with settings options such as changing the language. +It includes a label and a dropdown for selecting a different language. + +## Parameters + +### props + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The JSX element for the other settings card. diff --git a/docs/docs/auto-docs/components/UserProfileSettings/UserProfile/functions/default.md b/docs/docs/auto-docs/components/UserProfileSettings/UserProfile/functions/default.md new file mode 100644 index 0000000000..3963fdb8d8 --- /dev/null +++ b/docs/docs/auto-docs/components/UserProfileSettings/UserProfile/functions/default.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/components/UserProfileSettings/UserProfile.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UserProfileSettings/UserProfile.tsx#L38) + +UserProfile component displays user profile details including an avatar or profile image, name, email, and join date. +It also provides a button to copy the profile link. + +## Parameters + +### props + +`InterfaceUserProfile` + +The properties to be passed into the component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The JSX element for the user profile card. diff --git a/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS.md new file mode 100644 index 0000000000..bbe38e6750 --- /dev/null +++ b/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `organizationId`: `undefined`; `orgid`: `string`; `role`: `undefined`; `userid`: `string`; `userId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `removeMember`: \{ `_id`: `string`; \}; `updateUserRoleInOrganization`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `organizationId`: `string`; `orgid`: `undefined`; `role`: `string`; `userid`: `undefined`; `userId`: `string`; \}; \}; `result`: \{ `data`: \{ `removeMember`: `undefined`; `updateUserRoleInOrganization`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/components/UsersTableItem/UserTableItemMocks.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UsersTableItem/UserTableItemMocks.ts#L6) diff --git a/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS2.md b/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS2.md new file mode 100644 index 0000000000..bb0015ee5c --- /dev/null +++ b/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS2.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS2 + +> `const` **MOCKS2**: `object`[] + +Defined in: [src/components/UsersTableItem/UserTableItemMocks.ts:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UsersTableItem/UserTableItemMocks.ts#L42) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `REMOVE_MEMBER_MUTATION` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orgid + +> **orgid**: `string` = `'abc'` + +#### request.variables.userid + +> **userid**: `string` = `'123'` diff --git a/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS_UPDATE.md b/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS_UPDATE.md new file mode 100644 index 0000000000..78c5fd8436 --- /dev/null +++ b/docs/docs/auto-docs/components/UsersTableItem/UserTableItemMocks/variables/MOCKS_UPDATE.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_UPDATE + +> `const` **MOCKS\_UPDATE**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `organizationId`: `string`; `role`: `string`; `userId`: `string`; \}; \}; `result`: `undefined`; \} \| \{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `organizationId`: `string`; `role`: `string`; `userId`: `string`; \}; \}; `result`: \{ `data`: \{ `updateUserRoleInOrganization`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/components/UsersTableItem/UserTableItemMocks.ts:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UsersTableItem/UserTableItemMocks.ts#L55) diff --git a/docs/docs/auto-docs/components/UsersTableItem/UsersTableItem/functions/default.md b/docs/docs/auto-docs/components/UsersTableItem/UsersTableItem/functions/default.md new file mode 100644 index 0000000000..62c6571d20 --- /dev/null +++ b/docs/docs/auto-docs/components/UsersTableItem/UsersTableItem/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`): `Element` + +Defined in: [src/components/UsersTableItem/UsersTableItem.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/UsersTableItem/UsersTableItem.tsx#L23) + +## Parameters + +### props + +`Props` + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/components/Venues/VenueCard/functions/default.md b/docs/docs/auto-docs/components/Venues/VenueCard/functions/default.md new file mode 100644 index 0000000000..85a64350eb --- /dev/null +++ b/docs/docs/auto-docs/components/Venues/VenueCard/functions/default.md @@ -0,0 +1,37 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/Venues/VenueCard.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueCard.tsx#L39) + +Represents a card component displaying venue information. + +This component renders a card with the venue's image, name, capacity, and description. +It also provides buttons to edit or delete the venue. + +## Parameters + +### \_\_namedParameters + +`InterfaceVenueCardProps` + +## Returns + +`Element` + +JSX.Element - The `VenueCard` component. + +## Example + +```tsx + +``` diff --git a/docs/docs/auto-docs/components/Venues/VenueModal/functions/default.md b/docs/docs/auto-docs/components/Venues/VenueModal/functions/default.md new file mode 100644 index 0000000000..cd893b2cb9 --- /dev/null +++ b/docs/docs/auto-docs/components/Venues/VenueModal/functions/default.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`__namedParameters`): `Element` + +Defined in: [src/components/Venues/VenueModal.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L39) + +A modal component for creating or updating venue information. + +This component displays a modal window where users can enter details for a venue, such as name, description, capacity, and an image. +It also handles submitting the form data to create or update a venue based on whether the `edit` prop is true or false. + +## Parameters + +### \_\_namedParameters + +[`InterfaceVenueModalProps`](../interfaces/InterfaceVenueModalProps.md) + +## Returns + +`Element` + +The rendered modal component. diff --git a/docs/docs/auto-docs/components/Venues/VenueModal/interfaces/InterfaceVenueModalProps.md b/docs/docs/auto-docs/components/Venues/VenueModal/interfaces/InterfaceVenueModalProps.md new file mode 100644 index 0000000000..5cc71e77cd --- /dev/null +++ b/docs/docs/auto-docs/components/Venues/VenueModal/interfaces/InterfaceVenueModalProps.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVenueModalProps + +Defined in: [src/components/Venues/VenueModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L15) + +## Properties + +### edit + +> **edit**: `boolean` + +Defined in: [src/components/Venues/VenueModal.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L21) + +*** + +### onHide() + +> **onHide**: () => `void` + +Defined in: [src/components/Venues/VenueModal.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L17) + +#### Returns + +`void` + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/components/Venues/VenueModal.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L19) + +*** + +### refetchVenues() + +> **refetchVenues**: () => `void` + +Defined in: [src/components/Venues/VenueModal.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L18) + +#### Returns + +`void` + +*** + +### show + +> **show**: `boolean` + +Defined in: [src/components/Venues/VenueModal.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L16) + +*** + +### venueData? + +> `optional` **venueData**: [`InterfaceQueryVenueListItem`](../../../../utils/interfaces/interfaces/InterfaceQueryVenueListItem.md) + +Defined in: [src/components/Venues/VenueModal.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/Venues/VenueModal.tsx#L20) diff --git a/docs/docs/auto-docs/components/plugins/DummyPlugin/DummyPlugin/functions/default.md b/docs/docs/auto-docs/components/plugins/DummyPlugin/DummyPlugin/functions/default.md new file mode 100644 index 0000000000..bba4dd7f99 --- /dev/null +++ b/docs/docs/auto-docs/components/plugins/DummyPlugin/DummyPlugin/functions/default.md @@ -0,0 +1,20 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/plugins/DummyPlugin/DummyPlugin.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/plugins/DummyPlugin/DummyPlugin.tsx#L12) + +A dummy plugin component that renders a welcome message inside an `AddOn` component. + +This component is used for demonstration or testing purposes and does not have any +additional functionality or properties. + +## Returns + +`JSX.Element` + +JSX.Element - Renders the `AddOn` component containing a welcome message. diff --git a/docs/docs/auto-docs/components/plugins/DummyPlugin2/DummyPlugin2/functions/default.md b/docs/docs/auto-docs/components/plugins/DummyPlugin2/DummyPlugin2/functions/default.md new file mode 100644 index 0000000000..9db75d1bf4 --- /dev/null +++ b/docs/docs/auto-docs/components/plugins/DummyPlugin2/DummyPlugin2/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/components/plugins/DummyPlugin2/DummyPlugin2.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/components/plugins/DummyPlugin2/DummyPlugin2.tsx#L10) + +A placeholder component for demonstration or testing purposes. +It renders an empty `div` element. + +This component currently does not have any additional functionality +or properties. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/constants/variables/socialMediaLinks.md b/docs/docs/auto-docs/constants/variables/socialMediaLinks.md new file mode 100644 index 0000000000..15e3e411f9 --- /dev/null +++ b/docs/docs/auto-docs/constants/variables/socialMediaLinks.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: socialMediaLinks + +> `const` **socialMediaLinks**: `object`[] + +Defined in: [src/constants.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/constants.ts#L12) + +## Type declaration + +### href + +> **href**: `string` = `'https://www.facebook.com/palisadoesproject'` + +### logo + +> **logo**: `string` = `FacebookLogo` + +### tag + +> **tag**: `string` = `'facebook'` diff --git a/docs/docs/auto-docs/reportWebVitals/functions/default.md b/docs/docs/auto-docs/reportWebVitals/functions/default.md new file mode 100644 index 0000000000..ec6db8f860 --- /dev/null +++ b/docs/docs/auto-docs/reportWebVitals/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`onPerfEntry`?): `void` + +Defined in: [src/reportWebVitals.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/reportWebVitals.ts#L4) + +## Parameters + +### onPerfEntry? + +(`metric`) => `void` + +## Returns + +`void` diff --git a/docs/docs/auto-docs/screens/BlockUser/BlockUser/functions/default.md b/docs/docs/auto-docs/screens/BlockUser/BlockUser/functions/default.md new file mode 100644 index 0000000000..0250eb0438 --- /dev/null +++ b/docs/docs/auto-docs/screens/BlockUser/BlockUser/functions/default.md @@ -0,0 +1,26 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/BlockUser/BlockUser.tsx:45](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/BlockUser/BlockUser.tsx#L45) + +Requests component displays and manages a list of users that can be blocked or unblocked. + +This component allows users to search for members by their first name or last name, +toggle between viewing blocked and all members, and perform block/unblock operations. + +## Returns + +`Element` + +JSX.Element - The `Requests` component. + +## Example + +```tsx + +``` diff --git a/docs/docs/auto-docs/screens/CommunityProfile/CommunityProfile/functions/default.md b/docs/docs/auto-docs/screens/CommunityProfile/CommunityProfile/functions/default.md new file mode 100644 index 0000000000..05666d6944 --- /dev/null +++ b/docs/docs/auto-docs/screens/CommunityProfile/CommunityProfile/functions/default.md @@ -0,0 +1,28 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/CommunityProfile/CommunityProfile.tsx:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/CommunityProfile/CommunityProfile.tsx#L40) + +`CommunityProfile` component allows users to view and update their community profile details. + +It includes functionalities to: +- Display current community profile information +- Update profile details including social media links and logo +- Reset profile changes to the initial state + +## Returns + +`Element` + +JSX.Element - The `CommunityProfile` component. + +## Example + +```tsx + +``` diff --git a/docs/docs/auto-docs/screens/EventManagement/EventManagement/functions/default.md b/docs/docs/auto-docs/screens/EventManagement/EventManagement/functions/default.md new file mode 100644 index 0000000000..20f0f4b52f --- /dev/null +++ b/docs/docs/auto-docs/screens/EventManagement/EventManagement/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/EventManagement/EventManagement.tsx:91](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventManagement/EventManagement.tsx#L91) + +`EventManagement` component handles the display and navigation of different event management sections. + +It provides a tabbed interface for: +- Viewing event dashboard +- Managing event registrants +- Handling event actions +- Reviewing event agendas +- Viewing event statistics +- Managing event volunteers +- Managing event attendance + +## Returns + +`Element` + +JSX.Element - The `EventManagement` component. + +## Example + +```tsx + +``` diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..8f6721c977 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: `object`[] + +Defined in: [src/screens/EventVolunteers/Requests/Requests.mocks.ts:148](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Requests/Requests.mocks.ts#L148) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `USER_VOLUNTEER_MEMBERSHIP` + +#### request.variables + +> **variables**: `object` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.eventId + +> **eventId**: `string` = `'eventId'` + +#### request.variables.where.status + +> **status**: `string` = `'requested'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getVolunteerMembership + +> **getVolunteerMembership**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..b25b0f84c3 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/ERROR_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `any`; `status`: `undefined`; `where`: \{ `eventId`: `string`; `status`: `string`; `userName`: `any`; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `orderBy`: `undefined`; `status`: `string`; `where`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/EventVolunteers/Requests/Requests.mocks.ts:167](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Requests/Requests.mocks.ts#L167) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..3722917af3 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `undefined`; `status`: `undefined`; `where`: \{ `eventId`: `string`; `status`: `string`; `userName`: `undefined`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `string`; `status`: `undefined`; `where`: \{ `eventId`: `string`; `status`: `string`; `userName`: `undefined`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `undefined`; `status`: `undefined`; `where`: \{ `eventId`: `string`; `status`: `string`; `userName`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `orderBy`: `undefined`; `status`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `undefined`; `updateVolunteerMembership`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/EventVolunteers/Requests/Requests.mocks.ts:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Requests/Requests.mocks.ts#L46) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/UPDATE_ERROR_MOCKS.md b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/UPDATE_ERROR_MOCKS.md new file mode 100644 index 0000000000..d275c5ec19 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests.mocks/variables/UPDATE_ERROR_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ERROR\_MOCKS + +> `const` **UPDATE\_ERROR\_MOCKS**: (\{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `status`: `undefined`; `where`: \{ `eventId`: `string`; `status`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `status`: `string`; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/screens/EventVolunteers/Requests/Requests.mocks.ts:194](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Requests/Requests.mocks.ts#L194) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests/functions/default.md new file mode 100644 index 0000000000..3f079bc405 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Requests/Requests/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/EventVolunteers/Requests/Requests.tsx:53](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Requests/Requests.tsx#L53) + +Component for managing and displaying Volunteer Membership requests for an event. + +This component allows users to view, filter, sort, and create action items. It also allows users to accept or reject volunteer membership requests. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerContainer/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerContainer/functions/default.md new file mode 100644 index 0000000000..fc10e0f8b0 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerContainer/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/EventVolunteers/VolunteerContainer.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerContainer.tsx#L18) + +Container Component for Volunteer or VolunteerGroups as per selection. + +This component allows users switch between Volunteers and VolunteerGroups. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal/functions/default.md new file mode 100644 index 0000000000..f93d1c4d9a --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal/functions/default.md @@ -0,0 +1,46 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx#L42) + +A modal dialog for confirming the deletion of a volunteer group. + +## Parameters + +### props + +[`InterfaceDeleteVolunteerGroupModal`](../interfaces/InterfaceDeleteVolunteerGroupModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `VolunteerGroupDeleteModal` component displays a confirmation dialog when a user attempts to delete a volunteer group. +It allows the user to either confirm or cancel the deletion. +On confirmation, the `deleteVolunteerGroup` mutation is called to remove the volunteer group from the database, +and the `refetchGroups` function is invoked to update the list of volunteer groups. +A success or error toast notification is shown based on the result of the deletion operation. + +The modal includes: +- A header with a title and a close button. +- A body with a message asking for confirmation. +- A footer with "Yes" and "No" buttons to confirm or cancel the deletion. + +The `deleteVolunteerGroup` mutation is used to perform the deletion operation. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal/interfaces/InterfaceDeleteVolunteerGroupModal.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal/interfaces/InterfaceDeleteVolunteerGroupModal.md new file mode 100644 index 0000000000..586c0073c6 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal/interfaces/InterfaceDeleteVolunteerGroupModal.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceDeleteVolunteerGroupModal + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx#L10) + +## Properties + +### group + +> **group**: [`InterfaceVolunteerGroupInfo`](../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md) + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx#L13) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx#L12) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx#L11) + +*** + +### refetchGroups() + +> **refetchGroups**: () => `void` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupDeleteModal.tsx#L14) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal/functions/default.md new file mode 100644 index 0000000000..58dab856f4 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal/functions/default.md @@ -0,0 +1,52 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:63](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L63) + +A modal dialog for creating or editing a volunteer group. + +## Parameters + +### props + +[`InterfaceVolunteerGroupModal`](../interfaces/InterfaceVolunteerGroupModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `VolunteerGroupModal` component displays a form within a modal dialog for creating or editing a Volunteer Group. +It includes fields for entering the group name, description, volunteersRequired, and selecting volunteers/leaders. + +The modal includes: +- A header with a title indicating the current mode (create or edit) and a close button. +- A form with: + - An input field for entering the group name. + - A textarea for entering the group description. + - A multi-select dropdown for selecting leader. + - A multi-select dropdown for selecting volunteers. + - An input field for entering the number of volunteers required. +- A submit button to create or update the pledge. + +On form submission, the component either: +- Calls `updatePledge` mutation to update an existing pledge, or +- Calls `createPledge` mutation to create a new pledge. + +Success or error messages are displayed using toast notifications based on the result of the mutation. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal/interfaces/InterfaceVolunteerGroupModal.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal/interfaces/InterfaceVolunteerGroupModal.md new file mode 100644 index 0000000000..6fa29f0821 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal/interfaces/InterfaceVolunteerGroupModal.md @@ -0,0 +1,71 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVolunteerGroupModal + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L21) + +## Properties + +### eventId + +> **eventId**: `string` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L24) + +*** + +### group + +> **group**: [`InterfaceVolunteerGroupInfo`](../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md) + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L26) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L23) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L22) + +*** + +### mode + +> **mode**: `"create"` \| `"edit"` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L28) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L25) + +*** + +### refetchGroups() + +> **refetchGroups**: () => `void` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupModal.tsx#L27) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal/functions/default.md new file mode 100644 index 0000000000..0bf64e2fb3 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal/functions/default.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx#L41) + +A modal dialog for viewing volunteer group information for an event. + +## Parameters + +### props + +[`InterfaceVolunteerGroupViewModal`](../interfaces/InterfaceVolunteerGroupViewModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `VolunteerGroupViewModal` component displays all the fields of a volunteer group in a modal dialog. + +The modal includes: +- A header with a title and a close button. +- fields for volunteer name, status, hours volunteered, groups, and assignments. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal/interfaces/InterfaceVolunteerGroupViewModal.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal/interfaces/InterfaceVolunteerGroupViewModal.md new file mode 100644 index 0000000000..c779225fe0 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal/interfaces/InterfaceVolunteerGroupViewModal.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVolunteerGroupViewModal + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx#L19) + +## Properties + +### group + +> **group**: [`InterfaceVolunteerGroupInfo`](../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md) + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx#L22) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx#L21) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroupViewModal.tsx#L20) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..2950636bc7 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `string`; `where`: \{ `eventId`: `string`; `leaderName`: `any`; `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `createEventVolunteerGroup`: `undefined`; `getEventVolunteerGroups`: `object`[]; `organizations`: `undefined`; `removeEventVolunteerGroup`: `undefined`; `updateEventVolunteerGroup`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `any`; `where`: \{ `eventId`: `string`; `leaderName`: `string`; `name_contains`: `any`; \}; \}; \}; `result`: \{ `data`: \{ `createEventVolunteerGroup`: `undefined`; `getEventVolunteerGroups`: `object`[]; `organizations`: `undefined`; `removeEventVolunteerGroup`: `undefined`; `updateEventVolunteerGroup`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteerGroup`: `undefined`; `getEventVolunteerGroups`: `undefined`; `organizations`: `object`[]; `removeEventVolunteerGroup`: `undefined`; `updateEventVolunteerGroup`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `string`; `eventId`: `string`; `leaderId`: `string`; `name`: `string`; `volunteersRequired`: `number`; `volunteerUserIds`: `string`[]; \}; `id`: `undefined`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteerGroup`: \{ `_id`: `string`; \}; `getEventVolunteerGroups`: `undefined`; `organizations`: `undefined`; `removeEventVolunteerGroup`: `undefined`; `updateEventVolunteerGroup`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteerGroup`: `undefined`; `getEventVolunteerGroups`: `undefined`; `organizations`: `undefined`; `removeEventVolunteerGroup`: \{ `_id`: `string`; \}; `updateEventVolunteerGroup`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `string`; `eventId`: `string`; `leaderId`: `undefined`; `name`: `string`; `volunteersRequired`: `number`; `volunteerUserIds`: `undefined`; \}; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteerGroup`: `undefined`; `getEventVolunteerGroups`: `undefined`; `organizations`: `undefined`; `removeEventVolunteerGroup`: `undefined`; `updateEventVolunteerGroup`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `undefined`; `eventId`: `string`; `leaderId`: `undefined`; `name`: `undefined`; `volunteersRequired`: `undefined`; `volunteerUserIds`: `undefined`; \}; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteerGroup`: `undefined`; `getEventVolunteerGroups`: `undefined`; `organizations`: `undefined`; `removeEventVolunteerGroup`: `undefined`; `updateEventVolunteerGroup`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks.ts:114](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks.ts#L114) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS_EMPTY.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS_EMPTY.md new file mode 100644 index 0000000000..fb75ca10b1 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS_EMPTY.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_EMPTY + +> `const` **MOCKS\_EMPTY**: `object`[] + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks.ts:339](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks.ts#L339) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_VOLUNTEER_GROUP_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orderBy + +> **orderBy**: `any` = `null` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.eventId + +> **eventId**: `string` = `'eventId'` + +#### request.variables.where.leaderName + +> **leaderName**: `any` = `null` + +#### request.variables.where.name\_contains + +> **name\_contains**: `string` = `''` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getEventVolunteerGroups + +> **getEventVolunteerGroups**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..20616798af --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks/variables/MOCKS_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `any`; `where`: \{ `eventId`: `string`; `leaderName`: `any`; `name_contains`: `string`; \}; \}; \}; `result`: `undefined`; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: `undefined`; \} \| \{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `string`; `eventId`: `string`; `leaderId`: `string`; `name`: `string`; `volunteersRequired`: `number`; `volunteerUserIds`: `string`[]; \}; `id`: `undefined`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: `undefined`; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `string`; `eventId`: `string`; `leaderId`: `undefined`; `name`: `string`; `volunteersRequired`: `number`; `volunteerUserIds`: `undefined`; \}; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks.ts:360](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.mocks.ts#L360) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups/functions/default.md new file mode 100644 index 0000000000..230dd17701 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/VolunteerGroups/VolunteerGroups/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.tsx:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.tsx#L58) + +Component for managing volunteer groups for an event. +This component allows users to view, filter, sort, and create action items. It also provides a modal for creating and editing action items. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerCreateModal/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerCreateModal/functions/default.md new file mode 100644 index 0000000000..6bef7592ba --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerCreateModal/functions/default.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx:48](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx#L48) + +A modal dialog for add a volunteer for an event. + +## Parameters + +### props + +[`InterfaceVolunteerCreateModal`](../interfaces/InterfaceVolunteerCreateModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `VolunteerCreateModal` component displays a form within a modal dialog for adding a volunteer. +It includes fields for selecting user. + +The modal includes: +- A header with a title and a close button. +- A form with: +- A multi-select dropdown for selecting user be added as volunteer. +- A submit button to create or update the pledge. + +On form submission, the component: +- Calls `addVolunteer` mutation to add a new Volunteer. + +Success or error messages are displayed using toast notifications based on the result of the mutation. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerCreateModal/interfaces/InterfaceVolunteerCreateModal.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerCreateModal/interfaces/InterfaceVolunteerCreateModal.md new file mode 100644 index 0000000000..ace2606d7d --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerCreateModal/interfaces/InterfaceVolunteerCreateModal.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVolunteerCreateModal + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx#L14) + +## Properties + +### eventId + +> **eventId**: `string` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx#L17) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx#L16) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx#L15) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx#L18) + +*** + +### refetchVolunteers() + +> **refetchVolunteers**: () => `void` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerCreateModal.tsx#L19) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerDeleteModal/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerDeleteModal/functions/default.md new file mode 100644 index 0000000000..3b62b0403b --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerDeleteModal/functions/default.md @@ -0,0 +1,46 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx#L42) + +A modal dialog for confirming the deletion of a volunteer. + +## Parameters + +### props + +[`InterfaceDeleteVolunteerModal`](../interfaces/InterfaceDeleteVolunteerModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `VolunteerDeleteModal` component displays a confirmation dialog when a user attempts to delete a volunteer. +It allows the user to either confirm or cancel the deletion. +On confirmation, the `deleteVolunteer` mutation is called to remove the pledge from the database, +and the `refetchVolunteers` function is invoked to update the list of volunteers. +A success or error toast notification is shown based on the result of the deletion operation. + +The modal includes: +- A header with a title and a close button. +- A body with a message asking for confirmation. +- A footer with "Yes" and "No" buttons to confirm or cancel the deletion. + +The `deleteVolunteer` mutation is used to perform the deletion operation. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerDeleteModal/interfaces/InterfaceDeleteVolunteerModal.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerDeleteModal/interfaces/InterfaceDeleteVolunteerModal.md new file mode 100644 index 0000000000..0028f7f33f --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerDeleteModal/interfaces/InterfaceDeleteVolunteerModal.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceDeleteVolunteerModal + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx#L10) + +## Properties + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx#L12) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx#L11) + +*** + +### refetchVolunteers() + +> **refetchVolunteers**: () => `void` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx#L14) + +#### Returns + +`void` + +*** + +### volunteer + +> **volunteer**: [`InterfaceEventVolunteerInfo`](../../../../../utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md) + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerDeleteModal.tsx#L13) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerViewModal/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerViewModal/functions/default.md new file mode 100644 index 0000000000..c9ffa46e2f --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerViewModal/functions/default.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx#L42) + +A modal dialog for viewing volunteer information for an event. + +## Parameters + +### props + +[`InterfaceVolunteerViewModal`](../interfaces/InterfaceVolunteerViewModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `VolunteerViewModal` component displays all the fields of a volunteer in a modal dialog. + +The modal includes: +- A header with a title and a close button. +- fields for volunteer name, status, hours volunteered, groups, and assignments. diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerViewModal/interfaces/InterfaceVolunteerViewModal.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerViewModal/interfaces/InterfaceVolunteerViewModal.md new file mode 100644 index 0000000000..d5a4d3fab2 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/VolunteerViewModal/interfaces/InterfaceVolunteerViewModal.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVolunteerViewModal + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx#L20) + +## Properties + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx#L22) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx#L21) + +*** + +### volunteer + +> **volunteer**: [`InterfaceEventVolunteerInfo`](../../../../../utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md) + +Defined in: [src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/VolunteerViewModal.tsx#L23) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..28dbd367ab --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `string`; `where`: \{ `eventId`: `string`; `hasAccepted`: `undefined`; `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `createEventVolunteer`: `undefined`; `getEventVolunteers`: (\{ `_id`: `string`; `assignments`: `any`[]; `groups`: `object`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \} \| \{ `_id`: `string`; `assignments`: `any`[]; `groups`: `any`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `any`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `string`; `lastName`: `string`; \}; \})[]; `organizations`: `undefined`; `removeEventVolunteer`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `any`; `where`: \{ `eventId`: `string`; `hasAccepted`: `boolean`; `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `createEventVolunteer`: `undefined`; `getEventVolunteers`: `object`[]; `organizations`: `undefined`; `removeEventVolunteer`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `any`; `where`: \{ `eventId`: `string`; `hasAccepted`: `boolean`; `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `createEventVolunteer`: `undefined`; `getEventVolunteers`: `object`[]; `organizations`: `undefined`; `removeEventVolunteer`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteer`: `undefined`; `getEventVolunteers`: `undefined`; `organizations`: `undefined`; `removeEventVolunteer`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteer`: `undefined`; `getEventVolunteers`: `undefined`; `organizations`: `object`[]; `removeEventVolunteer`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `eventId`: `string`; `userId`: `string`; \}; `id`: `undefined`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEventVolunteer`: \{ `_id`: `string`; \}; `getEventVolunteers`: `undefined`; `organizations`: `undefined`; `removeEventVolunteer`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/EventVolunteers/Volunteers/Volunteers.mocks.ts:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/Volunteers.mocks.ts#L46) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS_EMPTY.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS_EMPTY.md new file mode 100644 index 0000000000..e7c6d760e2 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS_EMPTY.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_EMPTY + +> `const` **MOCKS\_EMPTY**: `object`[] + +Defined in: [src/screens/EventVolunteers/Volunteers/Volunteers.mocks.ts:288](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/Volunteers.mocks.ts#L288) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_VOLUNTEER_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orderBy + +> **orderBy**: `any` = `null` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.eventId + +> **eventId**: `string` = `'eventId'` + +#### request.variables.where.name\_contains + +> **name\_contains**: `string` = `''` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getEventVolunteers + +> **getEventVolunteers**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..9100428024 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers.mocks/variables/MOCKS_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `any`; `where`: \{ `eventId`: `string`; `name_contains`: `string`; \}; \}; \}; `result`: `undefined`; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: `undefined`; \} \| \{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `eventId`: `string`; `userId`: `string`; \}; `id`: `undefined`; `orderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/screens/EventVolunteers/Volunteers/Volunteers.mocks.ts:217](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/Volunteers.mocks.ts#L217) diff --git a/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers/functions/default.md b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers/functions/default.md new file mode 100644 index 0000000000..29ecf59986 --- /dev/null +++ b/docs/docs/auto-docs/screens/EventVolunteers/Volunteers/Volunteers/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/EventVolunteers/Volunteers/Volunteers.tsx:65](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/EventVolunteers/Volunteers/Volunteers.tsx#L65) + +Component for managing and displaying event volunteers related to an event. + +This component allows users to view, filter, sort, and create volunteers. It also handles fetching and displaying related data such as volunteer acceptance status, etc. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/ForgotPassword/ForgotPassword/functions/default.md b/docs/docs/auto-docs/screens/ForgotPassword/ForgotPassword/functions/default.md new file mode 100644 index 0000000000..9642b45a6b --- /dev/null +++ b/docs/docs/auto-docs/screens/ForgotPassword/ForgotPassword/functions/default.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/ForgotPassword/ForgotPassword.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ForgotPassword/ForgotPassword.tsx#L36) + +`ForgotPassword` component allows users to reset their password. + +It provides two stages: +1. Entering the registered email to receive an OTP. +2. Entering the OTP and new password to reset the password. + +## Returns + +`Element` + +JSX.Element - The `ForgotPassword` component. + +## Example + +```tsx + +``` diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/FundCampaignPledge/functions/default.md b/docs/docs/auto-docs/screens/FundCampaignPledge/FundCampaignPledge/functions/default.md new file mode 100644 index 0000000000..aaba84ac55 --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/FundCampaignPledge/functions/default.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/FundCampaignPledge/FundCampaignPledge.tsx:62](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/FundCampaignPledge.tsx#L62) + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeDeleteModal/functions/default.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeDeleteModal/functions/default.md new file mode 100644 index 0000000000..37dafec4a1 --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeDeleteModal/functions/default.md @@ -0,0 +1,46 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/FundCampaignPledge/PledgeDeleteModal.tsx:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeDeleteModal.tsx#L42) + +A modal dialog for confirming the deletion of a pledge. + +## Parameters + +### props + +[`InterfaceDeletePledgeModal`](../interfaces/InterfaceDeletePledgeModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `PledgeDeleteModal` component displays a confirmation dialog when a user attempts to delete a pledge. +It allows the user to either confirm or cancel the deletion. +On confirmation, the `deletePledge` mutation is called to remove the pledge from the database, +and the `refetchPledge` function is invoked to update the list of pledges. +A success or error toast notification is shown based on the result of the deletion operation. + +The modal includes: +- A header with a title and a close button. +- A body with a message asking for confirmation. +- A footer with "Yes" and "No" buttons to confirm or cancel the deletion. + +The `deletePledge` mutation is used to perform the deletion operation. diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeDeleteModal/interfaces/InterfaceDeletePledgeModal.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeDeleteModal/interfaces/InterfaceDeletePledgeModal.md new file mode 100644 index 0000000000..1acc709ff9 --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeDeleteModal/interfaces/InterfaceDeletePledgeModal.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceDeletePledgeModal + +Defined in: [src/screens/FundCampaignPledge/PledgeDeleteModal.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeDeleteModal.tsx#L10) + +## Properties + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/FundCampaignPledge/PledgeDeleteModal.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeDeleteModal.tsx#L12) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/FundCampaignPledge/PledgeDeleteModal.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeDeleteModal.tsx#L11) + +*** + +### pledge + +> **pledge**: [`InterfacePledgeInfo`](../../../../utils/interfaces/interfaces/InterfacePledgeInfo.md) + +Defined in: [src/screens/FundCampaignPledge/PledgeDeleteModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeDeleteModal.tsx#L13) + +*** + +### refetchPledge() + +> **refetchPledge**: () => `void` + +Defined in: [src/screens/FundCampaignPledge/PledgeDeleteModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeDeleteModal.tsx#L14) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeModal/functions/default.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeModal/functions/default.md new file mode 100644 index 0000000000..8cde5c296f --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeModal/functions/default.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:72](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L72) + +A modal dialog for creating or editing a pledge. + +## Parameters + +### props + +[`InterfacePledgeModal`](../interfaces/InterfacePledgeModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `PledgeModal` component displays a form within a modal dialog for creating or editing a pledge. +It includes fields for selecting users, entering an amount, choosing a currency, and setting start and end dates for the pledge. + +The modal includes: +- A header with a title indicating the current mode (create or edit) and a close button. +- A form with: + - A multi-select dropdown for selecting users to participate in the pledge. + - Date pickers for selecting the start and end dates of the pledge. + - A dropdown for selecting the currency of the pledge amount. + - An input field for entering the pledge amount. +- A submit button to create or update the pledge. + +On form submission, the component either: +- Calls `updatePledge` mutation to update an existing pledge, or +- Calls `createPledge` mutation to create a new pledge. + +Success or error messages are displayed using toast notifications based on the result of the mutation. diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeModal/interfaces/InterfacePledgeModal.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeModal/interfaces/InterfacePledgeModal.md new file mode 100644 index 0000000000..8bef51c03b --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgeModal/interfaces/InterfacePledgeModal.md @@ -0,0 +1,79 @@ +[Admin Docs](/) + +*** + +# Interface: InterfacePledgeModal + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L28) + +## Properties + +### campaignId + +> **campaignId**: `string` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L31) + +*** + +### endDate + +> **endDate**: `Date` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L35) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L30) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L29) + +*** + +### mode + +> **mode**: `"create"` \| `"edit"` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L36) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L32) + +*** + +### pledge + +> **pledge**: [`InterfacePledgeInfo`](../../../../utils/interfaces/interfaces/InterfacePledgeInfo.md) + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L33) + +*** + +### refetchPledge() + +> **refetchPledge**: () => `void` + +Defined in: [src/screens/FundCampaignPledge/PledgeModal.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgeModal.tsx#L34) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..42246af6c6 --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `pledgeOrderBy`: `string`; `where`: \{ `id`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getFundraisingCampaigns`: `object`[]; \}; \}; \})[] + +Defined in: [src/screens/FundCampaignPledge/PledgesMocks.ts:387](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgesMocks.ts#L387) diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS.md new file mode 100644 index 0000000000..25fd5c23b7 --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `pledgeOrderBy`: `string`; `where`: \{ `id`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getFundraisingCampaigns`: `object`[]; `removeFundraisingCampaignPledge`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `pledgeOrderBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getFundraisingCampaigns`: `undefined`; `removeFundraisingCampaignPledge`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/FundCampaignPledge/PledgesMocks.ts:49](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgesMocks.ts#L49) diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS_DELETE_PLEDGE_ERROR.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS_DELETE_PLEDGE_ERROR.md new file mode 100644 index 0000000000..09e8edf105 --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS_DELETE_PLEDGE_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_DELETE\_PLEDGE\_ERROR + +> `const` **MOCKS\_DELETE\_PLEDGE\_ERROR**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; \})[] + +Defined in: [src/screens/FundCampaignPledge/PledgesMocks.ts:374](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgesMocks.ts#L374) diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS_FUND_CAMPAIGN_PLEDGE_ERROR.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS_FUND_CAMPAIGN_PLEDGE_ERROR.md new file mode 100644 index 0000000000..a26ad1ab0b --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/MOCKS_FUND_CAMPAIGN_PLEDGE_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_FUND\_CAMPAIGN\_PLEDGE\_ERROR + +> `const` **MOCKS\_FUND\_CAMPAIGN\_PLEDGE\_ERROR**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `pledgeOrderBy`: `string`; `where`: \{ `id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/FundCampaignPledge/PledgesMocks.ts:358](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgesMocks.ts#L358) diff --git a/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/PLEDGE_MODAL_MOCKS.md b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/PLEDGE_MODAL_MOCKS.md new file mode 100644 index 0000000000..aff729b240 --- /dev/null +++ b/docs/docs/auto-docs/screens/FundCampaignPledge/PledgesMocks/variables/PLEDGE_MODAL_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: PLEDGE\_MODAL\_MOCKS + +> `const` **PLEDGE\_MODAL\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `amount`: `number`; `campaignId`: `undefined`; `currency`: `undefined`; `endDate`: `undefined`; `id`: `string`; `startDate`: `undefined`; `userIds`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createFundraisingCampaignPledge`: `undefined`; `updateFundraisingCampaignPledge`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `amount`: `number`; `campaignId`: `string`; `currency`: `string`; `endDate`: `string`; `id`: `undefined`; `startDate`: `string`; `userIds`: `string`[]; \}; \}; `result`: \{ `data`: \{ `createFundraisingCampaignPledge`: \{ `_id`: `string`; \}; `updateFundraisingCampaignPledge`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/FundCampaignPledge/PledgesMocks.ts:419](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/FundCampaignPledge/PledgesMocks.ts#L419) diff --git a/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..d41b59a512 --- /dev/null +++ b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: `object`[] + +Defined in: [src/screens/Leaderboard/Leaderboard.mocks.ts:162](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Leaderboard/Leaderboard.mocks.ts#L162) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `VOLUNTEER_RANKING` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orgId + +> **orgId**: `string` = `'orgId'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.nameContains + +> **nameContains**: `string` = `''` + +#### request.variables.where.orderBy + +> **orderBy**: `string` = `'hours_DESC'` + +#### request.variables.where.timeFrame + +> **timeFrame**: `string` = `'allTime'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getVolunteerRanks + +> **getVolunteerRanks**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..094293bf75 --- /dev/null +++ b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/ERROR_MOCKS.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: `object`[] + +Defined in: [src/screens/Leaderboard/Leaderboard.mocks.ts:183](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Leaderboard/Leaderboard.mocks.ts#L183) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `VOLUNTEER_RANKING` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orgId + +> **orgId**: `string` = `'orgId'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.nameContains + +> **nameContains**: `string` = `''` + +#### request.variables.where.orderBy + +> **orderBy**: `string` = `'hours_DESC'` + +#### request.variables.where.timeFrame + +> **timeFrame**: `string` = `'allTime'` diff --git a/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..b65c3094ed --- /dev/null +++ b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard.mocks/variables/MOCKS.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: `object`[] + +Defined in: [src/screens/Leaderboard/Leaderboard.mocks.ts:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Leaderboard/Leaderboard.mocks.ts#L51) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `VOLUNTEER_RANKING` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orgId + +> **orgId**: `string` = `'orgId'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.nameContains + +> **nameContains**: `string` = `''` + +#### request.variables.where.orderBy + +> **orderBy**: `string` = `'hours_DESC'` + +#### request.variables.where.timeFrame + +> **timeFrame**: `string` = `'allTime'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getVolunteerRanks + +> **getVolunteerRanks**: `object`[] diff --git a/docs/docs/auto-docs/screens/Leaderboard/Leaderboard/functions/default.md b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard/functions/default.md new file mode 100644 index 0000000000..3786dad4a9 --- /dev/null +++ b/docs/docs/auto-docs/screens/Leaderboard/Leaderboard/functions/default.md @@ -0,0 +1,21 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/Leaderboard/Leaderboard.tsx:62](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Leaderboard/Leaderboard.tsx#L62) + +Component to display the leaderboard of volunteers. + +This component shows a leaderboard of volunteers ranked by hours contributed, +with features for filtering by time frame and sorting by hours. It displays +volunteer details including rank, name, email, and hours volunteered. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/LoginPage/LoginPage/functions/default.md b/docs/docs/auto-docs/screens/LoginPage/LoginPage/functions/default.md new file mode 100644 index 0000000000..e60658477f --- /dev/null +++ b/docs/docs/auto-docs/screens/LoginPage/LoginPage/functions/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/LoginPage/LoginPage.tsx:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/LoginPage/LoginPage.tsx#L46) + +LoginPage component is used to render the login page of the application where user can login or register +to the application using email and password. The component also provides the functionality to switch between login and +register form. + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/screens/ManageTag/EditUserTagModal/functions/default.md b/docs/docs/auto-docs/screens/ManageTag/EditUserTagModal/functions/default.md new file mode 100644 index 0000000000..04218ed44b --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/EditUserTagModal/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L21) + +## Parameters + +### props + +[`InterfaceEditUserTagModalProps`](../interfaces/InterfaceEditUserTagModalProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/ManageTag/EditUserTagModal/interfaces/InterfaceEditUserTagModalProps.md b/docs/docs/auto-docs/screens/ManageTag/EditUserTagModal/interfaces/InterfaceEditUserTagModalProps.md new file mode 100644 index 0000000000..4a699cb8b6 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/EditUserTagModal/interfaces/InterfaceEditUserTagModalProps.md @@ -0,0 +1,89 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceEditUserTagModalProps + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L11) + +Edit UserTag Modal component for the Manage Tag screen. + +## Properties + +### editUserTagModalIsOpen + +> **editUserTagModalIsOpen**: `boolean` + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L12) + +*** + +### handleEditUserTag() + +> **handleEditUserTag**: (`e`) => `Promise`\<`void`\> + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L16) + +#### Parameters + +##### e + +`FormEvent`\<`HTMLFormElement`\> + +#### Returns + +`Promise`\<`void`\> + +*** + +### hideEditUserTagModal() + +> **hideEditUserTagModal**: () => `void` + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L13) + +#### Returns + +`void` + +*** + +### newTagName + +> **newTagName**: `string` + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L14) + +*** + +### setNewTagName() + +> **setNewTagName**: (`state`) => `void` + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L15) + +#### Parameters + +##### state + +`SetStateAction`\<`string`\> + +#### Returns + +`void` + +*** + +### t + +> **t**: `TFunction`\<`"manageTag"`\> + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L17) + +*** + +### tCommon + +> **tCommon**: `TFunction`\<`"common"`\> + +Defined in: [src/screens/ManageTag/EditUserTagModal.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/EditUserTagModal.tsx#L18) diff --git a/docs/docs/auto-docs/screens/ManageTag/ManageTag/functions/default.md b/docs/docs/auto-docs/screens/ManageTag/ManageTag/functions/default.md new file mode 100644 index 0000000000..b34af6d620 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/ManageTag/functions/default.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/ManageTag/ManageTag.tsx:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/ManageTag.tsx#L46) + +Component that renders the Manage Tag screen when the app navigates to '/orgtags/:orgId/manageTag/:tagId'. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/ManageTag/ManageTagMockComponents/MockAddPeopleToTag/functions/default.md b/docs/docs/auto-docs/screens/ManageTag/ManageTagMockComponents/MockAddPeopleToTag/functions/default.md new file mode 100644 index 0000000000..e49d664d47 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/ManageTagMockComponents/MockAddPeopleToTag/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/ManageTag/ManageTagMockComponents/MockAddPeopleToTag.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/ManageTagMockComponents/MockAddPeopleToTag.tsx#L12) + +## Parameters + +### props + +[`InterfaceAddPeopleToTagProps`](../../../../../components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/ManageTag/ManageTagMockComponents/MockTagActions/functions/default.md b/docs/docs/auto-docs/screens/ManageTag/ManageTagMockComponents/MockTagActions/functions/default.md new file mode 100644 index 0000000000..74dbf6b079 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/ManageTagMockComponents/MockTagActions/functions/default.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/ManageTag/ManageTagMockComponents/MockTagActions.tsx:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/ManageTagMockComponents/MockTagActions.tsx#L8) + +Component that mocks the TagActions component for the Manage Tag screen. + +## Parameters + +### props + +[`InterfaceTagActionsProps`](../../../../../components/TagActions/TagActions/interfaces/InterfaceTagActionsProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/ManageTag/ManageTagMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/ManageTag/ManageTagMocks/variables/MOCKS.md new file mode 100644 index 0000000000..ab93dee542 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/ManageTagMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `number`; `id`: `string`; `name`: `undefined`; `sortedBy`: \{ `id`: `string`; \}; `tagId`: `undefined`; `userId`: `undefined`; `where`: \{ `firstName`: \{ `starts_with`: `string`; \}; `lastName`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `getAssignedUsers`: \{ `ancestorTags`: `any`[]; `name`: `string`; `usersAssignedTo`: \{ `edges`: `object`[]; `pageInfo`: \{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \}; `totalCount`: `number`; \}; \}; `removeUserTag`: `undefined`; `unassignUserTag`: `undefined`; `updateUserTag`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `string`; `first`: `number`; `id`: `string`; `name`: `undefined`; `sortedBy`: \{ `id`: `string`; \}; `tagId`: `undefined`; `userId`: `undefined`; `where`: \{ `firstName`: \{ `starts_with`: `string`; \}; `lastName`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `getAssignedUsers`: \{ `ancestorTags`: `any`[]; `name`: `string`; `usersAssignedTo`: \{ `edges`: `object`[]; `pageInfo`: \{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \}; `totalCount`: `number`; \}; \}; `removeUserTag`: `undefined`; `unassignUserTag`: `undefined`; `updateUserTag`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `undefined`; `id`: `undefined`; `name`: `undefined`; `sortedBy`: `undefined`; `tagId`: `string`; `userId`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getAssignedUsers`: `undefined`; `removeUserTag`: `undefined`; `unassignUserTag`: \{ `_id`: `string`; \}; `updateUserTag`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `undefined`; `id`: `undefined`; `name`: `string`; `sortedBy`: `undefined`; `tagId`: `string`; `userId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getAssignedUsers`: `undefined`; `removeUserTag`: `undefined`; `unassignUserTag`: `undefined`; `updateUserTag`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `undefined`; `id`: `string`; `name`: `undefined`; `sortedBy`: `undefined`; `tagId`: `undefined`; `userId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getAssignedUsers`: `undefined`; `removeUserTag`: \{ `_id`: `string`; \}; `unassignUserTag`: `undefined`; `updateUserTag`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/ManageTag/ManageTagMocks.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/ManageTagMocks.ts#L9) diff --git a/docs/docs/auto-docs/screens/ManageTag/ManageTagMocks/variables/MOCKS_ERROR_ASSIGNED_MEMBERS.md b/docs/docs/auto-docs/screens/ManageTag/ManageTagMocks/variables/MOCKS_ERROR_ASSIGNED_MEMBERS.md new file mode 100644 index 0000000000..14349cd676 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/ManageTagMocks/variables/MOCKS_ERROR_ASSIGNED_MEMBERS.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_ASSIGNED\_MEMBERS + +> `const` **MOCKS\_ERROR\_ASSIGNED\_MEMBERS**: `object`[] + +Defined in: [src/screens/ManageTag/ManageTagMocks.ts:320](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/ManageTagMocks.ts#L320) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `USER_TAGS_ASSIGNED_MEMBERS` + +#### request.variables + +> **variables**: `object` + +#### request.variables.first + +> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` + +#### request.variables.id + +> **id**: `string` = `'1'` + +#### request.variables.sortedBy + +> **sortedBy**: `object` + +#### request.variables.sortedBy.id + +> **id**: `string` = `'DESCENDING'` + +#### 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` = `''` diff --git a/docs/docs/auto-docs/screens/ManageTag/RemoveUserTagModal/functions/default.md b/docs/docs/auto-docs/screens/ManageTag/RemoveUserTagModal/functions/default.md new file mode 100644 index 0000000000..63b8f0004f --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/RemoveUserTagModal/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/ManageTag/RemoveUserTagModal.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/RemoveUserTagModal.tsx#L18) + +## Parameters + +### props + +[`InterfaceRemoveUserTagModalProps`](../interfaces/InterfaceRemoveUserTagModalProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/ManageTag/RemoveUserTagModal/interfaces/InterfaceRemoveUserTagModalProps.md b/docs/docs/auto-docs/screens/ManageTag/RemoveUserTagModal/interfaces/InterfaceRemoveUserTagModalProps.md new file mode 100644 index 0000000000..79866c68f3 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/RemoveUserTagModal/interfaces/InterfaceRemoveUserTagModalProps.md @@ -0,0 +1,57 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceRemoveUserTagModalProps + +Defined in: [src/screens/ManageTag/RemoveUserTagModal.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/RemoveUserTagModal.tsx#L10) + +Remove UserTag Modal component for the Manage Tag screen. + +## Properties + +### handleRemoveUserTag() + +> **handleRemoveUserTag**: () => `Promise`\<`void`\> + +Defined in: [src/screens/ManageTag/RemoveUserTagModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/RemoveUserTagModal.tsx#L13) + +#### Returns + +`Promise`\<`void`\> + +*** + +### removeUserTagModalIsOpen + +> **removeUserTagModalIsOpen**: `boolean` + +Defined in: [src/screens/ManageTag/RemoveUserTagModal.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/RemoveUserTagModal.tsx#L11) + +*** + +### t + +> **t**: `TFunction`\<`"manageTag"`\> + +Defined in: [src/screens/ManageTag/RemoveUserTagModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/RemoveUserTagModal.tsx#L14) + +*** + +### tCommon + +> **tCommon**: `TFunction`\<`"common"`\> + +Defined in: [src/screens/ManageTag/RemoveUserTagModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/RemoveUserTagModal.tsx#L15) + +*** + +### toggleRemoveUserTagModal() + +> **toggleRemoveUserTagModal**: () => `void` + +Defined in: [src/screens/ManageTag/RemoveUserTagModal.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/RemoveUserTagModal.tsx#L12) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/ManageTag/UnassignUserTagModal/functions/default.md b/docs/docs/auto-docs/screens/ManageTag/UnassignUserTagModal/functions/default.md new file mode 100644 index 0000000000..4805927f5a --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/UnassignUserTagModal/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/ManageTag/UnassignUserTagModal.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/UnassignUserTagModal.tsx#L17) + +## Parameters + +### props + +[`InterfaceUnassignUserTagModalProps`](../interfaces/InterfaceUnassignUserTagModalProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/ManageTag/UnassignUserTagModal/interfaces/InterfaceUnassignUserTagModalProps.md b/docs/docs/auto-docs/screens/ManageTag/UnassignUserTagModal/interfaces/InterfaceUnassignUserTagModalProps.md new file mode 100644 index 0000000000..4ba03339d9 --- /dev/null +++ b/docs/docs/auto-docs/screens/ManageTag/UnassignUserTagModal/interfaces/InterfaceUnassignUserTagModalProps.md @@ -0,0 +1,57 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUnassignUserTagModalProps + +Defined in: [src/screens/ManageTag/UnassignUserTagModal.tsx:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/UnassignUserTagModal.tsx#L9) + +Unassign UserTag Modal component for the Manage Tag screen. + +## Properties + +### handleUnassignUserTag() + +> **handleUnassignUserTag**: () => `Promise`\<`void`\> + +Defined in: [src/screens/ManageTag/UnassignUserTagModal.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/UnassignUserTagModal.tsx#L12) + +#### Returns + +`Promise`\<`void`\> + +*** + +### t + +> **t**: `TFunction`\<`"manageTag"` \| `"memberDetail"`\> + +Defined in: [src/screens/ManageTag/UnassignUserTagModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/UnassignUserTagModal.tsx#L13) + +*** + +### tCommon + +> **tCommon**: `TFunction`\<`"common"`\> + +Defined in: [src/screens/ManageTag/UnassignUserTagModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/UnassignUserTagModal.tsx#L14) + +*** + +### toggleUnassignUserTagModal() + +> **toggleUnassignUserTagModal**: () => `void` + +Defined in: [src/screens/ManageTag/UnassignUserTagModal.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/UnassignUserTagModal.tsx#L11) + +#### Returns + +`void` + +*** + +### unassignUserTagModalIsOpen + +> **unassignUserTagModalIsOpen**: `boolean` + +Defined in: [src/screens/ManageTag/UnassignUserTagModal.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/ManageTag/UnassignUserTagModal.tsx#L10) diff --git a/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/default.md b/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/default.md new file mode 100644 index 0000000000..c0ec7f585a --- /dev/null +++ b/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/default.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/MemberDetail/MemberDetail.tsx:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/MemberDetail/MemberDetail.tsx#L51) + +MemberDetail component is used to display the details of a user. +It also allows the user to update the details. It uses the UPDATE_USER_MUTATION to update the user details. +It uses the USER_DETAILS query to get the user details. It uses the useLocalStorage hook to store the user + details in the local storage. + +## Parameters + +### props + +`MemberDetailProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +React component diff --git a/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/getLanguageName.md b/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/getLanguageName.md new file mode 100644 index 0000000000..930993b757 --- /dev/null +++ b/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/getLanguageName.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: getLanguageName() + +> **getLanguageName**(`code`): `string` + +Defined in: [src/screens/MemberDetail/MemberDetail.tsx:752](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/MemberDetail/MemberDetail.tsx#L752) + +## Parameters + +### code + +`string` + +## Returns + +`string` diff --git a/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/prettyDate.md b/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/prettyDate.md new file mode 100644 index 0000000000..a6b2c6e8a8 --- /dev/null +++ b/docs/docs/auto-docs/screens/MemberDetail/MemberDetail/functions/prettyDate.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: prettyDate() + +> **prettyDate**(`param`): `string` + +Defined in: [src/screens/MemberDetail/MemberDetail.tsx:742](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/MemberDetail/MemberDetail.tsx#L742) + +## Parameters + +### param + +`string` + +## Returns + +`string` diff --git a/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS1.md b/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS1.md new file mode 100644 index 0000000000..2a936c232e --- /dev/null +++ b/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS1.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS1 + +> `const` **MOCKS1**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `number`; `id`: `string`; `tagId`: `undefined`; `userId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `unassignUserTag`: `undefined`; `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `object`[]; `appLanguageCode`: `string`; `createdEvents`: `object`[]; `createdOrganizations`: `object`[]; `eventAdmin`: `object`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `string`; `createdAt`: `string`; `educationGrade`: `string`; `email`: `string`; `employmentStatus`: `string`; `eventsAttended`: `any`[]; `firstName`: `string`; `gender`: `string`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `string`; `membershipRequests`: `any`[]; `organizationsBlockedBy`: `any`[]; `phone`: \{ `mobile`: `string`; \}; `registeredEvents`: `object`[]; `tagsAssignedWith`: \{ `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`; `userId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `unassignUserTag`: `undefined`; `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `object`[]; `appLanguageCode`: `string`; `createdEvents`: `object`[]; `createdOrganizations`: `object`[]; `eventAdmin`: `object`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `string`; `createdAt`: `string`; `educationGrade`: `string`; `email`: `string`; `employmentStatus`: `string`; `eventsAttended`: `any`[]; `firstName`: `string`; `gender`: `string`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `string`; `membershipRequests`: `any`[]; `organizationsBlockedBy`: `any`[]; `phone`: \{ `mobile`: `string`; \}; `registeredEvents`: `object`[]; `tagsAssignedWith`: \{ `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`; `userId`: `string`; \}; \}; `result`: \{ `data`: \{ `unassignUserTag`: \{ `_id`: `string`; \}; `user`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/MemberDetail/MemberDetailMocks.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/MemberDetail/MemberDetailMocks.ts#L5) diff --git a/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS2.md b/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS2.md new file mode 100644 index 0000000000..6a6071e94a --- /dev/null +++ b/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS2.md @@ -0,0 +1,219 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS2 + +> `const` **MOCKS2**: `object`[] + +Defined in: [src/screens/MemberDetail/MemberDetailMocks.ts:337](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/MemberDetail/MemberDetailMocks.ts#L337) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `USER_DETAILS` + +#### request.variables + +> **variables**: `object` + +#### request.variables.first + +> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` + +#### request.variables.id + +> **id**: `string` = `'rishav-jha-mech'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.user + +> **user**: `object` + +#### result.data.user.\_\_typename + +> **\_\_typename**: `string` = `'UserData'` + +#### result.data.user.appUserProfile + +> **appUserProfile**: `object` + +#### result.data.user.appUserProfile.\_\_typename + +> **\_\_typename**: `string` = `'AppUserProfile'` + +#### result.data.user.appUserProfile.\_id + +> **\_id**: `string` = `'1'` + +#### result.data.user.appUserProfile.adminFor + +> **adminFor**: `any`[] = `[]` + +#### result.data.user.appUserProfile.appLanguageCode + +> **appLanguageCode**: `string` = `'en'` + +#### result.data.user.appUserProfile.createdEvents + +> **createdEvents**: `object`[] + +#### result.data.user.appUserProfile.createdOrganizations + +> **createdOrganizations**: `object`[] + +#### result.data.user.appUserProfile.eventAdmin + +> **eventAdmin**: `object`[] + +#### result.data.user.appUserProfile.isSuperAdmin + +> **isSuperAdmin**: `boolean` = `false` + +#### result.data.user.appUserProfile.pluginCreationAllowed + +> **pluginCreationAllowed**: `boolean` = `true` + +#### result.data.user.user + +> **user**: `object` + +#### result.data.user.user.\_\_typename + +> **\_\_typename**: `string` = `'User'` + +#### result.data.user.user.\_id + +> **\_id**: `string` = `'1'` + +#### result.data.user.user.address + +> **address**: `object` + +#### result.data.user.user.address.city + +> **city**: `string` = `''` + +#### result.data.user.user.address.countryCode + +> **countryCode**: `string` = `''` + +#### result.data.user.user.address.line1 + +> **line1**: `string` = `''` + +#### result.data.user.user.address.state + +> **state**: `string` = `''` + +#### result.data.user.user.birthDate + +> **birthDate**: `string` = `'2024-03-14'` + +#### result.data.user.user.createdAt + +> **createdAt**: `string` = `'2024-02-26T10:36:33.098Z'` + +#### result.data.user.user.educationGrade + +> **educationGrade**: `string` = `''` + +#### result.data.user.user.email + +> **email**: `string` = `'adi790u@gmail.com'` + +#### result.data.user.user.employmentStatus + +> **employmentStatus**: `string` = `''` + +#### result.data.user.user.eventsAttended + +> **eventsAttended**: `object`[] + +#### result.data.user.user.firstName + +> **firstName**: `string` = `'Aditya'` + +#### result.data.user.user.gender + +> **gender**: `string` = `''` + +#### result.data.user.user.image + +> **image**: `string` = `'https://placeholder.com/200x200'` + +#### result.data.user.user.joinedOrganizations + +> **joinedOrganizations**: `object`[] + +#### result.data.user.user.lastName + +> **lastName**: `string` = `'Agarwal'` + +#### result.data.user.user.maritalStatus + +> **maritalStatus**: `string` = `''` + +#### result.data.user.user.membershipRequests + +> **membershipRequests**: `any`[] = `[]` + +#### result.data.user.user.organizationsBlockedBy + +> **organizationsBlockedBy**: `any`[] = `[]` + +#### result.data.user.user.phone + +> **phone**: `object` + +#### result.data.user.user.phone.mobile + +> **mobile**: `string` = `''` + +#### result.data.user.user.registeredEvents + +> **registeredEvents**: `object`[] + +#### result.data.user.user.tagsAssignedWith + +> **tagsAssignedWith**: `object` + +#### result.data.user.user.tagsAssignedWith.edges + +> **edges**: `any`[] = `[]` + +#### result.data.user.user.tagsAssignedWith.pageInfo + +> **pageInfo**: `object` + +#### result.data.user.user.tagsAssignedWith.pageInfo.endCursor + +> **endCursor**: `any` = `null` + +#### result.data.user.user.tagsAssignedWith.pageInfo.hasNextPage + +> **hasNextPage**: `boolean` = `false` + +#### result.data.user.user.tagsAssignedWith.pageInfo.hasPreviousPage + +> **hasPreviousPage**: `boolean` = `false` + +#### result.data.user.user.tagsAssignedWith.pageInfo.startCursor + +> **startCursor**: `any` = `null` + +#### result.data.user.user.tagsAssignedWith.totalCount + +> **totalCount**: `number` = `0` diff --git a/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS3.md b/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS3.md new file mode 100644 index 0000000000..5e49f12393 --- /dev/null +++ b/docs/docs/auto-docs/screens/MemberDetail/MemberDetailMocks/variables/MOCKS3.md @@ -0,0 +1,219 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS3 + +> `const` **MOCKS3**: `object`[] + +Defined in: [src/screens/MemberDetail/MemberDetailMocks.ts:437](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/MemberDetail/MemberDetailMocks.ts#L437) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `USER_DETAILS` + +#### request.variables + +> **variables**: `object` + +#### request.variables.first + +> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` + +#### request.variables.id + +> **id**: `string` = `'rishav-jha-mech'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.user + +> **user**: `object` + +#### result.data.user.\_\_typename + +> **\_\_typename**: `string` = `'UserData'` + +#### result.data.user.appUserProfile + +> **appUserProfile**: `object` + +#### result.data.user.appUserProfile.\_\_typename + +> **\_\_typename**: `string` = `'AppUserProfile'` + +#### result.data.user.appUserProfile.\_id + +> **\_id**: `string` = `'1'` + +#### result.data.user.appUserProfile.adminFor + +> **adminFor**: `any`[] = `[]` + +#### result.data.user.appUserProfile.appLanguageCode + +> **appLanguageCode**: `string` = `'en'` + +#### result.data.user.appUserProfile.createdEvents + +> **createdEvents**: `object`[] + +#### result.data.user.appUserProfile.createdOrganizations + +> **createdOrganizations**: `object`[] + +#### result.data.user.appUserProfile.eventAdmin + +> **eventAdmin**: `object`[] + +#### result.data.user.appUserProfile.isSuperAdmin + +> **isSuperAdmin**: `boolean` = `true` + +#### result.data.user.appUserProfile.pluginCreationAllowed + +> **pluginCreationAllowed**: `boolean` = `true` + +#### result.data.user.user + +> **user**: `object` + +#### result.data.user.user.\_\_typename + +> **\_\_typename**: `string` = `'User'` + +#### result.data.user.user.\_id + +> **\_id**: `string` = `'1'` + +#### result.data.user.user.address + +> **address**: `object` + +#### result.data.user.user.address.city + +> **city**: `string` = `''` + +#### result.data.user.user.address.countryCode + +> **countryCode**: `string` = `''` + +#### result.data.user.user.address.line1 + +> **line1**: `string` = `''` + +#### result.data.user.user.address.state + +> **state**: `string` = `''` + +#### result.data.user.user.birthDate + +> **birthDate**: `string` = `'2024-03-14'` + +#### result.data.user.user.createdAt + +> **createdAt**: `string` = `'2024-02-26T10:36:33.098Z'` + +#### result.data.user.user.educationGrade + +> **educationGrade**: `string` = `''` + +#### result.data.user.user.email + +> **email**: `string` = `'adi790u@gmail.com'` + +#### result.data.user.user.employmentStatus + +> **employmentStatus**: `string` = `''` + +#### result.data.user.user.eventsAttended + +> **eventsAttended**: `any`[] = `[]` + +#### result.data.user.user.firstName + +> **firstName**: `string` = `'Aditya'` + +#### result.data.user.user.gender + +> **gender**: `string` = `''` + +#### result.data.user.user.image + +> **image**: `string` = `'https://placeholder.com/200x200'` + +#### result.data.user.user.joinedOrganizations + +> **joinedOrganizations**: `object`[] + +#### result.data.user.user.lastName + +> **lastName**: `string` = `'Agarwal'` + +#### result.data.user.user.maritalStatus + +> **maritalStatus**: `string` = `''` + +#### result.data.user.user.membershipRequests + +> **membershipRequests**: `any`[] = `[]` + +#### result.data.user.user.organizationsBlockedBy + +> **organizationsBlockedBy**: `any`[] = `[]` + +#### result.data.user.user.phone + +> **phone**: `object` + +#### result.data.user.user.phone.mobile + +> **mobile**: `string` = `''` + +#### result.data.user.user.registeredEvents + +> **registeredEvents**: `object`[] + +#### result.data.user.user.tagsAssignedWith + +> **tagsAssignedWith**: `object` + +#### result.data.user.user.tagsAssignedWith.edges + +> **edges**: `any`[] = `[]` + +#### result.data.user.user.tagsAssignedWith.pageInfo + +> **pageInfo**: `object` + +#### result.data.user.user.tagsAssignedWith.pageInfo.endCursor + +> **endCursor**: `any` = `null` + +#### result.data.user.user.tagsAssignedWith.pageInfo.hasNextPage + +> **hasNextPage**: `boolean` = `false` + +#### result.data.user.user.tagsAssignedWith.pageInfo.hasPreviousPage + +> **hasPreviousPage**: `boolean` = `false` + +#### result.data.user.user.tagsAssignedWith.pageInfo.startCursor + +> **startCursor**: `any` = `null` + +#### result.data.user.user.tagsAssignedWith.totalCount + +> **totalCount**: `number` = `0` diff --git a/docs/docs/auto-docs/screens/OrgContribution/OrgContribution/functions/default.md b/docs/docs/auto-docs/screens/OrgContribution/OrgContribution/functions/default.md new file mode 100644 index 0000000000..4ba54de949 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgContribution/OrgContribution/functions/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrgContribution/OrgContribution.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgContribution/OrgContribution.tsx#L16) + +The `orgContribution` component displays the contributions to an organization. +It includes a sidebar for filtering contributions by organization name and transaction ID. +Additionally, it shows recent contribution statistics and a list of contribution cards. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/OrgList/OrgList/functions/default.md b/docs/docs/auto-docs/screens/OrgList/OrgList/functions/default.md new file mode 100644 index 0000000000..13e7029f51 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgList/OrgList/functions/default.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrgList/OrgList.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgList/OrgList.tsx#L33) + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS.md new file mode 100644 index 0000000000..da27cdd462 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `notifyOnNetworkStatusChange`: `boolean`; `query`: `DocumentNode`; `variables`: \{ `address`: `undefined`; `description`: `undefined`; `filter`: `string`; `first`: `number`; `image`: `undefined`; `name`: `undefined`; `orderBy`: `string`; `skip`: `number`; `userId`: `undefined`; `userRegistrationRequired`: `undefined`; `visibleInSearch`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createOrganization`: `undefined`; `createSampleOrganization`: `undefined`; `organizationsConnection`: [`InterfaceOrgConnectionInfoType`](../../../../utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md)[]; `user`: `undefined`; \}; \}; \} \| \{ `request`: \{ `notifyOnNetworkStatusChange`: `undefined`; `query`: `DocumentNode`; `variables`: \{ `address`: `undefined`; `description`: `undefined`; `filter`: `undefined`; `first`: `undefined`; `image`: `undefined`; `name`: `undefined`; `orderBy`: `undefined`; `skip`: `undefined`; `userId`: `string`; `userRegistrationRequired`: `undefined`; `visibleInSearch`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createOrganization`: `undefined`; `createSampleOrganization`: `undefined`; `organizationsConnection`: `undefined`; `user`: [`InterfaceUserType`](../../../../utils/interfaces/interfaces/InterfaceUserType.md); \}; \}; \} \| \{ `request`: \{ `notifyOnNetworkStatusChange`: `undefined`; `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `createOrganization`: `undefined`; `createSampleOrganization`: \{ `id`: `string`; `name`: `string`; \}; `organizationsConnection`: `undefined`; `user`: `undefined`; \}; \}; \} \| \{ `request`: \{ `notifyOnNetworkStatusChange`: `undefined`; `query`: `DocumentNode`; `variables`: \{ `address`: \{ `city`: `string`; `countryCode`: `string`; `dependentLocality`: `string`; `line1`: `string`; `line2`: `string`; `postalCode`: `string`; `sortingCode`: `string`; `state`: `string`; \}; `description`: `string`; `filter`: `undefined`; `first`: `undefined`; `image`: `string`; `name`: `string`; `orderBy`: `undefined`; `skip`: `undefined`; `userId`: `undefined`; `userRegistrationRequired`: `boolean`; `visibleInSearch`: `boolean`; \}; \}; `result`: \{ `data`: \{ `createOrganization`: \{ `_id`: `string`; \}; `createSampleOrganization`: `undefined`; `organizationsConnection`: `undefined`; `user`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrgList/OrgListMocks.ts:94](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgList/OrgListMocks.ts#L94) diff --git a/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_ADMIN.md b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_ADMIN.md new file mode 100644 index 0000000000..f8f1543978 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_ADMIN.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ADMIN + +> `const` **MOCKS\_ADMIN**: (\{ `request`: \{ `notifyOnNetworkStatusChange`: `boolean`; `query`: `DocumentNode`; `variables`: \{ `filter`: `string`; `first`: `number`; `orderBy`: `string`; `skip`: `number`; `userId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: [`InterfaceOrgConnectionInfoType`](../../../../utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md)[]; `user`: `undefined`; \}; \}; \} \| \{ `request`: \{ `notifyOnNetworkStatusChange`: `undefined`; `query`: `DocumentNode`; `variables`: \{ `filter`: `undefined`; `first`: `undefined`; `orderBy`: `undefined`; `skip`: `undefined`; `userId`: `string`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `user`: [`InterfaceUserType`](../../../../utils/interfaces/interfaces/InterfaceUserType.md); \}; \}; \})[] + +Defined in: [src/screens/OrgList/OrgListMocks.ts:228](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgList/OrgListMocks.ts#L228) diff --git a/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_EMPTY.md b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_EMPTY.md new file mode 100644 index 0000000000..4995a65f29 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_EMPTY.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_EMPTY + +> `const` **MOCKS\_EMPTY**: (\{ `request`: \{ `notifyOnNetworkStatusChange`: `boolean`; `query`: `DocumentNode`; `variables`: \{ `filter`: `string`; `first`: `number`; `orderBy`: `string`; `skip`: `number`; `userId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `any`[]; `user`: `undefined`; \}; \}; \} \| \{ `request`: \{ `notifyOnNetworkStatusChange`: `undefined`; `query`: `DocumentNode`; `variables`: \{ `filter`: `undefined`; `first`: `undefined`; `orderBy`: `undefined`; `skip`: `undefined`; `userId`: `string`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `user`: [`InterfaceUserType`](../../../../utils/interfaces/interfaces/InterfaceUserType.md); \}; \}; \})[] + +Defined in: [src/screens/OrgList/OrgListMocks.ts:164](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgList/OrgListMocks.ts#L164) diff --git a/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_WITH_ERROR.md b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_WITH_ERROR.md new file mode 100644 index 0000000000..3ad91550d8 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgList/OrgListMocks/variables/MOCKS_WITH_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_WITH\_ERROR + +> `const` **MOCKS\_WITH\_ERROR**: (\{ `error`: `undefined`; `request`: \{ `notifyOnNetworkStatusChange`: `boolean`; `query`: `DocumentNode`; `variables`: \{ `filter`: `string`; `first`: `number`; `orderBy`: `string`; `skip`: `number`; `userId`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: [`InterfaceOrgConnectionInfoType`](../../../../utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md)[]; `user`: `undefined`; \}; \}; \} \| \{ `error`: `undefined`; `request`: \{ `notifyOnNetworkStatusChange`: `undefined`; `query`: `DocumentNode`; `variables`: \{ `filter`: `undefined`; `first`: `undefined`; `orderBy`: `undefined`; `skip`: `undefined`; `userId`: `string`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `user`: [`InterfaceUserType`](../../../../utils/interfaces/interfaces/InterfaceUserType.md); \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `notifyOnNetworkStatusChange`: `undefined`; `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: `undefined`; \})[] + +Defined in: [src/screens/OrgList/OrgListMocks.ts:192](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgList/OrgListMocks.ts#L192) diff --git a/docs/docs/auto-docs/screens/OrgList/OrganizationModal/functions/default.md b/docs/docs/auto-docs/screens/OrgList/OrganizationModal/functions/default.md new file mode 100644 index 0000000000..63cbf0e135 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgList/OrganizationModal/functions/default.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/OrgList/OrganizationModal.tsx:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgList/OrganizationModal.tsx#L55) + +Represents the organization modal component. + +## Parameters + +### props + +`InterfaceOrganizationModalProps` + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/OrgPost/OrgPost/functions/default.md b/docs/docs/auto-docs/screens/OrgPost/OrgPost/functions/default.md new file mode 100644 index 0000000000..faeef61d83 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgPost/OrgPost/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrgPost/OrgPost.tsx:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgPost/OrgPost.tsx#L51) + +This function is used to display the posts of the organization. It displays the posts in a card format. +It also provides the functionality to create a new post. The user can also sort the posts based on the date of creation. +The user can also search for a post based on the title of the post. + +## Returns + +`JSX.Element` + +JSX.Element which contains the posts of the organization. diff --git a/docs/docs/auto-docs/screens/OrgSettings/OrgSettings.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrgSettings/OrgSettings.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..b43b87c04d --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgSettings/OrgSettings.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `customFieldsByOrganizationId`: `undefined`; `id`: `string`; `isSampleOrganizationId`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `undefined`; `agendaItemCategoriesByOrganization`: `undefined`; `customFieldsByOrganization`: `undefined`; `isSampleOrganization`: `undefined`; `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `customFieldsByOrganizationId`: `string`; `id`: `undefined`; `isSampleOrganizationId`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `undefined`; `agendaItemCategoriesByOrganization`: `undefined`; `customFieldsByOrganization`: `object`[]; `isSampleOrganization`: `undefined`; `organizations`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `customFieldsByOrganizationId`: `undefined`; `id`: `undefined`; `isSampleOrganizationId`: `string`; `orderBy`: `undefined`; `organizationId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `undefined`; `agendaItemCategoriesByOrganization`: `undefined`; `customFieldsByOrganization`: `undefined`; `isSampleOrganization`: `boolean`; `organizations`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `customFieldsByOrganizationId`: `undefined`; `id`: `undefined`; `isSampleOrganizationId`: `undefined`; `orderBy`: `undefined`; `organizationId`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `undefined`; `agendaItemCategoriesByOrganization`: `any`[]; `customFieldsByOrganization`: `undefined`; `isSampleOrganization`: `undefined`; `organizations`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `customFieldsByOrganizationId`: `undefined`; `id`: `undefined`; `isSampleOrganizationId`: `undefined`; `orderBy`: `string`; `organizationId`: `string`; `where`: \{ `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: `object`[]; `agendaItemCategoriesByOrganization`: `undefined`; `customFieldsByOrganization`: `undefined`; `isSampleOrganization`: `undefined`; `organizations`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrgSettings/OrgSettings.mocks.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgSettings/OrgSettings.mocks.ts#L9) diff --git a/docs/docs/auto-docs/screens/OrgSettings/OrgSettings/functions/default.md b/docs/docs/auto-docs/screens/OrgSettings/OrgSettings/functions/default.md new file mode 100644 index 0000000000..736554bd7b --- /dev/null +++ b/docs/docs/auto-docs/screens/OrgSettings/OrgSettings/functions/default.md @@ -0,0 +1,21 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrgSettings/OrgSettings.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrgSettings/OrgSettings.tsx#L29) + +The `orgSettings` component provides a user interface for managing various settings related to an organization. +It includes options for updating organization details, deleting the organization, changing language preferences, +and managing custom fields and action item categories. + +The component renders different settings sections based on the user's selection from the tabs or dropdown menu. + +## Returns + +`JSX.Element` + +The rendered component displaying the organization settings. diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemDeleteModal/functions/default.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemDeleteModal/functions/default.md new file mode 100644 index 0000000000..e690c25aeb --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemDeleteModal/functions/default.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/OrganizationActionItems/ItemDeleteModal.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemDeleteModal.tsx#L26) + +A modal component for confirming the deletion of an action item. + +## Parameters + +### props + +[`InterfaceItemDeleteModalProps`](../interfaces/InterfaceItemDeleteModalProps.md) + +The properties passed to the component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The `ItemDeleteModal` component. diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemDeleteModal/interfaces/InterfaceItemDeleteModalProps.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemDeleteModal/interfaces/InterfaceItemDeleteModalProps.md new file mode 100644 index 0000000000..4fd6cdec3c --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemDeleteModal/interfaces/InterfaceItemDeleteModalProps.md @@ -0,0 +1,49 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceItemDeleteModalProps + +Defined in: [src/screens/OrganizationActionItems/ItemDeleteModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemDeleteModal.tsx#L13) + +Props for the `ItemDeleteModal` component. + +## Properties + +### actionItem + +> **actionItem**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/ItemDeleteModal.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemDeleteModal.tsx#L16) + +*** + +### actionItemsRefetch() + +> **actionItemsRefetch**: () => `void` + +Defined in: [src/screens/OrganizationActionItems/ItemDeleteModal.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemDeleteModal.tsx#L17) + +#### Returns + +`void` + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/OrganizationActionItems/ItemDeleteModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemDeleteModal.tsx#L15) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/OrganizationActionItems/ItemDeleteModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemDeleteModal.tsx#L14) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemModal/functions/default.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemModal/functions/default.md new file mode 100644 index 0000000000..74565ec719 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemModal/functions/default.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:92](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L92) + +A modal component for creating action items. + +## Parameters + +### props + +[`InterfaceItemModalProps`](../interfaces/InterfaceItemModalProps.md) + +The properties passed to the component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The `ItemModal` component. diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemModal/interfaces/InterfaceItemModalProps.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemModal/interfaces/InterfaceItemModalProps.md new file mode 100644 index 0000000000..987fa9c51c --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemModal/interfaces/InterfaceItemModalProps.md @@ -0,0 +1,73 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceItemModalProps + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:52](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L52) + +Props for the `ItemModal` component. + +## Properties + +### actionItem + +> **actionItem**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L58) + +*** + +### actionItemsRefetch() + +> **actionItemsRefetch**: () => `void` + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:57](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L57) + +#### Returns + +`void` + +*** + +### editMode + +> **editMode**: `boolean` + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:59](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L59) + +*** + +### eventId + +> **eventId**: `string` + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:56](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L56) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:54](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L54) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:53](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L53) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/screens/OrganizationActionItems/ItemModal.tsx:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemModal.tsx#L55) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemUpdateStatusModal/functions/default.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemUpdateStatusModal/functions/default.md new file mode 100644 index 0000000000..f436d062fa --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemUpdateStatusModal/functions/default.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx#L18) + +## Parameters + +### props + +[`InterfaceItemUpdateStatusModalProps`](../interfaces/InterfaceItemUpdateStatusModalProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemUpdateStatusModal/interfaces/InterfaceItemUpdateStatusModalProps.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemUpdateStatusModal/interfaces/InterfaceItemUpdateStatusModalProps.md new file mode 100644 index 0000000000..08c858e989 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemUpdateStatusModal/interfaces/InterfaceItemUpdateStatusModalProps.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceItemUpdateStatusModalProps + +Defined in: [src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx#L11) + +## Properties + +### actionItem + +> **actionItem**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx#L15) + +*** + +### actionItemsRefetch() + +> **actionItemsRefetch**: () => `void` + +Defined in: [src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx#L14) + +#### Returns + +`void` + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx#L13) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemUpdateStatusModal.tsx#L12) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemViewModal/functions/default.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemViewModal/functions/default.md new file mode 100644 index 0000000000..746fd8600b --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemViewModal/functions/default.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/OrganizationActionItems/ItemViewModal.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemViewModal.tsx#L32) + +A modal dialog for viewing action item details. + +## Parameters + +### props + +[`InterfaceViewModalProps`](../interfaces/InterfaceViewModalProps.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `ItemViewModal` component displays all the fields of an action item in a modal dialog. +It includes fields for assignee, assigner, category, pre and post completion notes, assignment date, due date, completion date, and event. diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/ItemViewModal/interfaces/InterfaceViewModalProps.md b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemViewModal/interfaces/InterfaceViewModalProps.md new file mode 100644 index 0000000000..af01f51780 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/ItemViewModal/interfaces/InterfaceViewModalProps.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceViewModalProps + +Defined in: [src/screens/OrganizationActionItems/ItemViewModal.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemViewModal.tsx#L13) + +## Properties + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/OrganizationActionItems/ItemViewModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemViewModal.tsx#L15) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/OrganizationActionItems/ItemViewModal.tsx:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemViewModal.tsx#L14) + +*** + +### item + +> **item**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/ItemViewModal.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/ItemViewModal.tsx#L16) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..1461978416 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `organizationId`: `string`; `where`: \{ `is_disabled`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: (\{ `_id`: `string`; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \} \| \{ `_id`: `undefined`; `createdAt`: `string`; `creator`: \{ `_id`: `undefined`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `string`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: (\{ `_id`: `string`; `assignments`: `any`[]; `groups`: `object`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `groups`: `any`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `undefined`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `undefined`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: `any`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: (\{ `_id`: `string`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `object`[]; `volunteersRequired`: `number`; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `any`[]; `volunteersRequired`: `number`; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `actionItemId`: `undefined`; `allottedHours`: `undefined`; `assigneeId`: `undefined`; `assigneeType`: `undefined`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `string`; `isCompleted`: `undefined`; `orderBy`: `any`; `organizationId`: `string`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `undefined`; `where`: \{ `assigneeName`: `undefined`; `categoryName`: `string`; `is_completed`: `undefined`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md)[]; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `actionItemId`: `undefined`; `allottedHours`: `undefined`; `assigneeId`: `undefined`; `assigneeType`: `undefined`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `string`; `isCompleted`: `undefined`; `orderBy`: `string`; `organizationId`: `string`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `undefined`; `where`: \{ `assigneeName`: `string`; `categoryName`: `undefined`; `is_completed`: `undefined`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md)[]; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `actionItemId`: `undefined`; `allottedHours`: `undefined`; `assigneeId`: `undefined`; `assigneeType`: `undefined`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `string`; `isCompleted`: `undefined`; `orderBy`: `any`; `organizationId`: `string`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `undefined`; `where`: \{ `assigneeName`: `string`; `categoryName`: `undefined`; `is_completed`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md)[]; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `actionItemId`: `string`; `allottedHours`: `undefined`; `assigneeId`: `undefined`; `assigneeType`: `undefined`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: `undefined`; `removeActionItem`: \{ `_id`: `string`; \}; `updateActionItem`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `actionItemId`: `string`; `allottedHours`: `undefined`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `boolean`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `string`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `string`; `actionItemId`: `string`; `allottedHours`: `number`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `string`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `string`; `actionItemId`: `string`; `allottedHours`: `number`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `undefined`; `dueDate`: `string`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `undefined`; `actionItemId`: `string`; `allottedHours`: `undefined`; `assigneeId`: `string`; `assigneeType`: `undefined`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `boolean`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `string`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `string`; `actionItemId`: `string`; `allottedHours`: `number`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `undefined`; `dueDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: `undefined`; `removeActionItem`: `undefined`; `updateActionItem`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `string`; `actionItemId`: `undefined`; `allottedHours`: `number`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `string`; `dueDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: \{ `_id`: `string`; \}; `removeActionItem`: `undefined`; `updateActionItem`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemCategoryId`: `string`; `actionItemId`: `undefined`; `allottedHours`: `number`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `string`; `dueDate`: `undefined`; `eventId`: `string`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `undefined`; `createActionItem`: \{ `_id`: `string`; \}; `removeActionItem`: `undefined`; `updateActionItem`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationActionItems/OrganizationActionItem.mocks.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/OrganizationActionItem.mocks.ts#L21) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS_EMPTY.md b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS_EMPTY.md new file mode 100644 index 0000000000..e37a8343f3 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS_EMPTY.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_EMPTY + +> `const` **MOCKS\_EMPTY**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `organizationId`: `string`; `where`: \{ `is_disabled`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: (\{ `_id`: `string`; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \} \| \{ `_id`: `undefined`; `createdAt`: `string`; `creator`: \{ `_id`: `undefined`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `string`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: (\{ `_id`: `string`; `assignments`: `any`[]; `groups`: `object`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `groups`: `any`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `undefined`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `undefined`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: `any`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: (\{ `_id`: `string`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `object`[]; `volunteersRequired`: `number`; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `any`[]; `volunteersRequired`: `number`; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `eventId`: `string`; `orderBy`: `any`; `organizationId`: `string`; `where`: \{ `assigneeName`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemsByOrganization`: `any`[]; \}; \}; \})[] + +Defined in: [src/screens/OrganizationActionItems/OrganizationActionItem.mocks.ts:480](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/OrganizationActionItem.mocks.ts#L480) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..0e5b84de78 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItem.mocks/variables/MOCKS_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `organizationId`: `string`; `where`: \{ `is_disabled`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemCategoriesByOrganization`: (\{ `_id`: `string`; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \} \| \{ `_id`: `undefined`; `createdAt`: `string`; `creator`: \{ `_id`: `undefined`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `string`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: (\{ `_id`: `string`; `assignments`: `any`[]; `groups`: `object`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `groups`: `any`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `undefined`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `undefined`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: `any`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: (\{ `_id`: `string`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `object`[]; `volunteersRequired`: `number`; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `any`[]; `volunteersRequired`: `number`; \})[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemId`: `undefined`; `allottedHours`: `undefined`; `assigneeId`: `undefined`; `assigneeType`: `undefined`; `dDate`: `undefined`; `eventId`: `string`; `isCompleted`: `undefined`; `orderBy`: `any`; `organizationId`: `string`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `undefined`; `where`: \{ `assigneeName`: `string`; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemId`: `string`; `allottedHours`: `undefined`; `assigneeId`: `undefined`; `assigneeType`: `undefined`; `dDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemId`: `string`; `allottedHours`: `undefined`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `boolean`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `string`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemId`: `undefined`; `allottedHours`: `any`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `string`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `undefined`; `preCompletionNotes`: `string`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `actionItemId`: `string`; `allottedHours`: `undefined`; `assigneeId`: `string`; `assigneeType`: `string`; `dDate`: `undefined`; `eventId`: `undefined`; `isCompleted`: `undefined`; `orderBy`: `undefined`; `organizationId`: `undefined`; `postCompletionNotes`: `string`; `preCompletionNotes`: `undefined`; `where`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationActionItems/OrganizationActionItem.mocks.ts:412](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/OrganizationActionItem.mocks.ts#L412) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItems/functions/default.md b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItems/functions/default.md new file mode 100644 index 0000000000..b480cff007 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/OrganizationActionItems/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrganizationActionItems/OrganizationActionItems.tsx:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/OrganizationActionItems.tsx#L51) + +Component for managing and displaying action items within an organization. + +This component allows users to view, filter, sort, and create action items. It also handles fetching and displaying related data such as action item categories and members. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategory1.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategory1.md new file mode 100644 index 0000000000..928f04eb9e --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategory1.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: actionItemCategory1 + +> `const` **actionItemCategory1**: `object` + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L11) + +## Type declaration + +### \_id + +> **\_id**: `string` = `'actionItemCategoryId1'` + +### name + +> **name**: `string` = `'Category 1'` diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategory2.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategory2.md new file mode 100644 index 0000000000..89bc50c624 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategory2.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: actionItemCategory2 + +> `const` **actionItemCategory2**: `object` + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L16) + +## Type declaration + +### \_id + +> **\_id**: `string` = `'actionItemCategoryId2'` + +### name + +> **name**: `string` = `'Category 2'` diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategoryListQuery.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategoryListQuery.md new file mode 100644 index 0000000000..a336dffdf9 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/actionItemCategoryListQuery.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Variable: actionItemCategoryListQuery + +> `const` **actionItemCategoryListQuery**: `object` + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:408](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L408) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `ACTION_ITEM_CATEGORY_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.organizationId + +> **organizationId**: `string` = `'orgId'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.is\_disabled + +> **is\_disabled**: `boolean` = `false` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.actionItemCategoriesByOrganization + +> **actionItemCategoriesByOrganization**: (\{ `_id`: `string`; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \} \| \{ `_id`: `undefined`; `createdAt`: `string`; `creator`: \{ `_id`: `undefined`; `firstName`: `string`; `lastName`: `string`; \}; `isDisabled`: `boolean`; `name`: `string`; \})[] diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/baseActionItem.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/baseActionItem.md new file mode 100644 index 0000000000..84ae293c88 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/baseActionItem.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: baseActionItem + +> `const` **baseActionItem**: `object` + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L21) + +## Type declaration + +### assigner + +> **assigner**: `object` + +#### assigner.\_id + +> **\_id**: `string` = `'userId'` + +#### assigner.firstName + +> **firstName**: `string` = `'Wilt'` + +#### assigner.image + +> **image**: `any` = `null` + +#### assigner.lastName + +> **lastName**: `string` = `'Shepherd'` + +### creator + +> **creator**: `object` + +#### creator.\_\_typename + +> **\_\_typename**: `string` = `'User'` + +#### creator.\_id + +> **\_id**: `string` = `'userId'` + +#### creator.firstName + +> **firstName**: `string` = `'Wilt'` + +#### creator.image + +> **image**: `any` = `null` + +#### creator.lastName + +> **lastName**: `string` = `'Shepherd'` diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/groupListQuery.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/groupListQuery.md new file mode 100644 index 0000000000..eee0b1e887 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/groupListQuery.md @@ -0,0 +1,43 @@ +[Admin Docs](/) + +*** + +# Variable: groupListQuery + +> `const` **groupListQuery**: `object`[] + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:301](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L301) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_VOLUNTEER_GROUP_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.eventId + +> **eventId**: `string` = `'eventId'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getEventVolunteerGroups + +> **getEventVolunteerGroups**: (\{ `_id`: `string`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `object`[]; `volunteersRequired`: `number`; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `createdAt`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `description`: `string`; `event`: \{ `_id`: `string`; \}; `leader`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `name`: `string`; `volunteers`: `any`[]; `volunteersRequired`: `number`; \})[] diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithGroup.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithGroup.md new file mode 100644 index 0000000000..b102099edc --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithGroup.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: itemWithGroup + +> `const` **itemWithGroup**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:143](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L143) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithUser.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithUser.md new file mode 100644 index 0000000000..1bbf2c3400 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithUser.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: itemWithUser + +> `const` **itemWithUser**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:97](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L97) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithUserImage.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithUserImage.md new file mode 100644 index 0000000000..65fe3963fb --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithUserImage.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: itemWithUserImage + +> `const` **itemWithUserImage**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:120](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L120) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithVolunteer.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithVolunteer.md new file mode 100644 index 0000000000..c081871d6a --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithVolunteer.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: itemWithVolunteer + +> `const` **itemWithVolunteer**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L37) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithVolunteerImage.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithVolunteerImage.md new file mode 100644 index 0000000000..268b7b3b0c --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/itemWithVolunteerImage.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: itemWithVolunteerImage + +> `const` **itemWithVolunteerImage**: [`InterfaceActionItemInfo`](../../../../utils/interfaces/interfaces/InterfaceActionItemInfo.md) + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:67](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L67) diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/memberListQuery.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/memberListQuery.md new file mode 100644 index 0000000000..e7abd0ffaf --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/memberListQuery.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: memberListQuery + +> `const` **memberListQuery**: `object` + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:184](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L184) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `MEMBERS_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'orgId'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.organizations + +> **organizations**: `object`[] diff --git a/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/volunteerListQuery.md b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/volunteerListQuery.md new file mode 100644 index 0000000000..32f731f1c9 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationActionItems/testObject.mocks/variables/volunteerListQuery.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: volunteerListQuery + +> `const` **volunteerListQuery**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `string`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: (\{ `_id`: `string`; `assignments`: `any`[]; `groups`: `object`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \} \| \{ `_id`: `undefined`; `assignments`: `any`[]; `groups`: `any`[]; `hasAccepted`: `boolean`; `hoursVolunteered`: `number`; `user`: \{ `_id`: `undefined`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `where`: \{ `eventId`: `undefined`; `hasAccepted`: `boolean`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteers`: `any`[]; \}; \}; \})[] + +Defined in: [src/screens/OrganizationActionItems/testObject.mocks.ts:228](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationActionItems/testObject.mocks.ts#L228) diff --git a/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboard/functions/default.md b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboard/functions/default.md new file mode 100644 index 0000000000..3498185859 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboard/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrganizationDashboard/OrganizationDashboard.tsx:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationDashboard/OrganizationDashboard.tsx#L44) + +Component for displaying the organization dashboard. + +This component provides an overview of various statistics and information related to an organization, including members, admins, posts, events, blocked users, and membership requests. It also displays upcoming events and latest posts. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..fafab08170 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `string`; `organization_id`: `undefined`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `undefined`; `getVolunteerRanks`: `undefined`; `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `id`: `string`; `organization_id`: `undefined`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `undefined`; `getVolunteerRanks`: `undefined`; `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `organization_id`: `string`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `any`[]; `getVolunteerRanks`: `undefined`; `organizations`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `organization_id`: `undefined`; `orgId`: `string`; `where`: \{ `limit`: `number`; `orderBy`: `string`; `timeFrame`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `undefined`; `getVolunteerRanks`: `any`[]; `organizations`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts:329](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts#L329) diff --git a/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..62066bde8c --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/ERROR_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `string`; `organization_id`: `undefined`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `id`: `string`; `organization_id`: `undefined`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `organization_id`: `string`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `organization_id`: `undefined`; `orgId`: `string`; `where`: \{ `limit`: `number`; `orderBy`: `string`; `timeFrame`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts:448](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts#L448) diff --git a/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/MOCKS.md new file mode 100644 index 0000000000..6f6bd49c2e --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationDashboard/OrganizationDashboardMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `string`; `organization_id`: `undefined`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `undefined`; `getVolunteerRanks`: `undefined`; `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `id`: `string`; `organization_id`: `undefined`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `undefined`; `getVolunteerRanks`: `undefined`; `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `organization_id`: `string`; `orgId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `object`[]; `getVolunteerRanks`: `undefined`; `organizations`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `organization_id`: `undefined`; `orgId`: `string`; `where`: \{ `limit`: `number`; `orderBy`: `string`; `timeFrame`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `undefined`; `getVolunteerRanks`: `object`[]; `organizations`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationDashboard/OrganizationDashboardMocks.ts#L8) diff --git a/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEvents/enumerations/ViewType.md b/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEvents/enumerations/ViewType.md new file mode 100644 index 0000000000..bf60f28d2d --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEvents/enumerations/ViewType.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Enumeration: ViewType + +Defined in: [src/screens/OrganizationEvents/OrganizationEvents.tsx:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationEvents/OrganizationEvents.tsx#L37) + +## Enumeration Members + +### DAY + +> **DAY**: `"Day"` + +Defined in: [src/screens/OrganizationEvents/OrganizationEvents.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationEvents/OrganizationEvents.tsx#L38) + +*** + +### MONTH + +> **MONTH**: `"Month View"` + +Defined in: [src/screens/OrganizationEvents/OrganizationEvents.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationEvents/OrganizationEvents.tsx#L39) + +*** + +### YEAR + +> **YEAR**: `"Year View"` + +Defined in: [src/screens/OrganizationEvents/OrganizationEvents.tsx:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationEvents/OrganizationEvents.tsx#L40) diff --git a/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEvents/functions/default.md b/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEvents/functions/default.md new file mode 100644 index 0000000000..b1ea6f8d4d --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEvents/functions/default.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrganizationEvents/OrganizationEvents.tsx:56](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationEvents/OrganizationEvents.tsx#L56) + +Organization Events Page Component to display the events of an organization +and create new events for the organization by the admin or superadmin user. +The component uses the EventCalendar component to display the events and EventHeader component + to display the view type and create event button. + The component uses the RecurrenceOptions component to display the recurrence options for the event. + The component uses the CREATE_EVENT_MUTATION mutation to create a new event for the organization. + The component uses the ORGANIZATION_EVENT_CONNECTION_LIST and ORGANIZATIONS_LIST queries to fetch the events + and organization details. + The component uses the useLocalStorage hook to get the user details from the local storage. + +## Returns + +`JSX.Element` + +JSX.Element to display the Organization Events Page diff --git a/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEventsMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEventsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..c41fff8d1f --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationEvents/OrganizationEventsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `undefined`; `count`: `undefined`; `description`: `undefined`; `description_contains`: `string`; `endDate`: `undefined`; `endTime`: `undefined`; `frequency`: `undefined`; `interval`: `undefined`; `isPublic`: `undefined`; `isRegisterable`: `undefined`; `location`: `undefined`; `location_contains`: `string`; `organization_id`: `any`; `organizationId`: `undefined`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `undefined`; `startDate`: `undefined`; `startTime`: `undefined`; `title`: `undefined`; `title_contains`: `string`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEvent`: `undefined`; `eventsByOrganizationConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `undefined`; `count`: `undefined`; `description`: `undefined`; `description_contains`: `string`; `endDate`: `undefined`; `endTime`: `undefined`; `frequency`: `undefined`; `interval`: `undefined`; `isPublic`: `undefined`; `isRegisterable`: `undefined`; `location`: `undefined`; `location_contains`: `string`; `organization_id`: `any`; `organizationId`: `undefined`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `undefined`; `startDate`: `undefined`; `startTime`: `undefined`; `title`: `undefined`; `title_contains`: `string`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEvent`: `undefined`; `eventsByOrganizationConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `count`: `undefined`; `description`: `string`; `description_contains`: `undefined`; `endDate`: `string`; `endTime`: `undefined`; `frequency`: `undefined`; `interval`: `undefined`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `location_contains`: `undefined`; `organization_id`: `undefined`; `organizationId`: `any`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `boolean`; `startDate`: `string`; `startTime`: `undefined`; `title`: `string`; `title_contains`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEvent`: \{ `_id`: `string`; \}; `eventsByOrganizationConnection`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `count`: `undefined`; `description`: `string`; `description_contains`: `undefined`; `endDate`: `string`; `endTime`: `string`; `frequency`: `undefined`; `interval`: `undefined`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `location_contains`: `undefined`; `organization_id`: `undefined`; `organizationId`: `any`; `recurrenceEndDate`: `undefined`; `recurrenceStartDate`: `undefined`; `recurring`: `boolean`; `startDate`: `string`; `startTime`: `string`; `title`: `string`; `title_contains`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEvent`: \{ `_id`: `string`; \}; `eventsByOrganizationConnection`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `count`: `undefined`; `description`: `string`; `description_contains`: `undefined`; `endDate`: `string`; `endTime`: `string`; `frequency`: `string`; `interval`: `number`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `location_contains`: `undefined`; `organization_id`: `undefined`; `organizationId`: `any`; `recurrenceEndDate`: `any`; `recurrenceStartDate`: `string`; `recurring`: `boolean`; `startDate`: `string`; `startTime`: `string`; `title`: `string`; `title_contains`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEvent`: \{ `_id`: `string`; \}; `eventsByOrganizationConnection`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `count`: `undefined`; `description`: `string`; `description_contains`: `undefined`; `endDate`: `string`; `endTime`: `string`; `frequency`: `string`; `interval`: `number`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `location_contains`: `undefined`; `organization_id`: `undefined`; `organizationId`: `any`; `recurrenceEndDate`: `any`; `recurrenceStartDate`: `string`; `recurring`: `boolean`; `startDate`: `string`; `startTime`: `string`; `title`: `string`; `title_contains`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `string`[]; \}; \}; `result`: \{ `data`: \{ `createEvent`: \{ `_id`: `string`; \}; `eventsByOrganizationConnection`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `count`: `undefined`; `description`: `string`; `description_contains`: `undefined`; `endDate`: `string`; `endTime`: `undefined`; `frequency`: `string`; `interval`: `number`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `location_contains`: `undefined`; `organization_id`: `undefined`; `organizationId`: `any`; `recurrenceEndDate`: `string`; `recurrenceStartDate`: `string`; `recurring`: `boolean`; `startDate`: `string`; `startTime`: `undefined`; `title`: `string`; `title_contains`: `undefined`; `weekDayOccurenceInMonth`: `number`; `weekDays`: `string`[]; \}; \}; `result`: \{ `data`: \{ `createEvent`: \{ `_id`: `string`; \}; `eventsByOrganizationConnection`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `allDay`: `boolean`; `count`: `number`; `description`: `string`; `description_contains`: `undefined`; `endDate`: `string`; `endTime`: `undefined`; `frequency`: `string`; `interval`: `number`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `location_contains`: `undefined`; `organization_id`: `undefined`; `organizationId`: `any`; `recurrenceEndDate`: `any`; `recurrenceStartDate`: `string`; `recurring`: `boolean`; `startDate`: `string`; `startTime`: `undefined`; `title`: `string`; `title_contains`: `undefined`; `weekDayOccurenceInMonth`: `undefined`; `weekDays`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createEvent`: \{ `_id`: `string`; \}; `eventsByOrganizationConnection`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationEvents/OrganizationEventsMocks.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationEvents/OrganizationEventsMocks.ts#L4) diff --git a/docs/docs/auto-docs/screens/OrganizationFundCampaign/CampaignModal/functions/default.md b/docs/docs/auto-docs/screens/OrganizationFundCampaign/CampaignModal/functions/default.md new file mode 100644 index 0000000000..6e890be5f5 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFundCampaign/CampaignModal/functions/default.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L44) + +Modal component for creating or editing a campaign. + +## Parameters + +### props + +[`InterfaceCampaignModal`](../interfaces/InterfaceCampaignModal.md) + +The props for the CampaignModal component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +JSX.Element diff --git a/docs/docs/auto-docs/screens/OrganizationFundCampaign/CampaignModal/interfaces/InterfaceCampaignModal.md b/docs/docs/auto-docs/screens/OrganizationFundCampaign/CampaignModal/interfaces/InterfaceCampaignModal.md new file mode 100644 index 0000000000..a120c0490e --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFundCampaign/CampaignModal/interfaces/InterfaceCampaignModal.md @@ -0,0 +1,73 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCampaignModal + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L28) + +Props for the CampaignModal component. + +## Properties + +### campaign + +> **campaign**: [`InterfaceCampaignInfo`](../../../../utils/interfaces/interfaces/InterfaceCampaignInfo.md) + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L33) + +*** + +### fundId + +> **fundId**: `string` + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L31) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L30) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L29) + +*** + +### mode + +> **mode**: `"create"` \| `"edit"` + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L35) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L32) + +*** + +### refetchCampaign() + +> **refetchCampaign**: () => `void` + +Defined in: [src/screens/OrganizationFundCampaign/CampaignModal.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/CampaignModal.tsx#L34) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampagins/functions/default.md b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampagins/functions/default.md new file mode 100644 index 0000000000..c36def9939 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampagins/functions/default.md @@ -0,0 +1,43 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/OrganizationFundCampaign/OrganizationFundCampagins.tsx:78](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/OrganizationFundCampagins.tsx#L78) + +`orgFundCampaign` component displays a list of fundraising campaigns for a specific fund within an organization. +It allows users to search, sort, view and edit campaigns. + +### Functionality +- Displays a data grid with campaigns information, including their names, start and end dates, funding goals, and actions. +- Provides search functionality to filter campaigns by name. +- Offers sorting options based on funding goal and end date. +- Opens modals for creating or editing campaigns. + +### State +- `campaign`: The current campaign being edited or deleted. +- `searchTerm`: The term used for searching campaigns by name. +- `sortBy`: The current sorting criteria for campaigns. +- `modalState`: An object indicating the visibility of different modals (`same` for create/edit). +- `campaignModalMode`: Determines if the modal is in 'edit' or 'create' mode. + +### Methods +- `handleOpenModal(campaign: InterfaceCampaignInfo | null, mode: 'edit' | 'create')`: Opens the modal for creating or editing a campaign. +- `handleClick(campaignId: string)`: Navigates to the pledge details page for a specific campaign. + +### GraphQL Queries +- Uses `FUND_CAMPAIGN` query to fetch the list of campaigns based on the provided fund ID, search term, and sorting criteria. + +### Rendering +- Renders a `DataGrid` component with campaigns information. +- Displays modals for creating and editing campaigns. +- Shows error and loading states using `Loader` and error message components. + +## Returns + +`Element` + +The rendered component including breadcrumbs, search and filter controls, data grid, and modals. diff --git a/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..b88998609b --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: `object`[] + +Defined in: [src/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks.ts:300](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks.ts#L300) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `FUND_CAMPAIGN` + +#### request.variables + +> **variables**: `object` + +#### request.variables.id + +> **id**: `string` = `'fundId'` + +#### request.variables.orderBy + +> **orderBy**: `any` = `null` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.name\_contains + +> **name\_contains**: `string` = `''` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getFundById + +> **getFundById**: `object` + +#### result.data.getFundById.campaigns + +> **campaigns**: `any`[] = `[]` + +#### result.data.getFundById.isArchived + +> **isArchived**: `boolean` = `false` + +#### result.data.getFundById.name + +> **name**: `string` = `'Fund 1'` diff --git a/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/MOCKS.md new file mode 100644 index 0000000000..7b4e14b4fe --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `currency`: `undefined`; `endDate`: `undefined`; `fundId`: `undefined`; `fundingGoal`: `undefined`; `id`: `string`; `name`: `undefined`; `orderBy`: `string`; `organizationId`: `undefined`; `startDate`: `undefined`; `where`: \{ `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `createFundraisingCampaign`: `undefined`; `getFundById`: \{ `campaigns`: `object`[]; `isArchived`: `boolean`; `name`: `string`; \}; `updateFundraisingCampaign`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `currency`: `string`; `endDate`: `string`; `fundId`: `string`; `fundingGoal`: `number`; `id`: `undefined`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `string`; `startDate`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createFundraisingCampaign`: \{ `_id`: `string`; \}; `getFundById`: `undefined`; `updateFundraisingCampaign`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `currency`: `undefined`; `endDate`: `string`; `fundId`: `undefined`; `fundingGoal`: `number`; `id`: `string`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `undefined`; `startDate`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createFundraisingCampaign`: `undefined`; `getFundById`: `undefined`; `updateFundraisingCampaign`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks.ts:7](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks.ts#L7) diff --git a/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/MOCK_ERROR.md b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/MOCK_ERROR.md new file mode 100644 index 0000000000..c523b7f04b --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks/variables/MOCK_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCK\_ERROR + +> `const` **MOCK\_ERROR**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `currency`: `undefined`; `endDate`: `undefined`; `fundId`: `undefined`; `fundingGoal`: `undefined`; `id`: `string`; `name`: `undefined`; `orderBy`: `any`; `organizationId`: `undefined`; `startDate`: `undefined`; `where`: \{ `name_contains`: `string`; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `currency`: `string`; `endDate`: `string`; `fundId`: `string`; `fundingGoal`: `number`; `id`: `undefined`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `string`; `startDate`: `string`; `where`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `currency`: `undefined`; `endDate`: `string`; `fundId`: `undefined`; `fundingGoal`: `number`; `id`: `string`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `undefined`; `startDate`: `string`; `where`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks.ts:258](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFundCampaign/OrganizationFundCampaignMocks.ts#L258) diff --git a/docs/docs/auto-docs/screens/OrganizationFunds/FundModal/functions/default.md b/docs/docs/auto-docs/screens/OrganizationFunds/FundModal/functions/default.md new file mode 100644 index 0000000000..8e71d7b556 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFunds/FundModal/functions/default.md @@ -0,0 +1,57 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:52](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L52) + +`FundModal` component provides a modal dialog for creating or editing a fund. +It allows users to input fund details and submit them to the server. + +This component handles both the creation of new funds and the editing of existing funds, +based on the `mode` prop. It displays a form with fields for the fund's name, description, +and other relevant details. Upon submission, it interacts with the GraphQL API to save +or update the fund details and triggers a refetch of the fund data. + +### Props +- `isOpen`: A boolean indicating whether the modal is open or closed. +- `hide`: A function to close the modal. +- `refetchFunds`: A function to refetch the fund list after a successful operation. +- `fund`: The current fund object being edited or `null` if creating a new fund. +- `orgId`: The ID of the organization to which the fund belongs. +- `mode`: The mode of the modal, either 'edit' or 'create'. + +### State +- `name`: The name of the fund. +- `description`: The description of the fund. +- `amount`: The amount associated with the fund. +- `status`: The status of the fund (e.g., active, archived). + +### Methods +- `handleSubmit()`: Handles form submission, creates or updates the fund, and triggers a refetch of the fund list. +- `handleChange(event: React.ChangeEvent)`: Updates the state based on user input. + +## Parameters + +### props + +[`InterfaceFundModal`](../interfaces/InterfaceFundModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal dialog. diff --git a/docs/docs/auto-docs/screens/OrganizationFunds/FundModal/interfaces/InterfaceFundModal.md b/docs/docs/auto-docs/screens/OrganizationFunds/FundModal/interfaces/InterfaceFundModal.md new file mode 100644 index 0000000000..4eb52e1372 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFunds/FundModal/interfaces/InterfaceFundModal.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceFundModal + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L15) + +## Properties + +### fund + +> **fund**: [`InterfaceFundInfo`](../../../../utils/interfaces/interfaces/InterfaceFundInfo.md) + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L19) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L17) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L16) + +*** + +### mode + +> **mode**: `"create"` \| `"edit"` + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L21) + +*** + +### orgId + +> **orgId**: `string` + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L20) + +*** + +### refetchFunds() + +> **refetchFunds**: () => `void` + +Defined in: [src/screens/OrganizationFunds/FundModal.tsx:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/FundModal.tsx#L18) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFunds/functions/default.md b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFunds/functions/default.md new file mode 100644 index 0000000000..90a77b362f --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFunds/functions/default.md @@ -0,0 +1,46 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/OrganizationFunds/OrganizationFunds.tsx:79](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/OrganizationFunds.tsx#L79) + +`organizationFunds` component displays a list of funds for a specific organization, +allowing users to search, sort, view and edit funds. + +This component utilizes the `DataGrid` from Material-UI to present the list of funds in a tabular format, +and includes functionality for filtering and sorting. It also handles the opening and closing of modals +for creating and editing. + +It includes: +- A search input field to filter funds by name. +- A dropdown menu to sort funds by creation date. +- A button to create a new fund. +- A table to display the list of funds with columns for fund details and actions. +- Modals for creating and editing funds. + +### GraphQL Queries +- `FUND_LIST`: Fetches a list of funds for the given organization, filtered and sorted based on the provided parameters. + +### Props +- `orgId`: The ID of the organization whose funds are being managed. + +### State +- `fund`: The currently selected fund for editing or deletion. +- `searchTerm`: The current search term used for filtering funds. +- `sortBy`: The current sorting order for funds. +- `modalState`: The state of the modals (edit/create). +- `fundModalMode`: The mode of the fund modal (edit or create). + +### Methods +- `handleOpenModal(fund: InterfaceFundInfo | null, mode: 'edit' | 'create')`: Opens the fund modal with the given fund and mode. +- `handleClick(fundId: string)`: Navigates to the campaign page for the specified fund. + +## Returns + +`Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..0ffdfe523d --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `filter`: `string`; `id`: `undefined`; `isArchived`: `undefined`; `isDefault`: `undefined`; `name`: `undefined`; `orderBy`: `string`; `organizationId`: `string`; `refrenceNumber`: `undefined`; `taxDeductible`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createFund`: `undefined`; `fundsByOrganization`: `object`[]; `updateFund`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `filter`: `undefined`; `id`: `undefined`; `isArchived`: `boolean`; `isDefault`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `string`; `refrenceNumber`: `string`; `taxDeductible`: `boolean`; \}; \}; `result`: \{ `data`: \{ `createFund`: \{ `_id`: `string`; \}; `fundsByOrganization`: `undefined`; `updateFund`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `filter`: `undefined`; `id`: `string`; `isArchived`: `boolean`; `isDefault`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `undefined`; `refrenceNumber`: `string`; `taxDeductible`: `boolean`; \}; \}; `result`: \{ `data`: \{ `createFund`: `undefined`; `fundsByOrganization`: `undefined`; `updateFund`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/OrganizationFunds/OrganizationFundsMocks.ts:7](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/OrganizationFundsMocks.ts#L7) diff --git a/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..d18c0be4bd --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/MOCKS_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `filter`: `string`; `id`: `undefined`; `isArchived`: `undefined`; `isDefault`: `undefined`; `name`: `undefined`; `orderBy`: `string`; `organizationId`: `string`; `refrenceNumber`: `undefined`; `taxDeductible`: `undefined`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `filter`: `undefined`; `id`: `undefined`; `isArchived`: `boolean`; `isDefault`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `string`; `refrenceNumber`: `string`; `taxDeductible`: `boolean`; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `filter`: `undefined`; `id`: `string`; `isArchived`: `boolean`; `isDefault`: `boolean`; `name`: `string`; `orderBy`: `undefined`; `organizationId`: `undefined`; `refrenceNumber`: `string`; `taxDeductible`: `boolean`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationFunds/OrganizationFundsMocks.ts:191](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/OrganizationFundsMocks.ts#L191) diff --git a/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/NO_FUNDS.md b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/NO_FUNDS.md new file mode 100644 index 0000000000..2676c7d1a5 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationFunds/OrganizationFundsMocks/variables/NO_FUNDS.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Variable: NO\_FUNDS + +> `const` **NO\_FUNDS**: `object`[] + +Defined in: [src/screens/OrganizationFunds/OrganizationFundsMocks.ts:173](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationFunds/OrganizationFundsMocks.ts#L173) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `FUND_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.filter + +> **filter**: `string` = `''` + +#### request.variables.orderBy + +> **orderBy**: `string` = `'createdAt_DESC'` + +#### request.variables.organizationId + +> **organizationId**: `string` = `'orgId'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.fundsByOrganization + +> **fundsByOrganization**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/OrganizationPeople/AddMember/functions/default.md b/docs/docs/auto-docs/screens/OrganizationPeople/AddMember/functions/default.md new file mode 100644 index 0000000000..7de72ee728 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationPeople/AddMember/functions/default.md @@ -0,0 +1,21 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrganizationPeople/AddMember.tsx:62](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationPeople/AddMember.tsx#L62) + +AddMember component is used to add new members to the organization by selecting from +the existing users or creating a new user. +It uses the following queries and mutations: + ORGANIZATIONS_LIST, + ORGANIZATIONS_MEMBER_CONNECTION_LIST, + USERS_CONNECTION_LIST, + ADD_MEMBER_MUTATION,SIGNUP_MUTATION. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/OrganizationPeople/MockDataTypes/type-aliases/TestMock.md b/docs/docs/auto-docs/screens/OrganizationPeople/MockDataTypes/type-aliases/TestMock.md new file mode 100644 index 0000000000..d65d43a259 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationPeople/MockDataTypes/type-aliases/TestMock.md @@ -0,0 +1,151 @@ +[Admin Docs](/) + +*** + +# Type Alias: TestMock + +> **TestMock**: `object` + +Defined in: [src/screens/OrganizationPeople/MockDataTypes.ts:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationPeople/MockDataTypes.ts#L34) + +## Type declaration + +### newData()? + +> `optional` **newData**: () => [`TestMock`](TestMock.md)\[`"result"`\] + +#### Returns + +[`TestMock`](TestMock.md)\[`"result"`\] + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` + +#### request.variables + +> **variables**: `object` + +#### request.variables.email? + +> `optional` **email**: `string` + +#### request.variables.firstName? + +> `optional` **firstName**: `string` + +#### request.variables.firstName\_contains? + +> `optional` **firstName\_contains**: `string` + +#### request.variables.firstNameContains? + +> `optional` **firstNameContains**: `string` + +#### request.variables.id? + +> `optional` **id**: `string` + +#### request.variables.id\_not\_in? + +> `optional` **id\_not\_in**: `string`[] + +#### request.variables.lastName? + +> `optional` **lastName**: `string` + +#### request.variables.lastName\_contains? + +> `optional` **lastName\_contains**: `string` + +#### request.variables.lastNameContains? + +> `optional` **lastNameContains**: `string` + +#### request.variables.orgid? + +> `optional` **orgid**: `string` + +#### request.variables.orgId? + +> `optional` **orgId**: `string` + +#### request.variables.password? + +> `optional` **password**: `string` + +#### request.variables.userid? + +> `optional` **userid**: `string` + +### result + +> **result**: `object` + +#### result.\_\_typename? + +> `optional` **\_\_typename**: `string` + +#### result.data + +> **data**: `object` + +#### result.data.\_\_typename? + +> `optional` **\_\_typename**: `string` + +#### result.data.createMember? + +> `optional` **createMember**: `object` + +#### result.data.createMember.\_\_typename + +> **\_\_typename**: `string` + +#### result.data.createMember.\_id + +> **\_id**: `string` + +#### result.data.organizations? + +> `optional` **organizations**: [`InterfaceQueryOrganizationsListObject`](../../../../utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md)[] + +#### result.data.organizationsMemberConnection? + +> `optional` **organizationsMemberConnection**: `object` + +#### result.data.organizationsMemberConnection.edges? + +> `optional` **edges**: `Edge`[] + +#### result.data.organizationsMemberConnection.user? + +> `optional` **user**: `Edge`[] + +#### result.data.signUp? + +> `optional` **signUp**: `object` + +#### result.data.signUp.accessToken? + +> `optional` **accessToken**: `string` + +#### result.data.signUp.refreshToken? + +> `optional` **refreshToken**: `string` + +#### result.data.signUp.user? + +> `optional` **user**: `object` + +#### result.data.signUp.user.\_id + +> **\_id**: `string` + +#### result.data.users? + +> `optional` **users**: `object`[] diff --git a/docs/docs/auto-docs/screens/OrganizationPeople/OrganizationPeople/functions/default.md b/docs/docs/auto-docs/screens/OrganizationPeople/OrganizationPeople/functions/default.md new file mode 100644 index 0000000000..ee9e1bcda7 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationPeople/OrganizationPeople/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrganizationPeople/OrganizationPeople.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationPeople/OrganizationPeople.tsx#L31) + +OrganizationPeople component is used to display the list of members, admins and users of the organization. +It also provides the functionality to search the members, admins and users by their full name. +It also provides the functionality to remove the members and admins from the organization. + +## Returns + +`JSX.Element` + +JSX.Element which contains the list of members, admins and users of the organization. diff --git a/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTags/functions/default.md b/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTags/functions/default.md new file mode 100644 index 0000000000..255e7ba3dc --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTags/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrganizationTags/OrganizationTags.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationTags/OrganizationTags.tsx#L39) + +Component that renders the Organization Tags screen when the app navigates to '/orgtags/:orgId'. + +This component does not accept any props and is responsible for displaying +the content associated with the corresponding route. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..798d1c0c05 --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `string`; `first`: `number`; `id`: `string`; `name`: `undefined`; `organizationId`: `undefined`; `sortedBy`: \{ `id`: `string`; \}; `where`: \{ `name`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `createUserTag`: `undefined`; `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `number`; `id`: `string`; `name`: `undefined`; `organizationId`: `undefined`; `sortedBy`: \{ `id`: `string`; \}; `where`: \{ `name`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `createUserTag`: `undefined`; `organizations`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `undefined`; `id`: `undefined`; `name`: `string`; `organizationId`: `string`; `sortedBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createUserTag`: \{ `_id`: `string`; \}; `organizations`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/OrganizationTags/OrganizationTagsMocks.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationTags/OrganizationTagsMocks.ts#L5) diff --git a/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR.md b/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR.md new file mode 100644 index 0000000000..e532ec898b --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationTags/OrganizationTagsMocks/variables/MOCKS_ERROR.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR + +> `const` **MOCKS\_ERROR**: `object`[] + +Defined in: [src/screens/OrganizationTags/OrganizationTagsMocks.ts:413](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationTags/OrganizationTagsMocks.ts#L413) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `ORGANIZATION_USER_TAGS_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.first + +> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` + +#### request.variables.id + +> **id**: `string` = `'orgId'` + +#### request.variables.sortedBy + +> **sortedBy**: `object` + +#### request.variables.sortedBy.id + +> **id**: `string` = `'DESCENDING'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.name + +> **name**: `object` + +#### request.variables.where.name.starts\_with + +> **starts\_with**: `string` = `''` diff --git a/docs/docs/auto-docs/screens/OrganizationVenues/OrganizationVenues/functions/default.md b/docs/docs/auto-docs/screens/OrganizationVenues/OrganizationVenues/functions/default.md new file mode 100644 index 0000000000..339d69f68b --- /dev/null +++ b/docs/docs/auto-docs/screens/OrganizationVenues/OrganizationVenues/functions/default.md @@ -0,0 +1,16 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/OrganizationVenues/OrganizationVenues.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/OrganizationVenues/OrganizationVenues.tsx#L23) + +Component to manage and display the list of organization venues. +Handles searching, sorting, and CRUD operations for venues. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/PageNotFound/PageNotFound/functions/default.md b/docs/docs/auto-docs/screens/PageNotFound/PageNotFound/functions/default.md new file mode 100644 index 0000000000..0cbd4c50e3 --- /dev/null +++ b/docs/docs/auto-docs/screens/PageNotFound/PageNotFound/functions/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/PageNotFound/PageNotFound.tsx:15](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/PageNotFound/PageNotFound.tsx#L15) + +The `PageNotFound` component displays a 404 error page when a user navigates to a non-existent route. +It shows a message indicating that the page was not found and provides a link to redirect users back +to the appropriate home page based on their admin status. + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/screens/Requests/Requests/functions/default.md b/docs/docs/auto-docs/screens/Requests/Requests/functions/default.md new file mode 100644 index 0000000000..b891a78138 --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/Requests/functions/default.md @@ -0,0 +1,16 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/Requests/Requests.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/Requests.tsx#L34) + +The `Requests` component fetches and displays a paginated list of membership requests +for an organization, with functionality for searching, filtering, and infinite scrolling. + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..728a06ab00 --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; `organizationsConnection`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizations`: `undefined`; `organizationsConnection`: `any`[]; \}; \}; \})[] + +Defined in: [src/screens/Requests/RequestsMocks.ts:522](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/RequestsMocks.ts#L522) diff --git a/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/EMPTY_REQUEST_MOCKS.md b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/EMPTY_REQUEST_MOCKS.md new file mode 100644 index 0000000000..cb9d4f0f4c --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/EMPTY_REQUEST_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_REQUEST\_MOCKS + +> `const` **EMPTY\_REQUEST\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizations`: `undefined`; `organizationsConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; `organizationsConnection`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Requests/RequestsMocks.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/RequestsMocks.ts#L6) diff --git a/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..6e2459ef11 --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizations`: `undefined`; `organizationsConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; `organizationsConnection`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Requests/RequestsMocks.ts:71](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/RequestsMocks.ts#L71) diff --git a/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS2.md b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS2.md new file mode 100644 index 0000000000..3e68743bd0 --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS2.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS2 + +> `const` **MOCKS2**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizations`: `undefined`; `organizationsConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; `organizationsConnection`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Requests/RequestsMocks.ts:387](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/RequestsMocks.ts#L387) diff --git a/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS3.md b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS3.md new file mode 100644 index 0000000000..22bcad0a43 --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS3.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS3 + +> `const` **MOCKS3**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizations`: `undefined`; `organizationsConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizations`: `any`[]; `organizationsConnection`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Requests/RequestsMocks.ts:462](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/RequestsMocks.ts#L462) diff --git a/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS4.md b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS4.md new file mode 100644 index 0000000000..b90ed9803b --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS4.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS4 + +> `const` **MOCKS4**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizations`: `undefined`; `organizationsConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizations`: `object`[]; `organizationsConnection`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Requests/RequestsMocks.ts:155](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/RequestsMocks.ts#L155) diff --git a/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS_WITH_ERROR.md b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS_WITH_ERROR.md new file mode 100644 index 0000000000..7bf3b70efc --- /dev/null +++ b/docs/docs/auto-docs/screens/Requests/RequestsMocks/variables/MOCKS_WITH_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_WITH\_ERROR + +> `const` **MOCKS\_WITH\_ERROR**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `string`; `skip`: `number`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; \})[] + +Defined in: [src/screens/Requests/RequestsMocks.ts:556](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Requests/RequestsMocks.ts#L556) diff --git a/docs/docs/auto-docs/screens/SubTags/SubTags/functions/default.md b/docs/docs/auto-docs/screens/SubTags/SubTags/functions/default.md new file mode 100644 index 0000000000..7f2d47482c --- /dev/null +++ b/docs/docs/auto-docs/screens/SubTags/SubTags/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/SubTags/SubTags.tsx:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/SubTags/SubTags.tsx#L40) + +Component that renders the SubTags screen when the app navigates to '/orgtags/:orgId/subtags/:tagId'. + +This component does not accept any props and is responsible for displaying +the content associated with the corresponding route. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/SubTags/SubTagsMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/SubTags/SubTagsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..d057c4868b --- /dev/null +++ b/docs/docs/auto-docs/screens/SubTags/SubTagsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `string`; `first`: `number`; `id`: `string`; `name`: `undefined`; `organizationId`: `undefined`; `parentTagId`: `undefined`; `sortedBy`: \{ `id`: `string`; \}; `where`: \{ `name`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `createUserTag`: `undefined`; `getChildTags`: \{ `ancestorTags`: `any`[]; `childTags`: \{ `edges`: `object`[]; `pageInfo`: \{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \}; `totalCount`: `number`; \}; `name`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `number`; `id`: `string`; `name`: `undefined`; `organizationId`: `undefined`; `parentTagId`: `undefined`; `sortedBy`: \{ `id`: `string`; \}; `where`: \{ `name`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `createUserTag`: `undefined`; `getChildTags`: \{ `ancestorTags`: `object`[]; `childTags`: \{ `edges`: `object`[]; `pageInfo`: \{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \}; `totalCount`: `number`; \}; `name`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `undefined`; `id`: `undefined`; `name`: `string`; `organizationId`: `string`; `parentTagId`: `string`; `sortedBy`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createUserTag`: \{ `_id`: `string`; \}; `getChildTags`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/SubTags/SubTagsMocks.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/SubTags/SubTagsMocks.ts#L5) diff --git a/docs/docs/auto-docs/screens/SubTags/SubTagsMocks/variables/MOCKS_ERROR_SUB_TAGS.md b/docs/docs/auto-docs/screens/SubTags/SubTagsMocks/variables/MOCKS_ERROR_SUB_TAGS.md new file mode 100644 index 0000000000..18f88254d0 --- /dev/null +++ b/docs/docs/auto-docs/screens/SubTags/SubTagsMocks/variables/MOCKS_ERROR_SUB_TAGS.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS\_ERROR\_SUB\_TAGS + +> `const` **MOCKS\_ERROR\_SUB\_TAGS**: `object`[] + +Defined in: [src/screens/SubTags/SubTagsMocks.ts:489](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/SubTags/SubTagsMocks.ts#L489) + +## 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` = `TAGS_QUERY_DATA_CHUNK_SIZE` + +#### request.variables.id + +> **id**: `string` = `'1'` + +#### request.variables.sortedBy + +> **sortedBy**: `object` + +#### request.variables.sortedBy.id + +> **id**: `string` = `'DESCENDING'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.name + +> **name**: `object` + +#### request.variables.where.name.starts\_with + +> **starts\_with**: `string` = `''` diff --git a/docs/docs/auto-docs/screens/UserPortal/Campaigns/Campaigns/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Campaigns/Campaigns/functions/default.md new file mode 100644 index 0000000000..c03e28b26f --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Campaigns/Campaigns/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/UserPortal/Campaigns/Campaigns.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/Campaigns.tsx#L30) + +The `Campaigns` component displays a list of fundraising campaigns for a specific organization. +It allows users to search, sort, and view details about each campaign. Users can also add pledges to active campaigns. + +## Returns + +`Element` + +The rendered component displaying the campaigns. diff --git a/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..7a10ed2759 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `any`[]; `appLanguageCode`: `string`; `createdEvents`: `any`[]; `createdOrganizations`: `any`[]; `eventAdmin`: `any`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `__typename`: `string`; `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `any`; `createdAt`: `string`; `educationGrade`: `any`; `email`: `string`; `employmentStatus`: `any`; `firstName`: `string`; `gender`: `any`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `any`; `membershipRequests`: `any`[]; `phone`: `any`; `registeredEvents`: `any`[]; \}; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `campaignOrderBy`: `string`; `where`: \{ `name_contains`: `string`; `organizationId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getFundraisingCampaigns`: `any`[]; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Campaigns/CampaignsMocks.ts:236](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/CampaignsMocks.ts#L236) diff --git a/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/MOCKS.md new file mode 100644 index 0000000000..fb02f5d263 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `any`[]; `appLanguageCode`: `string`; `createdEvents`: `any`[]; `createdOrganizations`: `any`[]; `eventAdmin`: `any`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `__typename`: `string`; `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `any`; `createdAt`: `string`; `educationGrade`: `any`; `email`: `string`; `employmentStatus`: `any`; `firstName`: `string`; `gender`: `any`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `any`; `membershipRequests`: `any`[]; `phone`: `any`; `registeredEvents`: `any`[]; \}; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `campaignOrderBy`: `string`; `where`: \{ `name_contains`: `string`; `organizationId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getFundraisingCampaigns`: `object`[]; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Campaigns/CampaignsMocks.ts:61](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/CampaignsMocks.ts#L61) diff --git a/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/USER_FUND_CAMPAIGNS_ERROR.md b/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/USER_FUND_CAMPAIGNS_ERROR.md new file mode 100644 index 0000000000..d83b2c631a --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Campaigns/CampaignsMocks/variables/USER_FUND_CAMPAIGNS_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_FUND\_CAMPAIGNS\_ERROR + +> `const` **USER\_FUND\_CAMPAIGNS\_ERROR**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `any`[]; `appLanguageCode`: `string`; `createdEvents`: `any`[]; `createdOrganizations`: `any`[]; `eventAdmin`: `any`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `__typename`: `string`; `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `any`; `createdAt`: `string`; `educationGrade`: `any`; `email`: `string`; `employmentStatus`: `any`; `firstName`: `string`; `gender`: `any`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `any`; `membershipRequests`: `any`[]; `phone`: `any`; `registeredEvents`: `any`[]; \}; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `campaignOrderBy`: `string`; `where`: \{ `name_contains`: `string`; `organizationId`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Campaigns/CampaignsMocks.ts:257](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/CampaignsMocks.ts#L257) diff --git a/docs/docs/auto-docs/screens/UserPortal/Campaigns/PledgeModal/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Campaigns/PledgeModal/functions/default.md new file mode 100644 index 0000000000..f39ed06a1e --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Campaigns/PledgeModal/functions/default.md @@ -0,0 +1,32 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:54](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L54) + +`PledgeModal` is a React component that allows users to create or edit a pledge for a specific campaign. +It displays a form with inputs for pledge details such as amount, currency, dates, and users involved in the pledge. + +## Parameters + +### props + +[`InterfacePledgeModal`](../interfaces/InterfacePledgeModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` diff --git a/docs/docs/auto-docs/screens/UserPortal/Campaigns/PledgeModal/interfaces/InterfacePledgeModal.md b/docs/docs/auto-docs/screens/UserPortal/Campaigns/PledgeModal/interfaces/InterfacePledgeModal.md new file mode 100644 index 0000000000..7d9e26f466 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Campaigns/PledgeModal/interfaces/InterfacePledgeModal.md @@ -0,0 +1,81 @@ +[Admin Docs](/) + +*** + +# Interface: InterfacePledgeModal + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L30) + +Interface representing the properties for the `PledgeModal` component. + +## Properties + +### campaignId + +> **campaignId**: `string` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L33) + +*** + +### endDate + +> **endDate**: `Date` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L37) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L32) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L31) + +*** + +### mode + +> **mode**: `"create"` \| `"edit"` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L38) + +*** + +### pledge + +> **pledge**: [`InterfacePledgeInfo`](../../../../../utils/interfaces/interfaces/InterfacePledgeInfo.md) + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L35) + +*** + +### refetchPledge() + +> **refetchPledge**: () => `void` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L36) + +#### Returns + +`void` + +*** + +### userId + +> **userId**: `string` + +Defined in: [src/screens/UserPortal/Campaigns/PledgeModal.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Campaigns/PledgeModal.tsx#L34) diff --git a/docs/docs/auto-docs/screens/UserPortal/Chat/Chat/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Chat/Chat/functions/default.md new file mode 100644 index 0000000000..0623349dc5 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Chat/Chat/functions/default.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Chat/Chat.tsx:102](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Chat/Chat.tsx#L102) + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/UserPortal/Donate/Donate/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Donate/Donate/functions/default.md new file mode 100644 index 0000000000..65747daf17 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Donate/Donate/functions/default.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:65](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L65) + +`donate` component allows users to make donations to an organization and view their previous donations. + +This component fetches donation-related data using GraphQL queries and allows users to make donations +using a mutation. It supports currency selection, donation amount input, and displays a paginated list +of previous donations. + +It includes: +- An input field for searching donations. +- A dropdown to select currency. +- An input field for entering donation amount. +- A button to submit the donation. +- A list of previous donations displayed in a paginated format. +- An organization sidebar for navigation. + +### GraphQL Queries +- `ORGANIZATION_DONATION_CONNECTION_LIST`: Fetches the list of donations for the organization. +- `USER_ORGANIZATION_CONNECTION`: Fetches organization details. + +### GraphQL Mutations +- `DONATE_TO_ORGANIZATION`: Performs the donation action. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/UserPortal/Donate/Donate/interfaces/InterfaceDonationCardProps.md b/docs/docs/auto-docs/screens/UserPortal/Donate/Donate/interfaces/InterfaceDonationCardProps.md new file mode 100644 index 0000000000..42e1cfd935 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Donate/Donate/interfaces/InterfaceDonationCardProps.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceDonationCardProps + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L23) + +## Properties + +### amount + +> **amount**: `string` + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L26) + +*** + +### id + +> **id**: `string` + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L24) + +*** + +### name + +> **name**: `string` + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L25) + +*** + +### payPalId + +> **payPalId**: `string` + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L28) + +*** + +### updatedAt + +> **updatedAt**: `string` + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L29) + +*** + +### userId + +> **userId**: `string` + +Defined in: [src/screens/UserPortal/Donate/Donate.tsx:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Donate/Donate.tsx#L27) diff --git a/docs/docs/auto-docs/screens/UserPortal/Events/Events/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Events/Events/functions/default.md new file mode 100644 index 0000000000..ae81db8c3c --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Events/Events/functions/default.md @@ -0,0 +1,20 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Events/Events.tsx:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Events/Events.tsx#L43) + +Component to manage and display events for an organization. + +This component allows users to view, create, and manage events within an organization. +It includes a calendar view, a form to create new events, and various filters and settings. + +## Returns + +`JSX.Element` + +The JSX element for the events management interface. diff --git a/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/functions/default.md new file mode 100644 index 0000000000..b0f8523313 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/functions/default.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/UserPortal/LeaveOrganization/LeaveOrganization.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/LeaveOrganization/LeaveOrganization.tsx#L32) + +## Returns + +`Element` diff --git a/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/variables/userEmail.md b/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/variables/userEmail.md new file mode 100644 index 0000000000..d150c65e30 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/variables/userEmail.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: userEmail + +> `const` **userEmail**: `any` + +Defined in: [src/screens/UserPortal/LeaveOrganization/LeaveOrganization.tsx:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/LeaveOrganization/LeaveOrganization.tsx#L13) diff --git a/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/variables/userId.md b/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/variables/userId.md new file mode 100644 index 0000000000..8eda40dd66 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/LeaveOrganization/LeaveOrganization/variables/userId.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: userId + +> `const` **userId**: `any` + +Defined in: [src/screens/UserPortal/LeaveOrganization/LeaveOrganization.tsx:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/LeaveOrganization/LeaveOrganization.tsx#L21) diff --git a/docs/docs/auto-docs/screens/UserPortal/Organizations/Organizations/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Organizations/Organizations/functions/default.md new file mode 100644 index 0000000000..fdd39ca878 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Organizations/Organizations/functions/default.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Organizations/Organizations.tsx:76](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Organizations/Organizations.tsx#L76) + +Component for displaying and managing user organizations. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/UserPortal/People/People/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/People/People/functions/default.md new file mode 100644 index 0000000000..7756fe77c3 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/People/People/functions/default.md @@ -0,0 +1,17 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/People/People.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/People/People.tsx#L39) + +`People` component displays a list of people associated with an organization. +It allows users to filter between all members and admins, search for members by their first name, +and paginate through the list. + +## Returns + +`JSX.Element` diff --git a/docs/docs/auto-docs/screens/UserPortal/Pledges/Pledges/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Pledges/Pledges/functions/default.md new file mode 100644 index 0000000000..2bc72ff2e4 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Pledges/Pledges/functions/default.md @@ -0,0 +1,30 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/UserPortal/Pledges/Pledges.tsx:70](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Pledges/Pledges.tsx#L70) + +The `Pledges` component is responsible for rendering a user's pledges within a campaign. +It fetches pledges data using Apollo Client's `useQuery` hook and displays the data +in a DataGrid with various features such as search, sorting, and modal dialogs for updating +or deleting a pledge. The component also handles various UI interactions including opening +modals for editing or deleting a pledge, showing additional pledgers in a popup, and +applying filters for searching pledges by campaign or pledger name. + +Key functionalities include: +- Fetching pledges data from the backend using GraphQL query `USER_PLEDGES`. +- Displaying pledges in a table with columns for pledgers, associated campaigns, + end dates, pledged amounts, and actions. +- Handling search and sorting of pledges. +- Opening and closing modals for updating and deleting pledges. +- Displaying additional pledgers in a popup when the list of pledgers exceeds a certain limit. + +## Returns + +`Element` + +The rendered Pledges component. diff --git a/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..f216302fe3 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `any`[]; `appLanguageCode`: `string`; `createdEvents`: `any`[]; `createdOrganizations`: `any`[]; `eventAdmin`: `any`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `__typename`: `string`; `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `any`; `createdAt`: `string`; `educationGrade`: `any`; `email`: `string`; `employmentStatus`: `any`; `firstName`: `string`; `gender`: `any`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `any`; `membershipRequests`: `any`[]; `phone`: `any`; `registeredEvents`: `any`[]; \}; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `orderBy`: `string`; `userId`: `string`; `where`: \{ `firstName_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getPledgesByUserId`: `any`[]; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Pledges/PledgesMocks.ts:560](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Pledges/PledgesMocks.ts#L560) diff --git a/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/MOCKS.md new file mode 100644 index 0000000000..bc7d771756 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `any`[]; `appLanguageCode`: `string`; `createdEvents`: `any`[]; `createdOrganizations`: `any`[]; `eventAdmin`: `any`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `__typename`: `string`; `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `any`; `createdAt`: `string`; `educationGrade`: `any`; `email`: `string`; `employmentStatus`: `any`; `firstName`: `string`; `gender`: `any`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `any`; `membershipRequests`: `any`[]; `phone`: `any`; `registeredEvents`: `any`[]; \}; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `string`; `userId`: `string`; `where`: \{ `firstName_contains`: `undefined`; `name_contains`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getPledgesByUserId`: `object`[]; `removeFundraisingCampaignPledge`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `string`; `userId`: `string`; `where`: \{ `firstName_contains`: `string`; `name_contains`: `undefined`; \}; \}; \}; `result`: \{ `data`: \{ `getPledgesByUserId`: `object`[]; `removeFundraisingCampaignPledge`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `orderBy`: `undefined`; `userId`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getPledgesByUserId`: `undefined`; `removeFundraisingCampaignPledge`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Pledges/PledgesMocks.ts:62](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Pledges/PledgesMocks.ts#L62) diff --git a/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/USER_PLEDGES_ERROR.md b/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/USER_PLEDGES_ERROR.md new file mode 100644 index 0000000000..7f22eab67f --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Pledges/PledgesMocks/variables/USER_PLEDGES_ERROR.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: USER\_PLEDGES\_ERROR + +> `const` **USER\_PLEDGES\_ERROR**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; \}; \}; `result`: \{ `data`: \{ `user`: \{ `__typename`: `string`; `appUserProfile`: \{ `__typename`: `string`; `_id`: `string`; `adminFor`: `any`[]; `appLanguageCode`: `string`; `createdEvents`: `any`[]; `createdOrganizations`: `any`[]; `eventAdmin`: `any`[]; `isSuperAdmin`: `boolean`; `pluginCreationAllowed`: `boolean`; \}; `user`: \{ `__typename`: `string`; `_id`: `string`; `address`: \{ `__typename`: `string`; `city`: `string`; `countryCode`: `string`; `line1`: `string`; `state`: `string`; \}; `birthDate`: `any`; `createdAt`: `string`; `educationGrade`: `any`; `email`: `string`; `employmentStatus`: `any`; `firstName`: `string`; `gender`: `any`; `image`: `any`; `joinedOrganizations`: `object`[]; `lastName`: `string`; `maritalStatus`: `any`; `membershipRequests`: `any`[]; `phone`: `any`; `registeredEvents`: `any`[]; \}; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `orderBy`: `string`; `userId`: `string`; `where`: \{ `firstName_contains`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Pledges/PledgesMocks.ts:581](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Pledges/PledgesMocks.ts#L581) diff --git a/docs/docs/auto-docs/screens/UserPortal/Posts/Posts/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Posts/Posts/functions/default.md new file mode 100644 index 0000000000..ee66f984b0 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Posts/Posts/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Posts/Posts.tsx:112](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Posts/Posts.tsx#L112) + +`home` component displays the main feed for a user, including posts, promoted content, and options to create a new post. + +It utilizes Apollo Client for fetching and managing data through GraphQL queries. The component fetches and displays posts from an organization, promoted advertisements, and handles user interactions for creating new posts. It also manages state for displaying modal dialogs and handling file uploads for new posts. + +## Returns + +`JSX.Element` + +JSX.Element - The rendered `home` component. diff --git a/docs/docs/auto-docs/screens/UserPortal/Settings/Settings/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Settings/Settings/functions/default.md new file mode 100644 index 0000000000..c6d5c13b92 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Settings/Settings/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Settings/Settings.tsx:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Settings/Settings.tsx#L33) + +The Settings component allows users to view and update their profile settings. +It includes functionality to handle image uploads, reset changes, and save updated user details. + +## Returns + +`JSX.Element` + +The Settings component. diff --git a/docs/docs/auto-docs/screens/UserPortal/UserScreen/UserScreen/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/UserScreen/UserScreen/functions/default.md new file mode 100644 index 0000000000..1839466131 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/UserScreen/UserScreen/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/UserPortal/UserScreen/UserScreen.tsx:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/UserScreen/UserScreen.tsx#L34) + +The UserScreen component serves as a container for user-specific pages +within an organization context. It provides layout and sidebar navigation +functionality based on the current organization ID and user roles. + +## Returns + +`Element` + +The UserScreen component. diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..9dc0e2db16 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: `object`[] + +Defined in: [src/screens/UserPortal/Volunteer/Actions/Actions.mocks.ts:232](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Actions/Actions.mocks.ts#L232) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `ACTION_ITEMS_BY_USER` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orderBy + +> **orderBy**: `any` = `null` + +#### request.variables.userId + +> **userId**: `string` = `'userId'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.assigneeName + +> **assigneeName**: `string` = `''` + +#### request.variables.where.orgId + +> **orgId**: `string` = `'orgId'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.actionItemsByUser + +> **actionItemsByUser**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..4f5242b196 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/ERROR_MOCKS.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: `object`[] + +Defined in: [src/screens/UserPortal/Volunteer/Actions/Actions.mocks.ts:253](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Actions/Actions.mocks.ts#L253) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `ACTION_ITEMS_BY_USER` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orderBy + +> **orderBy**: `any` = `null` + +#### request.variables.userId + +> **userId**: `string` = `'userId'` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.assigneeName + +> **assigneeName**: `string` = `''` + +#### request.variables.where.orgId + +> **orgId**: `string` = `'orgId'` diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..a6379add44 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `orderBy`: `any`; `userId`: `string`; `where`: \{ `assigneeName`: `string`; `categoryName`: `undefined`; `orgId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemsByUser`: (\{ `_id`: `string`; `actionItemCategory`: \{ `_id`: `string`; `name`: `string`; \}; `allottedHours`: `number`; `assignee`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \}; `assigneeGroup`: `any`; `assigneeType`: `string`; `assigner`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `assignmentDate`: `string`; `completionDate`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `dueDate`: `string`; `event`: \{ `_id`: `string`; `title`: `string`; \}; `isCompleted`: `boolean`; `postCompletionNotes`: `string`; `preCompletionNotes`: `string`; \} \| \{ `_id`: `string`; `actionItemCategory`: \{ `_id`: `string`; `name`: `string`; \}; `allottedHours`: `number`; `assignee`: `any`; `assigneeGroup`: \{ `_id`: `string`; `name`: `string`; \}; `assigneeType`: `string`; `assigner`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `assignmentDate`: `string`; `completionDate`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `dueDate`: `string`; `event`: \{ `_id`: `string`; `title`: `string`; \}; `isCompleted`: `boolean`; `postCompletionNotes`: `string`; `preCompletionNotes`: `string`; \} \| \{ `_id`: `string`; `actionItemCategory`: \{ `_id`: `string`; `name`: `string`; \}; `allottedHours`: `any`; `assignee`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `string`; `lastName`: `string`; \}; \}; `assigneeGroup`: `any`; `assigneeType`: `string`; `assigner`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `assignmentDate`: `string`; `completionDate`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `dueDate`: `string`; `event`: \{ `_id`: `string`; `title`: `string`; \}; `isCompleted`: `boolean`; `postCompletionNotes`: `string`; `preCompletionNotes`: `string`; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `orderBy`: `string`; `userId`: `string`; `where`: \{ `assigneeName`: `string`; `categoryName`: `undefined`; `orgId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemsByUser`: (\{ `_id`: `string`; `actionItemCategory`: \{ `_id`: `string`; `name`: `string`; \}; `allottedHours`: `number`; `assignee`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \}; `assigneeGroup`: `any`; `assigneeType`: `string`; `assigner`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `assignmentDate`: `string`; `completionDate`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `dueDate`: `string`; `event`: \{ `_id`: `string`; `title`: `string`; \}; `isCompleted`: `boolean`; `postCompletionNotes`: `string`; `preCompletionNotes`: `string`; \} \| \{ `_id`: `string`; `actionItemCategory`: \{ `_id`: `string`; `name`: `string`; \}; `allottedHours`: `number`; `assignee`: `any`; `assigneeGroup`: \{ `_id`: `string`; `name`: `string`; \}; `assigneeType`: `string`; `assigner`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `assignmentDate`: `string`; `completionDate`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `dueDate`: `string`; `event`: \{ `_id`: `string`; `title`: `string`; \}; `isCompleted`: `boolean`; `postCompletionNotes`: `string`; `preCompletionNotes`: `string`; \})[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `orderBy`: `any`; `userId`: `string`; `where`: \{ `assigneeName`: `undefined`; `categoryName`: `string`; `orgId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `actionItemsByUser`: (\{ `_id`: `string`; `actionItemCategory`: \{ `_id`: `string`; `name`: `string`; \}; `allottedHours`: `number`; `assignee`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \}; `assigneeGroup`: `any`; `assigneeType`: `string`; `assigner`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `assignmentDate`: `string`; `completionDate`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `dueDate`: `string`; `event`: \{ `_id`: `string`; `title`: `string`; \}; `isCompleted`: `boolean`; `postCompletionNotes`: `string`; `preCompletionNotes`: `string`; \} \| \{ `_id`: `string`; `actionItemCategory`: \{ `_id`: `string`; `name`: `string`; \}; `allottedHours`: `number`; `assignee`: `any`; `assigneeGroup`: \{ `_id`: `string`; `name`: `string`; \}; `assigneeType`: `string`; `assigner`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; `assignmentDate`: `string`; `completionDate`: `string`; `creator`: \{ `_id`: `string`; `firstName`: `string`; `lastName`: `string`; \}; `dueDate`: `string`; `event`: \{ `_id`: `string`; `title`: `string`; \}; `isCompleted`: `boolean`; `postCompletionNotes`: `string`; `preCompletionNotes`: `string`; \})[]; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/Actions/Actions.mocks.ts:121](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Actions/Actions.mocks.ts#L121) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions/functions/default.md new file mode 100644 index 0000000000..7b43224e76 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Actions/Actions/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Volunteer/Actions/Actions.tsx:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Actions/Actions.tsx#L60) + +Component for managing and displaying action items within an organization. + +This component allows users to view, filter, sort, and create action items. It also handles fetching and displaying related data such as action item categories and members. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/GroupModal/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/GroupModal/functions/default.md new file mode 100644 index 0000000000..00c4d06166 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/GroupModal/functions/default.md @@ -0,0 +1,49 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx:71](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx#L71) + +A modal dialog for creating or editing a volunteer group. + +## Parameters + +### props + +[`InterfaceGroupModal`](../interfaces/InterfaceGroupModal.md) + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered modal component. + +The `VolunteerGroupModal` component displays a form within a modal dialog for creating or editing a Volunteer Group. +It includes fields for entering the group name, description, volunteersRequired, and selecting volunteers/leaders. + +The modal includes: +- A header with a title indicating the current mode (create or edit) and a close button. +- A form with: + - An input field for entering the group name. + - A textarea for entering the group description. + - An input field for entering the number of volunteers required. +- A submit button to create or update the pledge. + +On form submission, the component either: +- Calls `updateVoluneerGroup` mutation to update an existing group, or + +Success or error messages are displayed using toast notifications based on the result of the mutation. diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/GroupModal/interfaces/InterfaceGroupModal.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/GroupModal/interfaces/InterfaceGroupModal.md new file mode 100644 index 0000000000..530a710db8 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/GroupModal/interfaces/InterfaceGroupModal.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceGroupModal + +Defined in: [src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx#L35) + +## Properties + +### eventId + +> **eventId**: `string` + +Defined in: [src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx#L38) + +*** + +### group + +> **group**: [`InterfaceVolunteerGroupInfo`](../../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md) + +Defined in: [src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx#L39) + +*** + +### hide() + +> **hide**: () => `void` + +Defined in: [src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx#L37) + +#### Returns + +`void` + +*** + +### isOpen + +> **isOpen**: `boolean` + +Defined in: [src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx#L36) + +*** + +### refetchGroups() + +> **refetchGroups**: () => `void` + +Defined in: [src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/GroupModal.tsx#L40) + +#### Returns + +`void` diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..26314bdae9 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `orderBy`: `any`; `where`: \{ `eventId`: `undefined`; `group`: `undefined`; `leaderName`: `any`; `name_contains`: `string`; `orgId`: `string`; `status`: `undefined`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `any`[]; `getVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `orderBy`: `undefined`; `where`: \{ `eventId`: `string`; `group`: `string`; `leaderName`: `undefined`; `name_contains`: `undefined`; `orgId`: `undefined`; `status`: `string`; `userId`: `undefined`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `undefined`; `getVolunteerMembership`: `any`[]; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts:368](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts#L368) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..135e82bd02 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/ERROR_MOCKS.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: `object`[] + +Defined in: [src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts:407](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts#L407) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `EVENT_VOLUNTEER_GROUP_LIST` + +#### request.variables + +> **variables**: `object` + +#### request.variables.orderBy + +> **orderBy**: `any` = `null` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.leaderName + +> **leaderName**: `any` = `null` + +#### request.variables.where.name\_contains + +> **name\_contains**: `string` = `''` + +#### request.variables.where.orgId + +> **orgId**: `string` = `'orgId'` + +#### request.variables.where.userId + +> **userId**: `string` = `'userId'` diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..eaa55cebf7 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `string`; `status`: `undefined`; `where`: \{ `eventId`: `undefined`; `groupId`: `undefined`; `leaderName`: `any`; `name_contains`: `string`; `orgId`: `string`; `status`: `undefined`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `object`[]; `getVolunteerMembership`: `undefined`; `updateEventVolunteerGroup`: `undefined`; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `any`; `status`: `undefined`; `where`: \{ `eventId`: `undefined`; `groupId`: `undefined`; `leaderName`: `string`; `name_contains`: `any`; `orgId`: `string`; `status`: `undefined`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `object`[]; `getVolunteerMembership`: `undefined`; `updateEventVolunteerGroup`: `undefined`; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `orderBy`: `undefined`; `status`: `undefined`; `where`: \{ `eventId`: `string`; `groupId`: `string`; `leaderName`: `undefined`; `name_contains`: `undefined`; `orgId`: `undefined`; `status`: `string`; `userId`: `undefined`; \}; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `undefined`; `getVolunteerMembership`: `object`[]; `updateEventVolunteerGroup`: `undefined`; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `orderBy`: `undefined`; `status`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `undefined`; `getVolunteerMembership`: `undefined`; `updateEventVolunteerGroup`: `undefined`; `updateVolunteerMembership`: \{ `_id`: `string`; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `string`; `eventId`: `string`; `name`: `string`; `volunteersRequired`: `number`; \}; `id`: `string`; `orderBy`: `undefined`; `status`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `undefined`; `getVolunteerMembership`: `undefined`; `updateEventVolunteerGroup`: \{ `_id`: `string`; \}; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `undefined`; `eventId`: `string`; `name`: `undefined`; `volunteersRequired`: `undefined`; \}; `id`: `string`; `orderBy`: `undefined`; `status`: `undefined`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getEventVolunteerGroups`: `undefined`; `getVolunteerMembership`: `undefined`; `updateEventVolunteerGroup`: \{ `_id`: `string`; \}; `updateVolunteerMembership`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts:163](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts#L163) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/UPDATE_ERROR_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/UPDATE_ERROR_MOCKS.md new file mode 100644 index 0000000000..2a310c2ecc --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups.mocks/variables/UPDATE_ERROR_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ERROR\_MOCKS + +> `const` **UPDATE\_ERROR\_MOCKS**: (\{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `undefined`; `status`: `undefined`; `where`: \{ `eventId`: `string`; `groupId`: `string`; `status`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `id`: `string`; `status`: `string`; `where`: `undefined`; \}; \}; `result`: `undefined`; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `description`: `string`; `eventId`: `string`; `name`: `string`; `volunteersRequired`: `number`; \}; `id`: `string`; `status`: `undefined`; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts:425](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/Groups.mocks.ts#L425) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups/functions/default.md new file mode 100644 index 0000000000..3530e5a64f --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Groups/Groups/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `JSX.Element` + +Defined in: [src/screens/UserPortal/Volunteer/Groups/Groups.tsx:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Groups/Groups.tsx#L55) + +Component for managing volunteer groups for an event. +This component allows users to view, filter, sort, and create action items. It also provides a modal for creating and editing action items. + +## Returns + +`JSX.Element` + +The rendered component. diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..c0513a2ed7 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: `object`[] + +Defined in: [src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts:189](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts#L189) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `USER_VOLUNTEER_MEMBERSHIP` + +#### request.variables + +> **variables**: `object` + +#### request.variables.where + +> **where**: `object` + +#### request.variables.where.filter + +> **filter**: `any` = `null` + +#### request.variables.where.status + +> **status**: `string` = `'invited'` + +#### request.variables.where.userId + +> **userId**: `string` = `'userId'` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.getVolunteerMembership + +> **getVolunteerMembership**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..fef8d46ec7 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/ERROR_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: (\{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `status`: `undefined`; `where`: \{ `filter`: `any`; `status`: `string`; `userId`: `string`; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `status`: `string`; `where`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts:209](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts#L209) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..8a236fd189 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `undefined`; `status`: `undefined`; `where`: \{ `eventTitle`: `undefined`; `filter`: `any`; `status`: `string`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: (\{ `_id`: `string`; `createdAt`: `string`; `event`: \{ `_id`: `string`; `startDate`: `string`; `title`: `string`; \}; `group`: `any`; `status`: `string`; `volunteer`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `string`; `lastName`: `string`; \}; \}; \} \| \{ `_id`: `string`; `createdAt`: `string`; `event`: \{ `_id`: `string`; `startDate`: `string`; `title`: `string`; \}; `group`: \{ `_id`: `string`; `name`: `string`; \}; `status`: `string`; `volunteer`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \}; \})[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `string`; `status`: `undefined`; `where`: \{ `eventTitle`: `undefined`; `filter`: `any`; `status`: `string`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: (\{ `_id`: `string`; `createdAt`: `string`; `event`: \{ `_id`: `string`; `startDate`: `string`; `title`: `string`; \}; `group`: `any`; `status`: `string`; `volunteer`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `string`; `lastName`: `string`; \}; \}; \} \| \{ `_id`: `string`; `createdAt`: `string`; `event`: \{ `_id`: `string`; `startDate`: `string`; `title`: `string`; \}; `group`: \{ `_id`: `string`; `name`: `string`; \}; `status`: `string`; `volunteer`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \}; \})[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `undefined`; `status`: `undefined`; `where`: \{ `eventTitle`: `undefined`; `filter`: `string`; `status`: `string`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `undefined`; `status`: `undefined`; `where`: \{ `eventTitle`: `undefined`; `filter`: `string`; `status`: `string`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `orderBy`: `undefined`; `status`: `undefined`; `where`: \{ `eventTitle`: `string`; `filter`: `any`; `status`: `string`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `object`[]; `updateVolunteerMembership`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `orderBy`: `undefined`; `status`: `string`; `where`: `undefined`; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: `undefined`; `updateVolunteerMembership`: \{ `_id`: `string`; \}; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts:49](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts#L49) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/UPDATE_ERROR_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/UPDATE_ERROR_MOCKS.md new file mode 100644 index 0000000000..98355a7f16 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations.mocks/variables/UPDATE_ERROR_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: UPDATE\_ERROR\_MOCKS + +> `const` **UPDATE\_ERROR\_MOCKS**: (\{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `undefined`; `status`: `undefined`; `where`: \{ `filter`: `any`; `status`: `string`; `userId`: `string`; \}; \}; \}; `result`: \{ `data`: \{ `getVolunteerMembership`: (\{ `_id`: `string`; `createdAt`: `string`; `event`: \{ `_id`: `string`; `startDate`: `string`; `title`: `string`; \}; `group`: `any`; `status`: `string`; `volunteer`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `string`; `lastName`: `string`; \}; \}; \} \| \{ `_id`: `string`; `createdAt`: `string`; `event`: \{ `_id`: `string`; `startDate`: `string`; `title`: `string`; \}; `group`: \{ `_id`: `string`; `name`: `string`; \}; `status`: `string`; `volunteer`: \{ `_id`: `string`; `user`: \{ `_id`: `string`; `firstName`: `string`; `image`: `any`; `lastName`: `string`; \}; \}; \})[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `id`: `string`; `status`: `string`; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts:235](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Invitations/Invitations.mocks.ts#L235) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations/functions/default.md new file mode 100644 index 0000000000..1415c82bdb --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/Invitations/Invitations/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/UserPortal/Volunteer/Invitations/Invitations.tsx:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/Invitations/Invitations.tsx#L32) + +The `Invitations` component displays list of invites for the user to volunteer. +It allows the user to search, sort, and accept/reject invites. + +## Returns + +`Element` + +The rendered component displaying the upcoming events. diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/CREATE_ERROR_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/CREATE_ERROR_MOCKS.md new file mode 100644 index 0000000000..fb3505fdb3 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/CREATE_ERROR_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: CREATE\_ERROR\_MOCKS + +> `const` **CREATE\_ERROR\_MOCKS**: (\{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `first`: `any`; `location_contains`: `string`; `organization_id`: `string`; `skip`: `any`; `title_contains`: `string`; `upcomingOnly`: `boolean`; \}; \}; `result`: \{ `data`: \{ `eventsByOrganizationConnection`: `object`[]; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `event`: `string`; `group`: `any`; `status`: `string`; `userId`: `string`; \}; `first`: `undefined`; `location_contains`: `undefined`; `organization_id`: `undefined`; `skip`: `undefined`; `title_contains`: `undefined`; `upcomingOnly`: `undefined`; \}; \}; `result`: `undefined`; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts:248](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts#L248) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..9cbb6a708e --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,59 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: `object`[] + +Defined in: [src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts:210](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts#L210) + +## Type declaration + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `USER_EVENTS_VOLUNTEER` + +#### request.variables + +> **variables**: `object` + +#### request.variables.first + +> **first**: `any` = `null` + +#### request.variables.location\_contains + +> **location\_contains**: `string` = `''` + +#### request.variables.organization\_id + +> **organization\_id**: `string` = `'orgId'` + +#### request.variables.skip + +> **skip**: `any` = `null` + +#### request.variables.title\_contains + +> **title\_contains**: `string` = `''` + +#### request.variables.upcomingOnly + +> **upcomingOnly**: `boolean` = `true` + +### result + +> **result**: `object` + +#### result.data + +> **data**: `object` + +#### result.data.eventsByOrganizationConnection + +> **eventsByOrganizationConnection**: `any`[] = `[]` diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/ERROR_MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/ERROR_MOCKS.md new file mode 100644 index 0000000000..223ee6b0d2 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/ERROR_MOCKS.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Variable: ERROR\_MOCKS + +> `const` **ERROR\_MOCKS**: `object`[] + +Defined in: [src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts:231](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts#L231) + +## Type declaration + +### error + +> **error**: `Error` + +### request + +> **request**: `object` + +#### request.query + +> **query**: `DocumentNode` = `USER_EVENTS_VOLUNTEER` + +#### request.variables + +> **variables**: `object` + +#### request.variables.first + +> **first**: `any` = `null` + +#### request.variables.location\_contains + +> **location\_contains**: `string` = `''` + +#### request.variables.organization\_id + +> **organization\_id**: `string` = `'orgId'` + +#### request.variables.skip + +> **skip**: `any` = `null` + +#### request.variables.title\_contains + +> **title\_contains**: `string` = `''` + +#### request.variables.upcomingOnly + +> **upcomingOnly**: `boolean` = `true` diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/MOCKS.md new file mode 100644 index 0000000000..592af07102 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: `undefined`; `first`: `any`; `location_contains`: `string`; `organization_id`: `string`; `skip`: `any`; `title_contains`: `string`; `upcomingOnly`: `boolean`; \}; \}; `result`: \{ `data`: \{ `createVolunteerMembership`: `undefined`; `eventsByOrganizationConnection`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `data`: \{ `event`: `string`; `group`: `string`; `status`: `string`; `userId`: `string`; \}; `first`: `undefined`; `location_contains`: `undefined`; `organization_id`: `undefined`; `skip`: `undefined`; `title_contains`: `undefined`; `upcomingOnly`: `undefined`; \}; \}; `result`: \{ `data`: \{ `createVolunteerMembership`: \{ `_id`: `string`; \}; `eventsByOrganizationConnection`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts:113](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.mocks.ts#L113) diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents/functions/default.md new file mode 100644 index 0000000000..64db6e32a8 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents/functions/default.md @@ -0,0 +1,18 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.tsx:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.tsx#L42) + +The `UpcomingEvents` component displays list of upcoming events for the user to volunteer. +It allows the user to search, sort, and volunteer for events/volunteer groups. + +## Returns + +`Element` + +The rendered component displaying the upcoming events. diff --git a/docs/docs/auto-docs/screens/UserPortal/Volunteer/VolunteerManagement/functions/default.md b/docs/docs/auto-docs/screens/UserPortal/Volunteer/VolunteerManagement/functions/default.md new file mode 100644 index 0000000000..ff86ac35b3 --- /dev/null +++ b/docs/docs/auto-docs/screens/UserPortal/Volunteer/VolunteerManagement/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/UserPortal/Volunteer/VolunteerManagement.tsx:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/UserPortal/Volunteer/VolunteerManagement.tsx#L58) + +`VolunteerManagement` component handles the display and navigation of different event management sections. + +It provides a tabbed interface for: +- Viewing upcoming events to volunteer +- Managing volunteer requests +- Managing volunteer invitations +- Managing volunteer groups + +## Returns + +`Element` + +JSX.Element - The `VolunteerManagement` component. diff --git a/docs/docs/auto-docs/screens/Users/Users/functions/default.md b/docs/docs/auto-docs/screens/Users/Users/functions/default.md new file mode 100644 index 0000000000..7aae1cdf8a --- /dev/null +++ b/docs/docs/auto-docs/screens/Users/Users/functions/default.md @@ -0,0 +1,53 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Element` + +Defined in: [src/screens/Users/Users.tsx:64](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Users/Users.tsx#L64) + +The `Users` component is responsible for displaying a list of users in a paginated and sortable format. +It supports search functionality, filtering, and sorting of users. The component integrates with GraphQL +for fetching and managing user data and displays results with infinite scrolling. + +## Features: +- **Search:** Allows users to search for users by their first name. +- **Sorting:** Provides options to sort users by creation date (newest or oldest). +- **Filtering:** Enables filtering users based on their roles (admin, superadmin, user, etc.). +- **Pagination:** Utilizes infinite scrolling to load more users as the user scrolls down. + +## GraphQL Queries: +- `USER_LIST`: Fetches a list of users with specified search, sorting, and pagination parameters. +- `ORGANIZATION_CONNECTION_LIST`: Fetches a list of organizations to verify organization existence. + +## Component State: +- `isLoading`: Indicates whether the component is currently loading data. +- `hasMore`: Indicates if there are more users to load. +- `isLoadingMore`: Indicates if more users are currently being loaded. +- `searchByName`: The current search query for user names. +- `sortingOption`: The current sorting option (newest or oldest). +- `filteringOption`: The current filtering option (admin, superadmin, user, cancel). +- `displayedUsers`: The list of users currently displayed, filtered and sorted. + +## Event Handlers: +- `handleSearch`: Handles searching users by name and refetches the user list. +- `handleSearchByEnter`: Handles search input when the Enter key is pressed. +- `handleSearchByBtnClick`: Handles search input when the search button is clicked. +- `resetAndRefetch`: Resets search and refetches the user list with default parameters. +- `loadMoreUsers`: Loads more users when scrolling reaches the end of the list. +- `handleSorting`: Updates sorting option and refetches the user list. +- `handleFiltering`: Updates filtering option and refetches the user list. + +## Rendering: +- Displays a search input and button for searching users. +- Provides dropdowns for sorting and filtering users. +- Renders a table of users with infinite scrolling support. +- Shows appropriate messages when no users are found or when search yields no results. + +## Returns + +`Element` + +The rendered `Users` component. diff --git a/docs/docs/auto-docs/screens/Users/UsersMocks/variables/EMPTY_MOCKS.md b/docs/docs/auto-docs/screens/Users/UsersMocks/variables/EMPTY_MOCKS.md new file mode 100644 index 0000000000..744cbe86cd --- /dev/null +++ b/docs/docs/auto-docs/screens/Users/UsersMocks/variables/EMPTY_MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: EMPTY\_MOCKS + +> `const` **EMPTY\_MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `lastName_contains`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `users`: `any`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizationsConnection`: `any`[]; `users`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Users/UsersMocks.ts:477](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Users/UsersMocks.ts#L477) diff --git a/docs/docs/auto-docs/screens/Users/UsersMocks/variables/MOCKS.md b/docs/docs/auto-docs/screens/Users/UsersMocks/variables/MOCKS.md new file mode 100644 index 0000000000..83dccfa6b1 --- /dev/null +++ b/docs/docs/auto-docs/screens/Users/UsersMocks/variables/MOCKS.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS + +> `const` **MOCKS**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `firstName_contains`: `undefined`; `id`: `string`; `lastName_contains`: `undefined`; `skip`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `user`: \{ `email`: `string`; `firstName`: `string`; `image`: `string`; `lastName`: `string`; \}; `users`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `undefined`; `lastName_contains`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `user`: `undefined`; `users`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizationsConnection`: `object`[]; `user`: `undefined`; `users`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Users/UsersMocks.ts:7](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Users/UsersMocks.ts#L7) diff --git a/docs/docs/auto-docs/screens/Users/UsersMocks/variables/MOCKS2.md b/docs/docs/auto-docs/screens/Users/UsersMocks/variables/MOCKS2.md new file mode 100644 index 0000000000..fccadb3798 --- /dev/null +++ b/docs/docs/auto-docs/screens/Users/UsersMocks/variables/MOCKS2.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: MOCKS2 + +> `const` **MOCKS2**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `firstName_contains`: `undefined`; `id`: `string`; `lastName_contains`: `undefined`; `skip`: `undefined`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `user`: \{ `email`: `string`; `firstName`: `string`; `image`: `string`; `lastName`: `string`; \}; `users`: `undefined`; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `firstName_contains`: `string`; `id`: `undefined`; `lastName_contains`: `string`; `skip`: `number`; \}; \}; `result`: \{ `data`: \{ `organizationsConnection`: `undefined`; `user`: `undefined`; `users`: `object`[]; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: `undefined`; \}; `result`: \{ `data`: \{ `organizationsConnection`: `object`[]; `user`: `undefined`; `users`: `undefined`; \}; \}; \})[] + +Defined in: [src/screens/Users/UsersMocks.ts:242](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/screens/Users/UsersMocks.ts#L242) diff --git a/docs/docs/auto-docs/setup/askAndSetDockerOption/askAndSetDockerOption/functions/default.md b/docs/docs/auto-docs/setup/askAndSetDockerOption/askAndSetDockerOption/functions/default.md new file mode 100644 index 0000000000..f1d75acf27 --- /dev/null +++ b/docs/docs/auto-docs/setup/askAndSetDockerOption/askAndSetDockerOption/functions/default.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Promise`\<`void`\> + +Defined in: [src/setup/askAndSetDockerOption/askAndSetDockerOption.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askAndSetDockerOption/askAndSetDockerOption.ts#L6) + +## Returns + +`Promise`\<`void`\> diff --git a/docs/docs/auto-docs/setup/askAndUpdatePort/askAndUpdatePort/functions/default.md b/docs/docs/auto-docs/setup/askAndUpdatePort/askAndUpdatePort/functions/default.md new file mode 100644 index 0000000000..34e03d7e92 --- /dev/null +++ b/docs/docs/auto-docs/setup/askAndUpdatePort/askAndUpdatePort/functions/default.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `Promise`\<`void`\> + +Defined in: [src/setup/askAndUpdatePort/askAndUpdatePort.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askAndUpdatePort/askAndUpdatePort.ts#L6) + +## Returns + +`Promise`\<`void`\> diff --git a/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/askForCustomPort.md b/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/askForCustomPort.md new file mode 100644 index 0000000000..d5575fce3b --- /dev/null +++ b/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/askForCustomPort.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: askForCustomPort() + +> **askForCustomPort**(): `Promise`\<`number`\> + +Defined in: [src/setup/askForCustomPort/askForCustomPort.ts:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askForCustomPort/askForCustomPort.ts#L32) + +## Returns + +`Promise`\<`number`\> diff --git a/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/reservedPortWarning.md b/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/reservedPortWarning.md new file mode 100644 index 0000000000..1a56cf49a2 --- /dev/null +++ b/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/reservedPortWarning.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: reservedPortWarning() + +> **reservedPortWarning**(`port`): `Promise`\<`boolean`\> + +Defined in: [src/setup/askForCustomPort/askForCustomPort.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askForCustomPort/askForCustomPort.ts#L19) + +## Parameters + +### port + +`number` + +## Returns + +`Promise`\<`boolean`\> diff --git a/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/validatePort.md b/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/validatePort.md new file mode 100644 index 0000000000..4b04389f0e --- /dev/null +++ b/docs/docs/auto-docs/setup/askForCustomPort/askForCustomPort/functions/validatePort.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: validatePort() + +> **validatePort**(`input`): `string` \| `boolean` + +Defined in: [src/setup/askForCustomPort/askForCustomPort.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askForCustomPort/askForCustomPort.ts#L6) + +## Parameters + +### input + +`string` + +## Returns + +`string` \| `boolean` diff --git a/docs/docs/auto-docs/setup/askForDocker/askForDocker/functions/askAndUpdateTalawaApiUrl.md b/docs/docs/auto-docs/setup/askForDocker/askForDocker/functions/askAndUpdateTalawaApiUrl.md new file mode 100644 index 0000000000..6d145d4f57 --- /dev/null +++ b/docs/docs/auto-docs/setup/askForDocker/askForDocker/functions/askAndUpdateTalawaApiUrl.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: askAndUpdateTalawaApiUrl() + +> **askAndUpdateTalawaApiUrl**(): `Promise`\<`void`\> + +Defined in: [src/setup/askForDocker/askForDocker.ts:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askForDocker/askForDocker.ts#L33) + +## Returns + +`Promise`\<`void`\> diff --git a/docs/docs/auto-docs/setup/askForDocker/askForDocker/functions/askForDocker.md b/docs/docs/auto-docs/setup/askForDocker/askForDocker/functions/askForDocker.md new file mode 100644 index 0000000000..6d1eba7cb8 --- /dev/null +++ b/docs/docs/auto-docs/setup/askForDocker/askForDocker/functions/askForDocker.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: askForDocker() + +> **askForDocker**(): `Promise`\<`string`\> + +Defined in: [src/setup/askForDocker/askForDocker.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askForDocker/askForDocker.ts#L12) + +## Returns + +`Promise`\<`string`\> diff --git a/docs/docs/auto-docs/setup/askForTalawaApiUrl/askForTalawaApiUrl/functions/askForTalawaApiUrl.md b/docs/docs/auto-docs/setup/askForTalawaApiUrl/askForTalawaApiUrl/functions/askForTalawaApiUrl.md new file mode 100644 index 0000000000..b22bcfa99c --- /dev/null +++ b/docs/docs/auto-docs/setup/askForTalawaApiUrl/askForTalawaApiUrl/functions/askForTalawaApiUrl.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: askForTalawaApiUrl() + +> **askForTalawaApiUrl**(): `Promise`\<`string`\> + +Defined in: [src/setup/askForTalawaApiUrl/askForTalawaApiUrl.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/askForTalawaApiUrl/askForTalawaApiUrl.ts#L3) + +## Returns + +`Promise`\<`string`\> diff --git a/docs/docs/auto-docs/setup/checkConnection/checkConnection/functions/checkConnection.md b/docs/docs/auto-docs/setup/checkConnection/checkConnection/functions/checkConnection.md new file mode 100644 index 0000000000..e6235109b4 --- /dev/null +++ b/docs/docs/auto-docs/setup/checkConnection/checkConnection/functions/checkConnection.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: checkConnection() + +> **checkConnection**(`url`): `Promise`\<`any`\> + +Defined in: [src/setup/checkConnection/checkConnection.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/checkConnection/checkConnection.ts#L1) + +## Parameters + +### url + +`string` + +## Returns + +`Promise`\<`any`\> diff --git a/docs/docs/auto-docs/setup/checkEnvFile/checkEnvFile/functions/checkEnvFile.md b/docs/docs/auto-docs/setup/checkEnvFile/checkEnvFile/functions/checkEnvFile.md new file mode 100644 index 0000000000..a6cd728fe7 --- /dev/null +++ b/docs/docs/auto-docs/setup/checkEnvFile/checkEnvFile/functions/checkEnvFile.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: checkEnvFile() + +> **checkEnvFile**(): `void` + +Defined in: [src/setup/checkEnvFile/checkEnvFile.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/checkEnvFile/checkEnvFile.ts#L6) + +## Returns + +`void` diff --git a/docs/docs/auto-docs/setup/updateEnvFile/updateEnvFile/functions/default.md b/docs/docs/auto-docs/setup/updateEnvFile/updateEnvFile/functions/default.md new file mode 100644 index 0000000000..dc7d5d8771 --- /dev/null +++ b/docs/docs/auto-docs/setup/updateEnvFile/updateEnvFile/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`key`, `value`): `void` + +Defined in: [src/setup/updateEnvFile/updateEnvFile.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/updateEnvFile/updateEnvFile.ts#L3) + +## Parameters + +### key + +`string` + +### value + +`string` + +## Returns + +`void` diff --git a/docs/docs/auto-docs/setup/validateRecaptcha/validateRecaptcha/functions/validateRecaptcha.md b/docs/docs/auto-docs/setup/validateRecaptcha/validateRecaptcha/functions/validateRecaptcha.md new file mode 100644 index 0000000000..4d23706a96 --- /dev/null +++ b/docs/docs/auto-docs/setup/validateRecaptcha/validateRecaptcha/functions/validateRecaptcha.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: validateRecaptcha() + +> **validateRecaptcha**(`string`): `boolean` + +Defined in: [src/setup/validateRecaptcha/validateRecaptcha.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/setup/validateRecaptcha/validateRecaptcha.ts#L1) + +## Parameters + +### string + +`string` + +## Returns + +`boolean` diff --git a/docs/docs/auto-docs/state/action-creators/functions/installPlugin.md b/docs/docs/auto-docs/state/action-creators/functions/installPlugin.md new file mode 100644 index 0000000000..e2fc16e4e1 --- /dev/null +++ b/docs/docs/auto-docs/state/action-creators/functions/installPlugin.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: installPlugin() + +> **installPlugin**(`plugin`): (`dispatch`) => `void` + +Defined in: [src/state/action-creators/index.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/action-creators/index.ts#L10) + +## Parameters + +### plugin + +`any` + +## Returns + +`Function` + +### Parameters + +#### dispatch + +`any` + +### Returns + +`void` diff --git a/docs/docs/auto-docs/state/action-creators/functions/removePlugin.md b/docs/docs/auto-docs/state/action-creators/functions/removePlugin.md new file mode 100644 index 0000000000..10e05ac0c9 --- /dev/null +++ b/docs/docs/auto-docs/state/action-creators/functions/removePlugin.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: removePlugin() + +> **removePlugin**(`plugin`): (`dispatch`) => `void` + +Defined in: [src/state/action-creators/index.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/action-creators/index.ts#L19) + +## Parameters + +### plugin + +`any` + +## Returns + +`Function` + +### Parameters + +#### dispatch + +`any` + +### Returns + +`void` diff --git a/docs/docs/auto-docs/state/action-creators/functions/updateInstalled.md b/docs/docs/auto-docs/state/action-creators/functions/updateInstalled.md new file mode 100644 index 0000000000..b26478664b --- /dev/null +++ b/docs/docs/auto-docs/state/action-creators/functions/updateInstalled.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: updateInstalled() + +> **updateInstalled**(`plugin`): (`dispatch`) => `void` + +Defined in: [src/state/action-creators/index.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/action-creators/index.ts#L1) + +## Parameters + +### plugin + +`any` + +## Returns + +`Function` + +### Parameters + +#### dispatch + +`any` + +### Returns + +`void` diff --git a/docs/docs/auto-docs/state/action-creators/functions/updatePluginLinks.md b/docs/docs/auto-docs/state/action-creators/functions/updatePluginLinks.md new file mode 100644 index 0000000000..fdbbc572d9 --- /dev/null +++ b/docs/docs/auto-docs/state/action-creators/functions/updatePluginLinks.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: updatePluginLinks() + +> **updatePluginLinks**(`plugins`): (`dispatch`) => `void` + +Defined in: [src/state/action-creators/index.ts:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/action-creators/index.ts#L28) + +## Parameters + +### plugins + +`any` + +## Returns + +`Function` + +### Parameters + +#### dispatch + +`any` + +### Returns + +`void` diff --git a/docs/docs/auto-docs/state/action-creators/functions/updateTargets.md b/docs/docs/auto-docs/state/action-creators/functions/updateTargets.md new file mode 100644 index 0000000000..2f0ad766e7 --- /dev/null +++ b/docs/docs/auto-docs/state/action-creators/functions/updateTargets.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: updateTargets() + +> **updateTargets**(`orgId`): (`dispatch`) => `void` + +Defined in: [src/state/action-creators/index.ts:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/action-creators/index.ts#L37) + +## Parameters + +### orgId + +`string` + +## Returns + +`Function` + +### Parameters + +#### dispatch + +`any` + +### Returns + +`void` diff --git a/docs/docs/auto-docs/state/helpers/Action/interfaces/InterfaceAction.md b/docs/docs/auto-docs/state/helpers/Action/interfaces/InterfaceAction.md new file mode 100644 index 0000000000..e8257193a5 --- /dev/null +++ b/docs/docs/auto-docs/state/helpers/Action/interfaces/InterfaceAction.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAction + +Defined in: [src/state/helpers/Action.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/helpers/Action.ts#L1) + +## Properties + +### payload + +> **payload**: `any` + +Defined in: [src/state/helpers/Action.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/helpers/Action.ts#L3) + +*** + +### type + +> **type**: `string` + +Defined in: [src/state/helpers/Action.ts:2](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/helpers/Action.ts#L2) diff --git a/docs/docs/auto-docs/state/hooks/functions/useAppDispatch.md b/docs/docs/auto-docs/state/hooks/functions/useAppDispatch.md new file mode 100644 index 0000000000..05ae2378f4 --- /dev/null +++ b/docs/docs/auto-docs/state/hooks/functions/useAppDispatch.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: useAppDispatch() + +> **useAppDispatch**\<`AppDispatch`\>(): `AppDispatch` + +Defined in: [src/state/hooks.ts:5](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/hooks.ts#L5) + +Returns the dispatch function from the Redux store. + +## Type Parameters + +• **AppDispatch** *extends* `ThunkDispatch`\<\{ `appRoutes`: \{ `components`: [`ComponentType`](../../reducers/routesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/routesReducer/type-aliases/TargetsType.md)[]; \}; `plugins`: `any`; `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)\> = `ThunkDispatch`\<\{ `appRoutes`: \{ `components`: [`ComponentType`](../../reducers/routesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/routesReducer/type-aliases/TargetsType.md)[]; \}; `plugins`: `any`; `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)\> + +The specific type of the dispatch function. + +## Returns + +`AppDispatch` + +The dispatch function from the Redux store. diff --git a/docs/docs/auto-docs/state/reducers/functions/reducers.md b/docs/docs/auto-docs/state/reducers/functions/reducers.md new file mode 100644 index 0000000000..705293abd7 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/functions/reducers.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Function: reducers() + +> **reducers**(`state`, `action`): `object` + +Defined in: [src/state/reducers/index.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/index.ts#L6) + +## Parameters + +### state + +\{ `appRoutes`: \{ `components`: [`ComponentType`](../routesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../routesReducer/type-aliases/TargetsType.md)[]; \}; `plugins`: `any`; `userRoutes`: \{ `components`: [`ComponentType`](../userRoutesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../userRoutesReducer/type-aliases/TargetsType.md)[]; \}; \} | `Partial`\<\{ `appRoutes`: `never`; `plugins`: `never`; `userRoutes`: `never`; \}\> + +### action + +[`InterfaceAction`](../../helpers/Action/interfaces/InterfaceAction.md) + +## Returns + +`object` + +### appRoutes + +> **appRoutes**: `object` = `routesReducer` + +#### appRoutes.components + +> **components**: [`ComponentType`](../routesReducer/type-aliases/ComponentType.md)[] + +#### appRoutes.targets + +> **targets**: [`TargetsType`](../routesReducer/type-aliases/TargetsType.md)[] + +### plugins + +> **plugins**: `any` = `pluginReducer` + +### userRoutes + +> **userRoutes**: `object` = `userRoutesReducer` + +#### userRoutes.components + +> **components**: [`ComponentType`](../userRoutesReducer/type-aliases/ComponentType.md)[] + +#### userRoutes.targets + +> **targets**: [`TargetsType`](../userRoutesReducer/type-aliases/TargetsType.md)[] diff --git a/docs/docs/auto-docs/state/reducers/pluginReducer/functions/default.md b/docs/docs/auto-docs/state/reducers/pluginReducer/functions/default.md new file mode 100644 index 0000000000..ab33042a77 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/pluginReducer/functions/default.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`state`, `action`): `any` + +Defined in: [src/state/reducers/pluginReducer.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/pluginReducer.ts#L3) + +## Parameters + +### state + +`any` = `INITIAL_STATE` + +### action + +[`InterfaceAction`](../../../helpers/Action/interfaces/InterfaceAction.md) + +## Returns + +`any` diff --git a/docs/docs/auto-docs/state/reducers/routesReducer/functions/default.md b/docs/docs/auto-docs/state/reducers/routesReducer/functions/default.md new file mode 100644 index 0000000000..99d14214dc --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/routesReducer/functions/default.md @@ -0,0 +1,37 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`state`, `action`): `object` + +Defined in: [src/state/reducers/routesReducer.ts:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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)[] diff --git a/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/ComponentType.md b/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/ComponentType.md new file mode 100644 index 0000000000..cdcb64f877 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/ComponentType.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Type Alias: ComponentType + +> **ComponentType**: `object` + +Defined in: [src/state/reducers/routesReducer.ts:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/routesReducer.ts#L55) + +## Type declaration + +### comp\_id + +> **comp\_id**: `string` \| `null` + +### component + +> **component**: `string` \| `null` + +### name + +> **name**: `string` + +### subTargets? + +> `optional` **subTargets**: `object`[] diff --git a/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/SubTargetType.md b/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/SubTargetType.md new file mode 100644 index 0000000000..17221f2ff5 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/SubTargetType.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Type Alias: SubTargetType + +> **SubTargetType**: `object` + +Defined in: [src/state/reducers/routesReducer.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/routesReducer.ts#L9) + +## Type declaration + +### comp\_id? + +> `optional` **comp\_id**: `string` + +### icon? + +> `optional` **icon**: `string` + +### name? + +> `optional` **name**: `string` + +### url + +> **url**: `string` diff --git a/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/TargetsType.md b/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/TargetsType.md new file mode 100644 index 0000000000..90169e68c0 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/TargetsType.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Type Alias: TargetsType + +> **TargetsType**: `object` + +Defined in: [src/state/reducers/routesReducer.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/routesReducer.ts#L3) + +## Type declaration + +### name + +> **name**: `string` + +### subTargets? + +> `optional` **subTargets**: [`SubTargetType`](SubTargetType.md)[] + +### url? + +> `optional` **url**: `string` diff --git a/docs/docs/auto-docs/state/reducers/type-aliases/RootState.md b/docs/docs/auto-docs/state/reducers/type-aliases/RootState.md new file mode 100644 index 0000000000..d23be264d1 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/type-aliases/RootState.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Type Alias: RootState + +> **RootState**: `ReturnType`\<*typeof* [`reducers`](../functions/reducers.md)\> + +Defined in: [src/state/reducers/index.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/index.ts#L12) diff --git a/docs/docs/auto-docs/state/reducers/userRoutesReducer/functions/default.md b/docs/docs/auto-docs/state/reducers/userRoutesReducer/functions/default.md new file mode 100644 index 0000000000..0e7e31019d --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/userRoutesReducer/functions/default.md @@ -0,0 +1,37 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`state`, `action`): `object` + +Defined in: [src/state/reducers/userRoutesReducer.ts:16](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/userRoutesReducer.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)[] diff --git a/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/ComponentType.md b/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/ComponentType.md new file mode 100644 index 0000000000..5dff755668 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/ComponentType.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Type Alias: ComponentType + +> **ComponentType**: `object` + +Defined in: [src/state/reducers/userRoutesReducer.ts:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/userRoutesReducer.ts#L32) + +## Type declaration + +### comp\_id + +> **comp\_id**: `string` \| `null` + +### component + +> **component**: `string` \| `null` + +### name + +> **name**: `string` + +### subTargets? + +> `optional` **subTargets**: `object`[] diff --git a/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/SubTargetType.md b/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/SubTargetType.md new file mode 100644 index 0000000000..d97091e5b0 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/SubTargetType.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Type Alias: SubTargetType + +> **SubTargetType**: `object` + +Defined in: [src/state/reducers/userRoutesReducer.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/userRoutesReducer.ts#L9) + +## Type declaration + +### comp\_id? + +> `optional` **comp\_id**: `string` + +### icon? + +> `optional` **icon**: `string` + +### name? + +> `optional` **name**: `string` + +### url + +> **url**: `string` diff --git a/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/TargetsType.md b/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/TargetsType.md new file mode 100644 index 0000000000..868f152584 --- /dev/null +++ b/docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/TargetsType.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Type Alias: TargetsType + +> **TargetsType**: `object` + +Defined in: [src/state/reducers/userRoutesReducer.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/reducers/userRoutesReducer.ts#L3) + +## Type declaration + +### name + +> **name**: `string` + +### subTargets? + +> `optional` **subTargets**: [`SubTargetType`](SubTargetType.md)[] + +### url? + +> `optional` **url**: `string` diff --git a/docs/docs/auto-docs/state/store/type-aliases/AppDispatch.md b/docs/docs/auto-docs/state/store/type-aliases/AppDispatch.md new file mode 100644 index 0000000000..5160bc4432 --- /dev/null +++ b/docs/docs/auto-docs/state/store/type-aliases/AppDispatch.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Type Alias: AppDispatch + +> **AppDispatch**: *typeof* `store.dispatch` + +Defined in: [src/state/store.ts:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/store.ts#L8) diff --git a/docs/docs/auto-docs/state/store/variables/store.md b/docs/docs/auto-docs/state/store/variables/store.md new file mode 100644 index 0000000000..7f6a1f026a --- /dev/null +++ b/docs/docs/auto-docs/state/store/variables/store.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: store + +> `const` **store**: `EnhancedStore`\<\{ `appRoutes`: \{ `components`: [`ComponentType`](../../reducers/routesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/routesReducer/type-aliases/TargetsType.md)[]; \}; `plugins`: `any`; `userRoutes`: \{ `components`: [`ComponentType`](../../reducers/userRoutesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/userRoutesReducer/type-aliases/TargetsType.md)[]; \}; \}, [`InterfaceAction`](../../helpers/Action/interfaces/InterfaceAction.md), `Tuple`\<\[`StoreEnhancer`\<\{\}\>, `StoreEnhancer`\]\>\> + +Defined in: [src/state/store.ts:4](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/state/store.ts#L4) diff --git a/docs/docs/auto-docs/subComponents/SortingButton/functions/default.md b/docs/docs/auto-docs/subComponents/SortingButton/functions/default.md new file mode 100644 index 0000000000..38a58a615a --- /dev/null +++ b/docs/docs/auto-docs/subComponents/SortingButton/functions/default.md @@ -0,0 +1,36 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` + +Defined in: [src/subComponents/SortingButton.tsx:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/subComponents/SortingButton.tsx#L43) + +SortingButton component renders a Dropdown with sorting options. +It allows users to select a sorting option and triggers a callback on selection. + +## Parameters + +### props + +`InterfaceSortingButtonProps` + +The properties for the SortingButton component. + +### deprecatedLegacyContext? + +`any` + +**Deprecated** + +**See** + +[React Docs](https://legacy.reactjs.org/docs/legacy-context.html#referencing-context-in-lifecycle-methods) + +## Returns + +`ReactNode` + +The rendered SortingButton component. diff --git a/docs/docs/auto-docs/utils/StaticMockLink/classes/StaticMockLink.md b/docs/docs/auto-docs/utils/StaticMockLink/classes/StaticMockLink.md new file mode 100644 index 0000000000..187eff152f --- /dev/null +++ b/docs/docs/auto-docs/utils/StaticMockLink/classes/StaticMockLink.md @@ -0,0 +1,96 @@ +[Admin Docs](/) + +*** + +# Class: StaticMockLink + +Defined in: [src/utils/StaticMockLink.ts:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L30) + +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 + +### new StaticMockLink() + +> **new StaticMockLink**(`mockedResponses`, `addTypename`): [`StaticMockLink`](StaticMockLink.md) + +Defined in: [src/utils/StaticMockLink.ts:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L35) + +#### Parameters + +##### mockedResponses + +readonly `MockedResponse`[] + +##### addTypename + +`boolean` = `true` + +#### Returns + +[`StaticMockLink`](StaticMockLink.md) + +#### Overrides + +`ApolloLink.constructor` + +## Properties + +### addTypename + +> **addTypename**: `boolean` = `true` + +Defined in: [src/utils/StaticMockLink.ts:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L32) + +*** + +### operation? + +> `optional` **operation**: `Operation` + +Defined in: [src/utils/StaticMockLink.ts:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L31) + +## Methods + +### addMockedResponse() + +> **addMockedResponse**(`mockedResponse`): `void` + +Defined in: [src/utils/StaticMockLink.ts:45](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L45) + +#### Parameters + +##### mockedResponse + +`MockedResponse` + +#### Returns + +`void` + +*** + +### request() + +> **request**(`operation`): `Observable`\<`FetchResult`\> + +Defined in: [src/utils/StaticMockLink.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L60) + +#### Parameters + +##### operation + +`any` + +#### Returns + +`Observable`\<`FetchResult`\> + +#### Overrides + +`ApolloLink.request` diff --git a/docs/docs/auto-docs/utils/StaticMockLink/functions/mockSingleLink.md b/docs/docs/auto-docs/utils/StaticMockLink/functions/mockSingleLink.md new file mode 100644 index 0000000000..2cdde46fed --- /dev/null +++ b/docs/docs/auto-docs/utils/StaticMockLink/functions/mockSingleLink.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: mockSingleLink() + +> **mockSingleLink**(...`mockedResponses`): [`InterfaceMockApolloLink`](../interfaces/InterfaceMockApolloLink.md) + +Defined in: [src/utils/StaticMockLink.ts:164](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L164) + +## Parameters + +### mockedResponses + +...`any`[] + +## Returns + +[`InterfaceMockApolloLink`](../interfaces/InterfaceMockApolloLink.md) diff --git a/docs/docs/auto-docs/utils/StaticMockLink/interfaces/InterfaceMockApolloLink.md b/docs/docs/auto-docs/utils/StaticMockLink/interfaces/InterfaceMockApolloLink.md new file mode 100644 index 0000000000..4a53796481 --- /dev/null +++ b/docs/docs/auto-docs/utils/StaticMockLink/interfaces/InterfaceMockApolloLink.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceMockApolloLink + +Defined in: [src/utils/StaticMockLink.ts:157](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L157) + +## Extends + +- `ApolloLink` + +## Properties + +### operation? + +> `optional` **operation**: `Operation` + +Defined in: [src/utils/StaticMockLink.ts:158](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/StaticMockLink.ts#L158) diff --git a/docs/docs/auto-docs/utils/chartToPdf/functions/exportDemographicsToCSV.md b/docs/docs/auto-docs/utils/chartToPdf/functions/exportDemographicsToCSV.md new file mode 100644 index 0000000000..af417ecb21 --- /dev/null +++ b/docs/docs/auto-docs/utils/chartToPdf/functions/exportDemographicsToCSV.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: exportDemographicsToCSV() + +> **exportDemographicsToCSV**(`selectedCategory`, `categoryLabels`, `categoryData`): `void` + +Defined in: [src/utils/chartToPdf.ts:80](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/chartToPdf.ts#L80) + +## Parameters + +### selectedCategory + +`string` + +### categoryLabels + +`string`[] + +### categoryData + +`number`[] + +## Returns + +`void` diff --git a/docs/docs/auto-docs/utils/chartToPdf/functions/exportToCSV.md b/docs/docs/auto-docs/utils/chartToPdf/functions/exportToCSV.md new file mode 100644 index 0000000000..edf56a4d7f --- /dev/null +++ b/docs/docs/auto-docs/utils/chartToPdf/functions/exportToCSV.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: exportToCSV() + +> **exportToCSV**(`data`, `filename`): `void` + +Defined in: [src/utils/chartToPdf.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/chartToPdf.ts#L3) + +## Parameters + +### data + +`CSVData` + +### filename + +`string` + +## Returns + +`void` diff --git a/docs/docs/auto-docs/utils/chartToPdf/functions/exportTrendsToCSV.md b/docs/docs/auto-docs/utils/chartToPdf/functions/exportTrendsToCSV.md new file mode 100644 index 0000000000..1a5ed83f01 --- /dev/null +++ b/docs/docs/auto-docs/utils/chartToPdf/functions/exportTrendsToCSV.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: exportTrendsToCSV() + +> **exportTrendsToCSV**(`eventLabels`, `attendeeCounts`, `maleCounts`, `femaleCounts`, `otherCounts`): `void` + +Defined in: [src/utils/chartToPdf.ts:50](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/chartToPdf.ts#L50) + +## Parameters + +### eventLabels + +`string`[] + +### attendeeCounts + +`number`[] + +### maleCounts + +`number`[] + +### femaleCounts + +`number`[] + +### otherCounts + +`number`[] + +## Returns + +`void` diff --git a/docs/docs/auto-docs/utils/convertToBase64/functions/default.md b/docs/docs/auto-docs/utils/convertToBase64/functions/default.md new file mode 100644 index 0000000000..0e8f711632 --- /dev/null +++ b/docs/docs/auto-docs/utils/convertToBase64/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`file`): `Promise`\<`string`\> + +Defined in: [src/utils/convertToBase64.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/convertToBase64.ts#L1) + +## Parameters + +### file + +`File` + +## Returns + +`Promise`\<`string`\> diff --git a/docs/docs/auto-docs/utils/currency/variables/currencyOptions.md b/docs/docs/auto-docs/utils/currency/variables/currencyOptions.md new file mode 100644 index 0000000000..d546330155 --- /dev/null +++ b/docs/docs/auto-docs/utils/currency/variables/currencyOptions.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: currencyOptions + +> `const` **currencyOptions**: `object`[] + +Defined in: [src/utils/currency.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/currency.ts#L1) + +## Type declaration + +### label + +> **label**: `string` = `'AED'` + +### value + +> **value**: `string` = `'AED'` diff --git a/docs/docs/auto-docs/utils/currency/variables/currencySymbols.md b/docs/docs/auto-docs/utils/currency/variables/currencySymbols.md new file mode 100644 index 0000000000..773251374e --- /dev/null +++ b/docs/docs/auto-docs/utils/currency/variables/currencySymbols.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Variable: currencySymbols + +> `const` **currencySymbols**: `object` + +Defined in: [src/utils/currency.ts:166](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/currency.ts#L166) + +## Index Signature + +\[`key`: `string`\]: `string` diff --git a/docs/docs/auto-docs/utils/dateFormatter/functions/formatDate.md b/docs/docs/auto-docs/utils/dateFormatter/functions/formatDate.md new file mode 100644 index 0000000000..fcf458317d --- /dev/null +++ b/docs/docs/auto-docs/utils/dateFormatter/functions/formatDate.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: formatDate() + +> **formatDate**(`dateString`): `string` + +Defined in: [src/utils/dateFormatter.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/dateFormatter.ts#L1) + +## Parameters + +### dateString + +`string` + +## Returns + +`string` diff --git a/docs/docs/auto-docs/utils/errorHandler/functions/errorHandler.md b/docs/docs/auto-docs/utils/errorHandler/functions/errorHandler.md new file mode 100644 index 0000000000..6c3be9d857 --- /dev/null +++ b/docs/docs/auto-docs/utils/errorHandler/functions/errorHandler.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Function: errorHandler() + +> **errorHandler**(`a`, `error`): `void` + +Defined in: [src/utils/errorHandler.tsx:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/errorHandler.tsx#L10) + +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` diff --git a/docs/docs/auto-docs/utils/fieldTypes/variables/default.md b/docs/docs/auto-docs/utils/fieldTypes/variables/default.md new file mode 100644 index 0000000000..55e8f7688e --- /dev/null +++ b/docs/docs/auto-docs/utils/fieldTypes/variables/default.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: default + +> `const` **default**: `string`[] + +Defined in: [src/utils/fieldTypes.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/fieldTypes.ts#L1) diff --git a/docs/docs/auto-docs/utils/formEnumFields/variables/countryOptions.md b/docs/docs/auto-docs/utils/formEnumFields/variables/countryOptions.md new file mode 100644 index 0000000000..d71401dc96 --- /dev/null +++ b/docs/docs/auto-docs/utils/formEnumFields/variables/countryOptions.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: countryOptions + +> `const` **countryOptions**: `object`[] + +Defined in: [src/utils/formEnumFields.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/formEnumFields.ts#L1) + +## Type declaration + +### label + +> **label**: `string` = `'Afghanistan'` + +### value + +> **value**: `string` = `'af'` diff --git a/docs/docs/auto-docs/utils/formEnumFields/variables/educationGradeEnum.md b/docs/docs/auto-docs/utils/formEnumFields/variables/educationGradeEnum.md new file mode 100644 index 0000000000..cdbaa1a601 --- /dev/null +++ b/docs/docs/auto-docs/utils/formEnumFields/variables/educationGradeEnum.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: educationGradeEnum + +> `const` **educationGradeEnum**: `object`[] + +Defined in: [src/utils/formEnumFields.ts:202](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/formEnumFields.ts#L202) + +## Type declaration + +### label + +> **label**: `string` = `'No-Grade'` + +### value + +> **value**: `string` = `'NO_GRADE'` diff --git a/docs/docs/auto-docs/utils/formEnumFields/variables/employmentStatusEnum.md b/docs/docs/auto-docs/utils/formEnumFields/variables/employmentStatusEnum.md new file mode 100644 index 0000000000..df1cb0fbbc --- /dev/null +++ b/docs/docs/auto-docs/utils/formEnumFields/variables/employmentStatusEnum.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: employmentStatusEnum + +> `const` **employmentStatusEnum**: `object`[] + +Defined in: [src/utils/formEnumFields.ts:311](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/formEnumFields.ts#L311) + +## Type declaration + +### label + +> **label**: `string` = `'Full-Time'` + +### value + +> **value**: `string` = `'FULL_TIME'` diff --git a/docs/docs/auto-docs/utils/formEnumFields/variables/genderEnum.md b/docs/docs/auto-docs/utils/formEnumFields/variables/genderEnum.md new file mode 100644 index 0000000000..59ee5eabf8 --- /dev/null +++ b/docs/docs/auto-docs/utils/formEnumFields/variables/genderEnum.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: genderEnum + +> `const` **genderEnum**: `object`[] + +Defined in: [src/utils/formEnumFields.ts:296](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/formEnumFields.ts#L296) + +## Type declaration + +### label + +> **label**: `string` = `'Male'` + +### value + +> **value**: `string` = `'MALE'` diff --git a/docs/docs/auto-docs/utils/formEnumFields/variables/maritalStatusEnum.md b/docs/docs/auto-docs/utils/formEnumFields/variables/maritalStatusEnum.md new file mode 100644 index 0000000000..d86b03f8d9 --- /dev/null +++ b/docs/docs/auto-docs/utils/formEnumFields/variables/maritalStatusEnum.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: maritalStatusEnum + +> `const` **maritalStatusEnum**: `object`[] + +Defined in: [src/utils/formEnumFields.ts:269](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/formEnumFields.ts#L269) + +## Type declaration + +### label + +> **label**: `string` = `'Single'` + +### value + +> **value**: `string` = `'SINGLE'` diff --git a/docs/docs/auto-docs/utils/formEnumFields/variables/userRoleEnum.md b/docs/docs/auto-docs/utils/formEnumFields/variables/userRoleEnum.md new file mode 100644 index 0000000000..daf4a100cb --- /dev/null +++ b/docs/docs/auto-docs/utils/formEnumFields/variables/userRoleEnum.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: userRoleEnum + +> `const` **userRoleEnum**: `object`[] + +Defined in: [src/utils/formEnumFields.ts:326](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/formEnumFields.ts#L326) + +## Type declaration + +### label + +> **label**: `string` = `'User'` + +### value + +> **value**: `string` = `'USER'` diff --git a/docs/docs/auto-docs/utils/getOrganizationId/functions/default.md b/docs/docs/auto-docs/utils/getOrganizationId/functions/default.md new file mode 100644 index 0000000000..1eae6b4989 --- /dev/null +++ b/docs/docs/auto-docs/utils/getOrganizationId/functions/default.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(`url`): `string` + +Defined in: [src/utils/getOrganizationId.ts:2](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/getOrganizationId.ts#L2) + +## Parameters + +### url + +`string` + +## Returns + +`string` diff --git a/docs/docs/auto-docs/utils/getRefreshToken/functions/refreshToken.md b/docs/docs/auto-docs/utils/getRefreshToken/functions/refreshToken.md new file mode 100644 index 0000000000..c9a34ec00c --- /dev/null +++ b/docs/docs/auto-docs/utils/getRefreshToken/functions/refreshToken.md @@ -0,0 +1,13 @@ +[Admin Docs](/) + +*** + +# Function: refreshToken() + +> **refreshToken**(): `Promise`\<`boolean`\> + +Defined in: [src/utils/getRefreshToken.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/getRefreshToken.ts#L6) + +## Returns + +`Promise`\<`boolean`\> diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryInfo.md new file mode 100644 index 0000000000..d5cb82c9f4 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryInfo.md @@ -0,0 +1,59 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceActionItemCategoryInfo + +Defined in: [src/utils/interfaces.ts:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L31) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L32) + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L35) + +*** + +### creator + +> **creator**: `object` + +Defined in: [src/utils/interfaces.ts:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L36) + +#### \_id + +> **\_id**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### isDisabled + +> **isDisabled**: `boolean` + +Defined in: [src/utils/interfaces.ts:34](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L34) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:33](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L33) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryList.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryList.md new file mode 100644 index 0000000000..6184440f40 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemCategoryList.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceActionItemCategoryList + +Defined in: [src/utils/interfaces.ts:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L39) + +## Properties + +### actionItemCategoriesByOrganization + +> **actionItemCategoriesByOrganization**: [`InterfaceActionItemCategoryInfo`](InterfaceActionItemCategoryInfo.md)[] + +Defined in: [src/utils/interfaces.ts:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L40) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemInfo.md new file mode 100644 index 0000000000..300c1e6e99 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemInfo.md @@ -0,0 +1,151 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceActionItemInfo + +Defined in: [src/utils/interfaces.ts:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L43) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L44) + +*** + +### actionItemCategory + +> **actionItemCategory**: `object` + +Defined in: [src/utils/interfaces.ts:50](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L50) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +*** + +### allottedHours + +> **allottedHours**: `number` + +Defined in: [src/utils/interfaces.ts:65](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L65) + +*** + +### assignee + +> **assignee**: [`InterfaceEventVolunteerInfo`](InterfaceEventVolunteerInfo.md) + +Defined in: [src/utils/interfaces.ts:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L46) + +*** + +### assigneeGroup + +> **assigneeGroup**: [`InterfaceVolunteerGroupInfo`](InterfaceVolunteerGroupInfo.md) + +Defined in: [src/utils/interfaces.ts:47](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L47) + +*** + +### assigneeType + +> **assigneeType**: `"User"` \| `"EventVolunteerGroup"` \| `"EventVolunteer"` + +Defined in: [src/utils/interfaces.ts:45](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L45) + +*** + +### assigneeUser + +> **assigneeUser**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +Defined in: [src/utils/interfaces.ts:48](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L48) + +*** + +### assigner + +> **assigner**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +Defined in: [src/utils/interfaces.ts:49](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L49) + +*** + +### assignmentDate + +> **assignmentDate**: `Date` + +Defined in: [src/utils/interfaces.ts:56](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L56) + +*** + +### completionDate + +> **completionDate**: `Date` + +Defined in: [src/utils/interfaces.ts:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L58) + +*** + +### creator + +> **creator**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +Defined in: [src/utils/interfaces.ts:64](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L64) + +*** + +### dueDate + +> **dueDate**: `Date` + +Defined in: [src/utils/interfaces.ts:57](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L57) + +*** + +### event + +> **event**: `object` + +Defined in: [src/utils/interfaces.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L60) + +#### \_id + +> **\_id**: `string` + +#### title + +> **title**: `string` + +*** + +### isCompleted + +> **isCompleted**: `boolean` + +Defined in: [src/utils/interfaces.ts:59](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L59) + +*** + +### postCompletionNotes + +> **postCompletionNotes**: `string` + +Defined in: [src/utils/interfaces.ts:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L55) + +*** + +### preCompletionNotes + +> **preCompletionNotes**: `string` + +Defined in: [src/utils/interfaces.ts:54](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L54) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemList.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemList.md new file mode 100644 index 0000000000..9f085e5dc6 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceActionItemList.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceActionItemList + +Defined in: [src/utils/interfaces.ts:68](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L68) + +## Properties + +### actionItemsByOrganization + +> **actionItemsByOrganization**: [`InterfaceActionItemInfo`](InterfaceActionItemInfo.md)[] + +Defined in: [src/utils/interfaces.ts:69](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L69) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md new file mode 100644 index 0000000000..1e9e807216 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAddOnSpotAttendeeProps + +Defined in: [src/utils/interfaces.ts:546](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L546) + +## Properties + +### handleClose() + +> **handleClose**: () => `void` + +Defined in: [src/utils/interfaces.ts:548](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L548) + +#### Returns + +`void` + +*** + +### reloadMembers() + +> **reloadMembers**: () => `void` + +Defined in: [src/utils/interfaces.ts:549](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L549) + +#### Returns + +`void` + +*** + +### show + +> **show**: `boolean` + +Defined in: [src/utils/interfaces.ts:547](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L547) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddress.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddress.md new file mode 100644 index 0000000000..b3623298d4 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddress.md @@ -0,0 +1,71 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAddress + +Defined in: [src/utils/interfaces.ts:453](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L453) + +## Properties + +### city + +> **city**: `string` + +Defined in: [src/utils/interfaces.ts:454](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L454) + +*** + +### countryCode + +> **countryCode**: `string` + +Defined in: [src/utils/interfaces.ts:455](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L455) + +*** + +### dependentLocality + +> **dependentLocality**: `string` + +Defined in: [src/utils/interfaces.ts:456](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L456) + +*** + +### line1 + +> **line1**: `string` + +Defined in: [src/utils/interfaces.ts:457](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L457) + +*** + +### line2 + +> **line2**: `string` + +Defined in: [src/utils/interfaces.ts:458](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L458) + +*** + +### postalCode + +> **postalCode**: `string` + +Defined in: [src/utils/interfaces.ts:459](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L459) + +*** + +### sortingCode + +> **sortingCode**: `string` + +Defined in: [src/utils/interfaces.ts:460](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L460) + +*** + +### state + +> **state**: `string` + +Defined in: [src/utils/interfaces.ts:461](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L461) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md new file mode 100644 index 0000000000..b834dc185b --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAgendaItemCategoryInfo + +Defined in: [src/utils/interfaces.ts:531](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L531) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:532](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L532) + +*** + +### createdBy + +> **createdBy**: `object` + +Defined in: [src/utils/interfaces.ts:535](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L535) + +#### \_id + +> **\_id**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:534](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L534) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:533](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L533) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryList.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryList.md new file mode 100644 index 0000000000..d30ea21e31 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemCategoryList.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAgendaItemCategoryList + +Defined in: [src/utils/interfaces.ts:542](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L542) + +## Properties + +### agendaItemCategoriesByOrganization + +> **agendaItemCategoriesByOrganization**: [`InterfaceAgendaItemCategoryInfo`](InterfaceAgendaItemCategoryInfo.md)[] + +Defined in: [src/utils/interfaces.ts:543](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L543) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemInfo.md new file mode 100644 index 0000000000..86433f4f06 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemInfo.md @@ -0,0 +1,151 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAgendaItemInfo + +Defined in: [src/utils/interfaces.ts:560](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L560) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:561](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L561) + +*** + +### attachments + +> **attachments**: `string`[] + +Defined in: [src/utils/interfaces.ts:565](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L565) + +*** + +### categories + +> **categories**: `object`[] + +Defined in: [src/utils/interfaces.ts:578](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L578) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +*** + +### createdBy + +> **createdBy**: `object` + +Defined in: [src/utils/interfaces.ts:566](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L566) + +#### \_id + +> **\_id**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:563](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L563) + +*** + +### duration + +> **duration**: `string` + +Defined in: [src/utils/interfaces.ts:564](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L564) + +*** + +### organization + +> **organization**: `object` + +Defined in: [src/utils/interfaces.ts:582](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L582) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +*** + +### relatedEvent + +> **relatedEvent**: `object` + +Defined in: [src/utils/interfaces.ts:586](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L586) + +#### \_id + +> **\_id**: `string` + +#### title + +> **title**: `string` + +*** + +### sequence + +> **sequence**: `number` + +Defined in: [src/utils/interfaces.ts:577](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L577) + +*** + +### title + +> **title**: `string` + +Defined in: [src/utils/interfaces.ts:562](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L562) + +*** + +### urls + +> **urls**: `string`[] + +Defined in: [src/utils/interfaces.ts:571](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L571) + +*** + +### users + +> **users**: `object`[] + +Defined in: [src/utils/interfaces.ts:572](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L572) + +#### \_id + +> **\_id**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemList.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemList.md new file mode 100644 index 0000000000..e0c583a5b4 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAgendaItemList.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceAgendaItemList + +Defined in: [src/utils/interfaces.ts:592](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L592) + +## Properties + +### agendaItemByEvent + +> **agendaItemByEvent**: [`InterfaceAgendaItemInfo`](InterfaceAgendaItemInfo.md)[] + +Defined in: [src/utils/interfaces.ts:593](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L593) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceBaseEvent.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceBaseEvent.md new file mode 100644 index 0000000000..5da55929bd --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceBaseEvent.md @@ -0,0 +1,92 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceBaseEvent + +Defined in: [src/utils/interfaces.ts:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L18) + +## Extended by + +- [`InterfaceQueryOrganizationEventListItem`](InterfaceQueryOrganizationEventListItem.md) +- [`InterfaceUserEvents`](InterfaceUserEvents.md) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L19) + +*** + +### allDay + +> **allDay**: `boolean` + +Defined in: [src/utils/interfaces.ts:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L27) + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L21) + +*** + +### endDate + +> **endDate**: `string` + +Defined in: [src/utils/interfaces.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L23) + +*** + +### endTime + +> **endTime**: `string` + +Defined in: [src/utils/interfaces.ts:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L26) + +*** + +### location + +> **location**: `string` + +Defined in: [src/utils/interfaces.ts:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L24) + +*** + +### recurring + +> **recurring**: `boolean` + +Defined in: [src/utils/interfaces.ts:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L28) + +*** + +### startDate + +> **startDate**: `string` + +Defined in: [src/utils/interfaces.ts:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L22) + +*** + +### startTime + +> **startTime**: `string` + +Defined in: [src/utils/interfaces.ts:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L25) + +*** + +### title + +> **title**: `string` + +Defined in: [src/utils/interfaces.ts:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L20) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfo.md new file mode 100644 index 0000000000..cc115afd92 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfo.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCampaignInfo + +Defined in: [src/utils/interfaces.ts:362](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L362) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:363](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L363) + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:368](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L368) + +*** + +### currency + +> **currency**: `string` + +Defined in: [src/utils/interfaces.ts:369](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L369) + +*** + +### endDate + +> **endDate**: `Date` + +Defined in: [src/utils/interfaces.ts:367](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L367) + +*** + +### fundingGoal + +> **fundingGoal**: `number` + +Defined in: [src/utils/interfaces.ts:365](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L365) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:364](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L364) + +*** + +### startDate + +> **startDate**: `Date` + +Defined in: [src/utils/interfaces.ts:366](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L366) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md new file mode 100644 index 0000000000..65c3ddd584 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCreateFund + +Defined in: [src/utils/interfaces.ts:463](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L463) + +## Properties + +### fundName + +> **fundName**: `string` + +Defined in: [src/utils/interfaces.ts:464](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L464) + +*** + +### fundRef + +> **fundRef**: `string` + +Defined in: [src/utils/interfaces.ts:465](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L465) + +*** + +### isArchived + +> **isArchived**: `boolean` + +Defined in: [src/utils/interfaces.ts:467](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L467) + +*** + +### isDefault + +> **isDefault**: `boolean` + +Defined in: [src/utils/interfaces.ts:466](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L466) + +*** + +### taxDeductible + +> **taxDeductible**: `boolean` + +Defined in: [src/utils/interfaces.ts:468](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L468) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md new file mode 100644 index 0000000000..f5734a37ff --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCreatePledge + +Defined in: [src/utils/interfaces.ts:508](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L508) + +## Properties + +### pledgeAmount + +> **pledgeAmount**: `number` + +Defined in: [src/utils/interfaces.ts:510](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L510) + +*** + +### pledgeCurrency + +> **pledgeCurrency**: `string` + +Defined in: [src/utils/interfaces.ts:511](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L511) + +*** + +### pledgeEndDate + +> **pledgeEndDate**: `Date` + +Defined in: [src/utils/interfaces.ts:513](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L513) + +*** + +### pledgeStartDate + +> **pledgeStartDate**: `Date` + +Defined in: [src/utils/interfaces.ts:512](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L512) + +*** + +### pledgeUsers + +> **pledgeUsers**: [`InterfaceUserInfo`](InterfaceUserInfo.md)[] + +Defined in: [src/utils/interfaces.ts:509](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L509) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateVolunteerGroup.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateVolunteerGroup.md new file mode 100644 index 0000000000..d089832c7d --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateVolunteerGroup.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCreateVolunteerGroup + +Defined in: [src/utils/interfaces.ts:648](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L648) + +## Properties + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:650](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L650) + +*** + +### leader + +> **leader**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +Defined in: [src/utils/interfaces.ts:651](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L651) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:649](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L649) + +*** + +### volunteersRequired + +> **volunteersRequired**: `number` + +Defined in: [src/utils/interfaces.ts:652](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L652) + +*** + +### volunteerUsers + +> **volunteerUsers**: [`InterfaceUserInfo`](InterfaceUserInfo.md)[] + +Defined in: [src/utils/interfaces.ts:653](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L653) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCustomFieldData.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCustomFieldData.md new file mode 100644 index 0000000000..82c4c6ae33 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCustomFieldData.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceCustomFieldData + +Defined in: [src/utils/interfaces.ts:600](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L600) + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:602](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L602) + +*** + +### type + +> **type**: `string` + +Defined in: [src/utils/interfaces.ts:601](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L601) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md new file mode 100644 index 0000000000..b39d80c7d7 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md @@ -0,0 +1,71 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceEventVolunteerInfo + +Defined in: [src/utils/interfaces.ts:605](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L605) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:606](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L606) + +*** + +### assignments + +> **assignments**: `object`[] + +Defined in: [src/utils/interfaces.ts:610](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L610) + +#### \_id + +> **\_id**: `string` + +*** + +### groups + +> **groups**: `object`[] + +Defined in: [src/utils/interfaces.ts:613](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L613) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +#### volunteers + +> **volunteers**: `object`[] + +*** + +### hasAccepted + +> **hasAccepted**: `boolean` + +Defined in: [src/utils/interfaces.ts:607](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L607) + +*** + +### hoursVolunteered + +> **hoursVolunteered**: `number` + +Defined in: [src/utils/interfaces.ts:608](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L608) + +*** + +### user + +> **user**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +Defined in: [src/utils/interfaces.ts:609](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L609) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFormData.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFormData.md new file mode 100644 index 0000000000..14ee822290 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFormData.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceFormData + +Defined in: [src/utils/interfaces.ts:552](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L552) + +## Properties + +### email + +> **email**: `string` + +Defined in: [src/utils/interfaces.ts:555](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L555) + +*** + +### firstName + +> **firstName**: `string` + +Defined in: [src/utils/interfaces.ts:553](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L553) + +*** + +### gender + +> **gender**: `string` + +Defined in: [src/utils/interfaces.ts:557](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L557) + +*** + +### lastName + +> **lastName**: `string` + +Defined in: [src/utils/interfaces.ts:554](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L554) + +*** + +### phoneNo + +> **phoneNo**: `string` + +Defined in: [src/utils/interfaces.ts:556](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L556) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundInfo.md new file mode 100644 index 0000000000..68d4da72d7 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundInfo.md @@ -0,0 +1,91 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceFundInfo + +Defined in: [src/utils/interfaces.ts:351](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L351) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:352](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L352) + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:358](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L358) + +*** + +### creator + +> **creator**: `object` + +Defined in: [src/utils/interfaces.ts:360](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L360) + +#### \_id + +> **\_id**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### isArchived + +> **isArchived**: `boolean` + +Defined in: [src/utils/interfaces.ts:356](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L356) + +*** + +### isDefault + +> **isDefault**: `boolean` + +Defined in: [src/utils/interfaces.ts:357](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L357) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:353](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L353) + +*** + +### organizationId + +> **organizationId**: `string` + +Defined in: [src/utils/interfaces.ts:359](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L359) + +*** + +### refrenceNumber + +> **refrenceNumber**: `string` + +Defined in: [src/utils/interfaces.ts:354](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L354) + +*** + +### taxDeductible + +> **taxDeductible**: `boolean` + +Defined in: [src/utils/interfaces.ts:355](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L355) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMapType.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMapType.md new file mode 100644 index 0000000000..dc2d0de9d7 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMapType.md @@ -0,0 +1,11 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceMapType + +Defined in: [src/utils/interfaces.ts:596](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L596) + +## Indexable + +\[`key`: `string`\]: `string` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMemberInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMemberInfo.md new file mode 100644 index 0000000000..5a38e764a5 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMemberInfo.md @@ -0,0 +1,67 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceMemberInfo + +Defined in: [src/utils/interfaces.ts:79](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L79) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:80](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L80) + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:85](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L85) + +*** + +### email + +> **email**: `string` + +Defined in: [src/utils/interfaces.ts:83](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L83) + +*** + +### firstName + +> **firstName**: `string` + +Defined in: [src/utils/interfaces.ts:81](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L81) + +*** + +### image + +> **image**: `string` + +Defined in: [src/utils/interfaces.ts:84](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L84) + +*** + +### lastName + +> **lastName**: `string` + +Defined in: [src/utils/interfaces.ts:82](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L82) + +*** + +### organizationsBlockedBy + +> **organizationsBlockedBy**: `object`[] + +Defined in: [src/utils/interfaces.ts:86](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L86) + +#### \_id + +> **\_id**: `string` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMembersList.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMembersList.md new file mode 100644 index 0000000000..18b001a129 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMembersList.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceMembersList + +Defined in: [src/utils/interfaces.ts:72](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L72) + +## Properties + +### organizations + +> **organizations**: `object`[] + +Defined in: [src/utils/interfaces.ts:73](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L73) + +#### \_id + +> **\_id**: `string` + +#### members + +> **members**: [`InterfaceMemberInfo`](InterfaceMemberInfo.md)[] diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md new file mode 100644 index 0000000000..3c4a4c389d --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md @@ -0,0 +1,91 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceOrgConnectionInfoType + +Defined in: [src/utils/interfaces.ts:91](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L91) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:92](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L92) + +*** + +### address + +> **address**: [`InterfaceAddress`](InterfaceAddress.md) + +Defined in: [src/utils/interfaces.ts:107](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L107) + +*** + +### admins + +> **admins**: `object`[] + +Defined in: [src/utils/interfaces.ts:103](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L103) + +#### \_id + +> **\_id**: `string` + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:106](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L106) + +*** + +### creator + +> **creator**: `object` + +Defined in: [src/utils/interfaces.ts:94](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L94) + +#### \_id + +> **\_id**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### image + +> **image**: `string` + +Defined in: [src/utils/interfaces.ts:93](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L93) + +*** + +### members + +> **members**: `object`[] + +Defined in: [src/utils/interfaces.ts:100](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L100) + +#### \_id + +> **\_id**: `string` + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:99](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L99) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionType.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionType.md new file mode 100644 index 0000000000..0322e5f928 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionType.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceOrgConnectionType + +Defined in: [src/utils/interfaces.ts:109](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L109) + +## Properties + +### organizationsConnection + +> **organizationsConnection**: [`InterfaceOrgConnectionInfoType`](InterfaceOrgConnectionInfoType.md)[] + +Defined in: [src/utils/interfaces.ts:110](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L110) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfo.md new file mode 100644 index 0000000000..9d6302426e --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfo.md @@ -0,0 +1,75 @@ +[Admin Docs](/) + +*** + +# Interface: InterfacePledgeInfo + +Defined in: [src/utils/interfaces.ts:371](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L371) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:372](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L372) + +*** + +### amount + +> **amount**: `number` + +Defined in: [src/utils/interfaces.ts:374](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L374) + +*** + +### campaign? + +> `optional` **campaign**: `object` + +Defined in: [src/utils/interfaces.ts:373](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L373) + +#### \_id + +> **\_id**: `string` + +#### endDate + +> **endDate**: `Date` + +#### name + +> **name**: `string` + +*** + +### currency + +> **currency**: `string` + +Defined in: [src/utils/interfaces.ts:375](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L375) + +*** + +### endDate + +> **endDate**: `string` + +Defined in: [src/utils/interfaces.ts:376](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L376) + +*** + +### startDate + +> **startDate**: `string` + +Defined in: [src/utils/interfaces.ts:377](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L377) + +*** + +### users + +> **users**: [`InterfaceUserInfo`](InterfaceUserInfo.md)[] + +Defined in: [src/utils/interfaces.ts:378](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L378) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostCard.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostCard.md new file mode 100644 index 0000000000..25bae7f0e6 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostCard.md @@ -0,0 +1,171 @@ +[Admin Docs](/) + +*** + +# Interface: InterfacePostCard + +Defined in: [src/utils/interfaces.ts:471](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L471) + +## Properties + +### commentCount + +> **commentCount**: `number` + +Defined in: [src/utils/interfaces.ts:485](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L485) + +*** + +### comments + +> **comments**: `object`[] + +Defined in: [src/utils/interfaces.ts:486](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L486) + +#### 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` + +#### likedBy + +> **likedBy**: `object`[] + +#### text + +> **text**: `string` + +*** + +### creator + +> **creator**: `object` + +Defined in: [src/utils/interfaces.ts:473](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L473) + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### id + +> **id**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### fetchPosts() + +> **fetchPosts**: () => `void` + +Defined in: [src/utils/interfaces.ts:505](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L505) + +#### Returns + +`void` + +*** + +### id + +> **id**: `string` + +Defined in: [src/utils/interfaces.ts:472](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L472) + +*** + +### image + +> **image**: `string` + +Defined in: [src/utils/interfaces.ts:480](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L480) + +*** + +### likeCount + +> **likeCount**: `number` + +Defined in: [src/utils/interfaces.ts:484](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L484) + +*** + +### likedBy + +> **likedBy**: `object`[] + +Defined in: [src/utils/interfaces.ts:500](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L500) + +#### firstName + +> **firstName**: `string` + +#### id + +> **id**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### postedAt + +> **postedAt**: `string` + +Defined in: [src/utils/interfaces.ts:479](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L479) + +*** + +### text + +> **text**: `string` + +Defined in: [src/utils/interfaces.ts:482](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L482) + +*** + +### title + +> **title**: `string` + +Defined in: [src/utils/interfaces.ts:483](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L483) + +*** + +### video + +> **video**: `string` + +Defined in: [src/utils/interfaces.ts:481](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L481) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostForm.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostForm.md new file mode 100644 index 0000000000..fccd1b273c --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostForm.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfacePostForm + +Defined in: [src/utils/interfaces.ts:173](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L173) + +## Properties + +### pinned + +> **pinned**: `boolean` + +Defined in: [src/utils/interfaces.ts:178](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L178) + +*** + +### postinfo + +> **postinfo**: `string` + +Defined in: [src/utils/interfaces.ts:175](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L175) + +*** + +### postphoto + +> **postphoto**: `string` + +Defined in: [src/utils/interfaces.ts:176](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L176) + +*** + +### posttitle + +> **posttitle**: `string` + +Defined in: [src/utils/interfaces.ts:174](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L174) + +*** + +### postvideo + +> **postvideo**: `string` + +Defined in: [src/utils/interfaces.ts:177](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L177) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryBlockPageMemberListItem.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryBlockPageMemberListItem.md new file mode 100644 index 0000000000..3b0d28e29f --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryBlockPageMemberListItem.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryBlockPageMemberListItem + +Defined in: [src/utils/interfaces.ts:386](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L386) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:387](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L387) + +*** + +### email + +> **email**: `string` + +Defined in: [src/utils/interfaces.ts:390](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L390) + +*** + +### firstName + +> **firstName**: `string` + +Defined in: [src/utils/interfaces.ts:388](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L388) + +*** + +### lastName + +> **lastName**: `string` + +Defined in: [src/utils/interfaces.ts:389](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L389) + +*** + +### organizationsBlockedBy + +> **organizationsBlockedBy**: `object`[] + +Defined in: [src/utils/interfaces.ts:391](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L391) + +#### \_id + +> **\_id**: `string` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md new file mode 100644 index 0000000000..e61a6b0392 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md @@ -0,0 +1,67 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryFundCampaignsPledges + +Defined in: [src/utils/interfaces.ts:340](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L340) + +## Properties + +### currency + +> **currency**: `string` + +Defined in: [src/utils/interfaces.ts:346](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L346) + +*** + +### endDate + +> **endDate**: `Date` + +Defined in: [src/utils/interfaces.ts:348](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L348) + +*** + +### fundId + +> **fundId**: `object` + +Defined in: [src/utils/interfaces.ts:341](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L341) + +#### name + +> **name**: `string` + +*** + +### fundingGoal + +> **fundingGoal**: `number` + +Defined in: [src/utils/interfaces.ts:345](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L345) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:344](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L344) + +*** + +### pledges + +> **pledges**: [`InterfacePledgeInfo`](InterfacePledgeInfo.md)[] + +Defined in: [src/utils/interfaces.ts:349](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L349) + +*** + +### startDate + +> **startDate**: `Date` + +Defined in: [src/utils/interfaces.ts:347](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L347) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryMembershipRequestsListItem.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryMembershipRequestsListItem.md new file mode 100644 index 0000000000..8372dd7fca --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryMembershipRequestsListItem.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryMembershipRequestsListItem + +Defined in: [src/utils/interfaces.ts:516](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L516) + +## Properties + +### organizations + +> **organizations**: `object`[] + +Defined in: [src/utils/interfaces.ts:517](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L517) + +#### \_id + +> **\_id**: `string` + +#### membershipRequests + +> **membershipRequests**: `object`[] diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationAdvertisementListItem.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationAdvertisementListItem.md new file mode 100644 index 0000000000..d3bab2aa50 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationAdvertisementListItem.md @@ -0,0 +1,43 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryOrganizationAdvertisementListItem + +Defined in: [src/utils/interfaces.ts:296](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L296) + +## Properties + +### advertisements + +> **advertisements**: `object` + +Defined in: [src/utils/interfaces.ts:297](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L297) + +#### 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` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationEventListItem.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationEventListItem.md new file mode 100644 index 0000000000..bf9367313a --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationEventListItem.md @@ -0,0 +1,147 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryOrganizationEventListItem + +Defined in: [src/utils/interfaces.ts:380](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L380) + +## Extends + +- [`InterfaceBaseEvent`](InterfaceBaseEvent.md) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L19) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`_id`](InterfaceBaseEvent.md#_id) + +*** + +### allDay + +> **allDay**: `boolean` + +Defined in: [src/utils/interfaces.ts:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L27) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`allDay`](InterfaceBaseEvent.md#allday) + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L21) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`description`](InterfaceBaseEvent.md#description) + +*** + +### endDate + +> **endDate**: `string` + +Defined in: [src/utils/interfaces.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L23) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endDate`](InterfaceBaseEvent.md#enddate) + +*** + +### endTime + +> **endTime**: `string` + +Defined in: [src/utils/interfaces.ts:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L26) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endTime`](InterfaceBaseEvent.md#endtime) + +*** + +### isPublic + +> **isPublic**: `boolean` + +Defined in: [src/utils/interfaces.ts:382](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L382) + +*** + +### isRegisterable + +> **isRegisterable**: `boolean` + +Defined in: [src/utils/interfaces.ts:383](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L383) + +*** + +### location + +> **location**: `string` + +Defined in: [src/utils/interfaces.ts:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L24) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`location`](InterfaceBaseEvent.md#location) + +*** + +### recurring + +> **recurring**: `boolean` + +Defined in: [src/utils/interfaces.ts:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L28) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`recurring`](InterfaceBaseEvent.md#recurring) + +*** + +### startDate + +> **startDate**: `string` + +Defined in: [src/utils/interfaces.ts:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L22) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startDate`](InterfaceBaseEvent.md#startdate) + +*** + +### startTime + +> **startTime**: `string` + +Defined in: [src/utils/interfaces.ts:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L25) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startTime`](InterfaceBaseEvent.md#starttime) + +*** + +### title + +> **title**: `string` + +Defined in: [src/utils/interfaces.ts:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L20) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`title`](InterfaceBaseEvent.md#title) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationFundCampaigns.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationFundCampaigns.md new file mode 100644 index 0000000000..0c44e315dd --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationFundCampaigns.md @@ -0,0 +1,59 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryOrganizationFundCampaigns + +Defined in: [src/utils/interfaces.ts:319](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L319) + +## Properties + +### campaigns + +> **campaigns**: `object`[] + +Defined in: [src/utils/interfaces.ts:322](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L322) + +#### \_id + +> **\_id**: `string` + +#### createdAt + +> **createdAt**: `string` + +#### currency + +> **currency**: `string` + +#### endDate + +> **endDate**: `Date` + +#### fundingGoal + +> **fundingGoal**: `number` + +#### name + +> **name**: `string` + +#### startDate + +> **startDate**: `Date` + +*** + +### isArchived + +> **isArchived**: `boolean` + +Defined in: [src/utils/interfaces.ts:321](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L321) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:320](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L320) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationListObject.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationListObject.md new file mode 100644 index 0000000000..ecdeb97fdb --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationListObject.md @@ -0,0 +1,87 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryOrganizationListObject + +Defined in: [src/utils/interfaces.ts:155](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L155) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:156](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L156) + +*** + +### address + +> **address**: [`InterfaceAddress`](InterfaceAddress.md) + +Defined in: [src/utils/interfaces.ts:170](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L170) + +*** + +### admins + +> **admins**: `object`[] + +Defined in: [src/utils/interfaces.ts:166](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L166) + +#### \_id + +> **\_id**: `string` + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:169](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L169) + +*** + +### creator + +> **creator**: `object` + +Defined in: [src/utils/interfaces.ts:158](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L158) + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### image + +> **image**: `string` + +Defined in: [src/utils/interfaces.ts:157](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L157) + +*** + +### members + +> **members**: `object`[] + +Defined in: [src/utils/interfaces.ts:163](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L163) + +#### \_id + +> **\_id**: `string` + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:162](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L162) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationPostListItem.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationPostListItem.md new file mode 100644 index 0000000000..f7955de65b --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationPostListItem.md @@ -0,0 +1,43 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryOrganizationPostListItem + +Defined in: [src/utils/interfaces.ts:180](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L180) + +## Properties + +### posts + +> **posts**: `object` + +Defined in: [src/utils/interfaces.ts:181](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L181) + +#### 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` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTags.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTags.md new file mode 100644 index 0000000000..54581ab7e6 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTags.md @@ -0,0 +1,15 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryOrganizationUserTags + +Defined in: [src/utils/interfaces.ts:269](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L269) + +## Properties + +### userTags + +> **userTags**: `InterfaceTagNodeData` + +Defined in: [src/utils/interfaces.ts:270](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L270) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md new file mode 100644 index 0000000000..1ba833cdb0 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md @@ -0,0 +1,187 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryOrganizationsListObject + +Defined in: [src/utils/interfaces.ts:113](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L113) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:114](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L114) + +*** + +### address + +> **address**: [`InterfaceAddress`](InterfaceAddress.md) + +Defined in: [src/utils/interfaces.ts:123](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L123) + +*** + +### admins + +> **admins**: `object`[] + +Defined in: [src/utils/interfaces.ts:132](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L132) + +#### \_id + +> **\_id**: `string` + +#### createdAt + +> **createdAt**: `string` + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### blockedUsers + +> **blockedUsers**: `object`[] + +Defined in: [src/utils/interfaces.ts:147](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L147) + +#### \_id + +> **\_id**: `string` + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### creator + +> **creator**: `object` + +Defined in: [src/utils/interfaces.ts:116](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L116) + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:122](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L122) + +*** + +### image + +> **image**: `string` + +Defined in: [src/utils/interfaces.ts:115](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L115) + +*** + +### members + +> **members**: `object`[] + +Defined in: [src/utils/interfaces.ts:126](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L126) + +#### \_id + +> **\_id**: `string` + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### lastName + +> **lastName**: `string` + +*** + +### membershipRequests + +> **membershipRequests**: `object`[] + +Defined in: [src/utils/interfaces.ts:139](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L139) + +#### \_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:121](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L121) + +*** + +### userRegistrationRequired + +> **userRegistrationRequired**: `boolean` + +Defined in: [src/utils/interfaces.ts:124](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L124) + +*** + +### visibleInSearch + +> **visibleInSearch**: `boolean` + +Defined in: [src/utils/interfaces.ts:125](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L125) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItem.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItem.md new file mode 100644 index 0000000000..b325611adb --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItem.md @@ -0,0 +1,87 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryUserListItem + +Defined in: [src/utils/interfaces.ts:396](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L396) + +## Properties + +### appUserProfile + +> **appUserProfile**: `object` + +Defined in: [src/utils/interfaces.ts:435](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L435) + +#### \_id + +> **\_id**: `string` + +#### adminFor + +> **adminFor**: `object`[] + +#### createdEvents + +> **createdEvents**: `object`[] + +#### createdOrganizations + +> **createdOrganizations**: `object`[] + +#### eventAdmin + +> **eventAdmin**: `object`[] + +#### isSuperAdmin + +> **isSuperAdmin**: `boolean` + +*** + +### user + +> **user**: `object` + +Defined in: [src/utils/interfaces.ts:397](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L397) + +#### \_id + +> **\_id**: `string` + +#### createdAt + +> **createdAt**: `string` + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### image + +> **image**: `string` + +#### joinedOrganizations + +> **joinedOrganizations**: `object`[] + +#### lastName + +> **lastName**: `string` + +#### membershipRequests + +> **membershipRequests**: `object`[] + +#### organizationsBlockedBy + +> **organizationsBlockedBy**: `object`[] + +#### registeredEvents + +> **registeredEvents**: `object`[] diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md new file mode 100644 index 0000000000..25e9fbaf33 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryUserTagChildTags + +Defined in: [src/utils/interfaces.ts:273](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L273) + +## Properties + +### ancestorTags + +> **ancestorTags**: `object`[] + +Defined in: [src/utils/interfaces.ts:276](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L276) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +*** + +### childTags + +> **childTags**: `InterfaceTagNodeData` + +Defined in: [src/utils/interfaces.ts:275](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L275) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:274](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L274) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md new file mode 100644 index 0000000000..c848898462 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryUserTagsAssignedMembers + +Defined in: [src/utils/interfaces.ts:282](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L282) + +## Properties + +### ancestorTags + +> **ancestorTags**: `object`[] + +Defined in: [src/utils/interfaces.ts:285](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L285) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:283](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L283) + +*** + +### usersAssignedTo + +> **usersAssignedTo**: `InterfaceTagMembersData` + +Defined in: [src/utils/interfaces.ts:284](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L284) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md new file mode 100644 index 0000000000..1a5bc73c7e --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryUserTagsMembersToAssignTo + +Defined in: [src/utils/interfaces.ts:291](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L291) + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:292](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L292) + +*** + +### usersToAssignTo + +> **usersToAssignTo**: `InterfaceTagMembersData` + +Defined in: [src/utils/interfaces.ts:293](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L293) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryVenueListItem.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryVenueListItem.md new file mode 100644 index 0000000000..f746923894 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryVenueListItem.md @@ -0,0 +1,47 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceQueryVenueListItem + +Defined in: [src/utils/interfaces.ts:445](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L445) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:446](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L446) + +*** + +### capacity + +> **capacity**: `string` + +Defined in: [src/utils/interfaces.ts:450](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L450) + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:448](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L448) + +*** + +### image + +> **image**: `string` + +Defined in: [src/utils/interfaces.ts:449](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L449) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:447](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L447) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagData.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagData.md new file mode 100644 index 0000000000..6b8c53da52 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagData.md @@ -0,0 +1,75 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceTagData + +Defined in: [src/utils/interfaces.ts:222](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L222) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:223](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L223) + +*** + +### ancestorTags + +> **ancestorTags**: `object`[] + +Defined in: [src/utils/interfaces.ts:232](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L232) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +*** + +### childTags + +> **childTags**: `object` + +Defined in: [src/utils/interfaces.ts:229](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L229) + +#### totalCount + +> **totalCount**: `number` + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:224](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L224) + +*** + +### parentTag + +> **parentTag**: `object` + +Defined in: [src/utils/interfaces.ts:225](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L225) + +#### \_id + +> **\_id**: `string` + +*** + +### usersAssignedTo + +> **usersAssignedTo**: `object` + +Defined in: [src/utils/interfaces.ts:226](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L226) + +#### totalCount + +> **totalCount**: `number` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserCampaign.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserCampaign.md new file mode 100644 index 0000000000..4a6ac65dc7 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserCampaign.md @@ -0,0 +1,55 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUserCampaign + +Defined in: [src/utils/interfaces.ts:332](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L332) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:333](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L333) + +*** + +### currency + +> **currency**: `string` + +Defined in: [src/utils/interfaces.ts:338](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L338) + +*** + +### endDate + +> **endDate**: `Date` + +Defined in: [src/utils/interfaces.ts:337](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L337) + +*** + +### fundingGoal + +> **fundingGoal**: `number` + +Defined in: [src/utils/interfaces.ts:335](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L335) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:334](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L334) + +*** + +### startDate + +> **startDate**: `Date` + +Defined in: [src/utils/interfaces.ts:336](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L336) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserEvents.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserEvents.md new file mode 100644 index 0000000000..1131501d4d --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserEvents.md @@ -0,0 +1,179 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUserEvents + +Defined in: [src/utils/interfaces.ts:656](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L656) + +## Extends + +- [`InterfaceBaseEvent`](InterfaceBaseEvent.md) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L19) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`_id`](InterfaceBaseEvent.md#_id) + +*** + +### allDay + +> **allDay**: `boolean` + +Defined in: [src/utils/interfaces.ts:27](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L27) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`allDay`](InterfaceBaseEvent.md#allday) + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L21) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`description`](InterfaceBaseEvent.md#description) + +*** + +### endDate + +> **endDate**: `string` + +Defined in: [src/utils/interfaces.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L23) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endDate`](InterfaceBaseEvent.md#enddate) + +*** + +### endTime + +> **endTime**: `string` + +Defined in: [src/utils/interfaces.ts:26](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L26) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endTime`](InterfaceBaseEvent.md#endtime) + +*** + +### location + +> **location**: `string` + +Defined in: [src/utils/interfaces.ts:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L24) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`location`](InterfaceBaseEvent.md#location) + +*** + +### recurring + +> **recurring**: `boolean` + +Defined in: [src/utils/interfaces.ts:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L28) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`recurring`](InterfaceBaseEvent.md#recurring) + +*** + +### startDate + +> **startDate**: `string` + +Defined in: [src/utils/interfaces.ts:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L22) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startDate`](InterfaceBaseEvent.md#startdate) + +*** + +### startTime + +> **startTime**: `string` + +Defined in: [src/utils/interfaces.ts:25](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L25) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startTime`](InterfaceBaseEvent.md#starttime) + +*** + +### title + +> **title**: `string` + +Defined in: [src/utils/interfaces.ts:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L20) + +#### Inherited from + +[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`title`](InterfaceBaseEvent.md#title) + +*** + +### volunteerGroups + +> **volunteerGroups**: `object`[] + +Defined in: [src/utils/interfaces.ts:657](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L657) + +#### \_id + +> **\_id**: `string` + +#### description + +> **description**: `string` + +#### name + +> **name**: `string` + +#### volunteers + +> **volunteers**: `object`[] + +#### volunteersRequired + +> **volunteersRequired**: `number` + +*** + +### volunteers + +> **volunteers**: `object`[] + +Defined in: [src/utils/interfaces.ts:664](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L664) + +#### \_id + +> **\_id**: `string` + +#### user + +> **user**: `object` + +##### user.\_id + +> **\_id**: `string` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfo.md new file mode 100644 index 0000000000..a594584d48 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfo.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUserInfo + +Defined in: [src/utils/interfaces.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L10) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L11) + +*** + +### firstName + +> **firstName**: `string` + +Defined in: [src/utils/interfaces.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L12) + +*** + +### image? + +> `optional` **image**: `string` + +Defined in: [src/utils/interfaces.ts:14](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L14) + +*** + +### lastName + +> **lastName**: `string` + +Defined in: [src/utils/interfaces.ts:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L13) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserType.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserType.md new file mode 100644 index 0000000000..8ed56866a9 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserType.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceUserType + +Defined in: [src/utils/interfaces.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L1) + +## Properties + +### user + +> **user**: `object` + +Defined in: [src/utils/interfaces.ts:2](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L2) + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### image + +> **image**: `string` + +#### lastName + +> **lastName**: `string` diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md new file mode 100644 index 0000000000..f577ba5330 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md @@ -0,0 +1,123 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVolunteerGroupInfo + +Defined in: [src/utils/interfaces.ts:622](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L622) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:623](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L623) + +*** + +### assignments + +> **assignments**: `object`[] + +Defined in: [src/utils/interfaces.ts:637](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L637) + +#### \_id + +> **\_id**: `string` + +#### actionItemCategory + +> **actionItemCategory**: `object` + +##### actionItemCategory.\_id + +> **\_id**: `string` + +##### actionItemCategory.name + +> **name**: `string` + +#### allottedHours + +> **allottedHours**: `number` + +#### isCompleted + +> **isCompleted**: `boolean` + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:630](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L630) + +*** + +### creator + +> **creator**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +Defined in: [src/utils/interfaces.ts:631](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L631) + +*** + +### description + +> **description**: `string` + +Defined in: [src/utils/interfaces.ts:625](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L625) + +*** + +### event + +> **event**: `object` + +Defined in: [src/utils/interfaces.ts:626](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L626) + +#### \_id + +> **\_id**: `string` + +*** + +### leader + +> **leader**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +Defined in: [src/utils/interfaces.ts:632](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L632) + +*** + +### name + +> **name**: `string` + +Defined in: [src/utils/interfaces.ts:624](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L624) + +*** + +### volunteers + +> **volunteers**: `object`[] + +Defined in: [src/utils/interfaces.ts:633](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L633) + +#### \_id + +> **\_id**: `string` + +#### user + +> **user**: [`InterfaceUserInfo`](InterfaceUserInfo.md) + +*** + +### volunteersRequired + +> **volunteersRequired**: `number` + +Defined in: [src/utils/interfaces.ts:629](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L629) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerMembership.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerMembership.md new file mode 100644 index 0000000000..5ed701b926 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerMembership.md @@ -0,0 +1,83 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVolunteerMembership + +Defined in: [src/utils/interfaces.ts:672](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L672) + +## Properties + +### \_id + +> **\_id**: `string` + +Defined in: [src/utils/interfaces.ts:673](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L673) + +*** + +### createdAt + +> **createdAt**: `string` + +Defined in: [src/utils/interfaces.ts:675](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L675) + +*** + +### event + +> **event**: `object` + +Defined in: [src/utils/interfaces.ts:676](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L676) + +#### \_id + +> **\_id**: `string` + +#### startDate + +> **startDate**: `string` + +#### title + +> **title**: `string` + +*** + +### group + +> **group**: `object` + +Defined in: [src/utils/interfaces.ts:685](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L685) + +#### \_id + +> **\_id**: `string` + +#### name + +> **name**: `string` + +*** + +### status + +> **status**: `string` + +Defined in: [src/utils/interfaces.ts:674](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L674) + +*** + +### volunteer + +> **volunteer**: `object` + +Defined in: [src/utils/interfaces.ts:681](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L681) + +#### \_id + +> **\_id**: `string` + +#### user + +> **user**: [`InterfaceUserInfo`](InterfaceUserInfo.md) diff --git a/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerRank.md b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerRank.md new file mode 100644 index 0000000000..a6dbd97294 --- /dev/null +++ b/docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerRank.md @@ -0,0 +1,51 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceVolunteerRank + +Defined in: [src/utils/interfaces.ts:691](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L691) + +## Properties + +### hoursVolunteered + +> **hoursVolunteered**: `number` + +Defined in: [src/utils/interfaces.ts:693](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L693) + +*** + +### rank + +> **rank**: `number` + +Defined in: [src/utils/interfaces.ts:692](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L692) + +*** + +### user + +> **user**: `object` + +Defined in: [src/utils/interfaces.ts:694](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/interfaces.ts#L694) + +#### \_id + +> **\_id**: `string` + +#### email + +> **email**: `string` + +#### firstName + +> **firstName**: `string` + +#### image + +> **image**: `string` + +#### lastName + +> **lastName**: `string` diff --git a/docs/docs/auto-docs/utils/languages/variables/languageArray.md b/docs/docs/auto-docs/utils/languages/variables/languageArray.md new file mode 100644 index 0000000000..07217f159d --- /dev/null +++ b/docs/docs/auto-docs/utils/languages/variables/languageArray.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: languageArray + +> `const` **languageArray**: `string`[] + +Defined in: [src/utils/languages.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/languages.ts#L1) diff --git a/docs/docs/auto-docs/utils/languages/variables/languages.md b/docs/docs/auto-docs/utils/languages/variables/languages.md new file mode 100644 index 0000000000..ff6d983313 --- /dev/null +++ b/docs/docs/auto-docs/utils/languages/variables/languages.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Variable: languages + +> `const` **languages**: `object`[] + +Defined in: [src/utils/languages.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/languages.ts#L3) + +## Type declaration + +### code + +> **code**: `string` = `'en'` + +### country\_code + +> **country\_code**: `string` = `'gb'` + +### name + +> **name**: `string` = `'English'` diff --git a/docs/docs/auto-docs/utils/linkValidator/functions/isValidLink.md b/docs/docs/auto-docs/utils/linkValidator/functions/isValidLink.md new file mode 100644 index 0000000000..9d8b6a1afe --- /dev/null +++ b/docs/docs/auto-docs/utils/linkValidator/functions/isValidLink.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: isValidLink() + +> **isValidLink**(`link`): `boolean` + +Defined in: [src/utils/linkValidator.ts:1](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/linkValidator.ts#L1) + +## Parameters + +### link + +`string` + +## Returns + +`boolean` diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationSubTagsQuery.md b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationSubTagsQuery.md new file mode 100644 index 0000000000..0254215d83 --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationSubTagsQuery.md @@ -0,0 +1,81 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceOrganizationSubTagsQuery + +Defined in: [src/utils/organizationTagsUtils.ts:89](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L89) + +## Extends + +- `InterfaceBaseQueryResult` + +## Properties + +### data? + +> `optional` **data**: `object` + +Defined in: [src/utils/organizationTagsUtils.ts:91](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L91) + +#### getChildTags + +> **getChildTags**: [`InterfaceQueryUserTagChildTags`](../../interfaces/interfaces/InterfaceQueryUserTagChildTags.md) + +*** + +### error? + +> `optional` **error**: `ApolloError` + +Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L60) + +#### Inherited from + +`InterfaceBaseQueryResult.error` + +*** + +### fetchMore() + +> **fetchMore**: (`options`) => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:94](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L94) + +#### Parameters + +##### options + +`InterfaceBaseFetchMoreOptions`\<\{ `getChildTags`: [`InterfaceQueryUserTagChildTags`](../../interfaces/interfaces/InterfaceQueryUserTagChildTags.md); \}\> + +#### Returns + +`void` + +*** + +### loading + +> **loading**: `boolean` + +Defined in: [src/utils/organizationTagsUtils.ts:59](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L59) + +#### Inherited from + +`InterfaceBaseQueryResult.loading` + +*** + +### refetch()? + +> `optional` **refetch**: () => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L61) + +#### Returns + +`void` + +#### Inherited from + +`InterfaceBaseQueryResult.refetch` diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationTagsQuery.md b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationTagsQuery.md new file mode 100644 index 0000000000..6a2d2030bd --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationTagsQuery.md @@ -0,0 +1,81 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceOrganizationTagsQuery + +Defined in: [src/utils/organizationTagsUtils.ts:77](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L77) + +## Extends + +- `InterfaceBaseQueryResult` + +## Properties + +### data? + +> `optional` **data**: `object` + +Defined in: [src/utils/organizationTagsUtils.ts:79](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L79) + +#### organizations + +> **organizations**: [`InterfaceQueryOrganizationUserTags`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTags.md)[] + +*** + +### error? + +> `optional` **error**: `ApolloError` + +Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L60) + +#### Inherited from + +`InterfaceBaseQueryResult.error` + +*** + +### fetchMore() + +> **fetchMore**: (`options`) => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:82](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/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:59](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L59) + +#### Inherited from + +`InterfaceBaseQueryResult.loading` + +*** + +### refetch()? + +> `optional` **refetch**: () => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L61) + +#### Returns + +`void` + +#### Inherited from + +`InterfaceBaseQueryResult.refetch` diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagAssignedMembersQuery.md b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagAssignedMembersQuery.md new file mode 100644 index 0000000000..8715339300 --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagAssignedMembersQuery.md @@ -0,0 +1,81 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceTagAssignedMembersQuery + +Defined in: [src/utils/organizationTagsUtils.ts:101](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L101) + +## Extends + +- `InterfaceBaseQueryResult` + +## Properties + +### data? + +> `optional` **data**: `object` + +Defined in: [src/utils/organizationTagsUtils.ts:103](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L103) + +#### getAssignedUsers + +> **getAssignedUsers**: [`InterfaceQueryUserTagsAssignedMembers`](../../interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md) + +*** + +### error? + +> `optional` **error**: `ApolloError` + +Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L60) + +#### Inherited from + +`InterfaceBaseQueryResult.error` + +*** + +### fetchMore() + +> **fetchMore**: (`options`) => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:106](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L106) + +#### Parameters + +##### options + +`InterfaceBaseFetchMoreOptions`\<\{ `getAssignedUsers`: [`InterfaceQueryUserTagsAssignedMembers`](../../interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md); \}\> + +#### Returns + +`void` + +*** + +### loading + +> **loading**: `boolean` + +Defined in: [src/utils/organizationTagsUtils.ts:59](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L59) + +#### Inherited from + +`InterfaceBaseQueryResult.loading` + +*** + +### refetch()? + +> `optional` **refetch**: () => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L61) + +#### Returns + +`void` + +#### Inherited from + +`InterfaceBaseQueryResult.refetch` diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagUsersToAssignToQuery.md b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagUsersToAssignToQuery.md new file mode 100644 index 0000000000..f985831cef --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagUsersToAssignToQuery.md @@ -0,0 +1,81 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceTagUsersToAssignToQuery + +Defined in: [src/utils/organizationTagsUtils.ts:113](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L113) + +## Extends + +- `InterfaceBaseQueryResult` + +## Properties + +### data? + +> `optional` **data**: `object` + +Defined in: [src/utils/organizationTagsUtils.ts:115](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L115) + +#### getUsersToAssignTo + +> **getUsersToAssignTo**: [`InterfaceQueryUserTagsMembersToAssignTo`](../../interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md) + +*** + +### error? + +> `optional` **error**: `ApolloError` + +Defined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L60) + +#### Inherited from + +`InterfaceBaseQueryResult.error` + +*** + +### fetchMore() + +> **fetchMore**: (`options`) => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:118](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L118) + +#### Parameters + +##### options + +`InterfaceBaseFetchMoreOptions`\<\{ `getUsersToAssignTo`: [`InterfaceQueryUserTagsMembersToAssignTo`](../../interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md); \}\> + +#### Returns + +`void` + +*** + +### loading + +> **loading**: `boolean` + +Defined in: [src/utils/organizationTagsUtils.ts:59](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L59) + +#### Inherited from + +`InterfaceBaseQueryResult.loading` + +*** + +### refetch()? + +> `optional` **refetch**: () => `void` + +Defined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L61) + +#### Returns + +`void` + +#### Inherited from + +`InterfaceBaseQueryResult.refetch` diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/SortedByType.md b/docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/SortedByType.md new file mode 100644 index 0000000000..6f8bc667f1 --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/SortedByType.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Type Alias: SortedByType + +> **SortedByType**: `"ASCENDING"` \| `"DESCENDING"` + +Defined in: [src/utils/organizationTagsUtils.ts:54](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L54) diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/TagActionType.md b/docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/TagActionType.md new file mode 100644 index 0000000000..2ef4ca1443 --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/TagActionType.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Type Alias: TagActionType + +> **TagActionType**: `"assignToTags"` \| `"removeFromTags"` + +Defined in: [src/utils/organizationTagsUtils.ts:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L51) diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/variables/TAGS_QUERY_DATA_CHUNK_SIZE.md b/docs/docs/auto-docs/utils/organizationTagsUtils/variables/TAGS_QUERY_DATA_CHUNK_SIZE.md new file mode 100644 index 0000000000..a2a6a07241 --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/variables/TAGS_QUERY_DATA_CHUNK_SIZE.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: TAGS\_QUERY\_DATA\_CHUNK\_SIZE + +> `const` **TAGS\_QUERY\_DATA\_CHUNK\_SIZE**: `10` = `10` + +Defined in: [src/utils/organizationTagsUtils.ts:48](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L48) diff --git a/docs/docs/auto-docs/utils/organizationTagsUtils/variables/dataGridStyle.md b/docs/docs/auto-docs/utils/organizationTagsUtils/variables/dataGridStyle.md new file mode 100644 index 0000000000..6814efe38a --- /dev/null +++ b/docs/docs/auto-docs/utils/organizationTagsUtils/variables/dataGridStyle.md @@ -0,0 +1,103 @@ +[Admin Docs](/) + +*** + +# Variable: dataGridStyle + +> `const` **dataGridStyle**: `object` + +Defined in: [src/utils/organizationTagsUtils.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/organizationTagsUtils.ts#L12) + +## 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 + +> **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-cell:focus-within**: `object` + +#### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within.outline + +> **outline**: `string` = `'none !important'` + +#### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within + +> **MuiDataGrid-columnHeader:focus-within**: `object` + +#### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within.outline + +> **outline**: `string` = `'none'` diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/Days.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/Days.md new file mode 100644 index 0000000000..2a23ff03a7 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/Days.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: Days + +> `const` **Days**: [`WeekDays`](../../recurrenceTypes/enumerations/WeekDays.md)[] + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L24) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/allInstances.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/allInstances.md new file mode 100644 index 0000000000..b207f0ba2f --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/allInstances.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: allInstances + +> `const` **allInstances**: [`allInstances`](../../recurrenceTypes/enumerations/RecurringEventMutationType.md#allinstances) = `RecurringEventMutationType.allInstances` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:46](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L46) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/dayNames.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/dayNames.md new file mode 100644 index 0000000000..5f51a7177d --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/dayNames.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Variable: dayNames + +> `const` **dayNames**: `object` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:60](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L60) + +## Type declaration + +### FRIDAY + +> **FRIDAY**: `string` = `'Friday'` + +### MONDAY + +> **MONDAY**: `string` = `'Monday'` + +### SATURDAY + +> **SATURDAY**: `string` = `'Saturday'` + +### SUNDAY + +> **SUNDAY**: `string` = `'Sunday'` + +### THURSDAY + +> **THURSDAY**: `string` = `'Thursday'` + +### TUESDAY + +> **TUESDAY**: `string` = `'Tuesday'` + +### WEDNESDAY + +> **WEDNESDAY**: `string` = `'Wednesday'` diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/daysOptions.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/daysOptions.md new file mode 100644 index 0000000000..f22ff3ff5c --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/daysOptions.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: daysOptions + +> `const` **daysOptions**: `string`[] + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L21) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsAfter.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsAfter.md new file mode 100644 index 0000000000..91ef650214 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsAfter.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: endsAfter + +> `const` **endsAfter**: [`after`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#after) = `RecurrenceEndOption.after` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L37) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsNever.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsNever.md new file mode 100644 index 0000000000..c2cdf4d64f --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsNever.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: endsNever + +> `const` **endsNever**: [`never`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#never) = `RecurrenceEndOption.never` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:35](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L35) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsOn.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsOn.md new file mode 100644 index 0000000000..54263e880b --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsOn.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: endsOn + +> `const` **endsOn**: [`on`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#on) = `RecurrenceEndOption.on` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L36) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/frequencies.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/frequencies.md new file mode 100644 index 0000000000..5efc1c5b8f --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/frequencies.md @@ -0,0 +1,27 @@ +[Admin Docs](/) + +*** + +# Variable: frequencies + +> `const` **frequencies**: `object` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L13) + +## Type declaration + +### DAILY + +> **DAILY**: `string` = `'Day'` + +### MONTHLY + +> **MONTHLY**: `string` = `'Month'` + +### WEEKLY + +> **WEEKLY**: `string` = `'Week'` + +### YEARLY + +> **YEARLY**: `string` = `'Year'` diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/mondayToFriday.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/mondayToFriday.md new file mode 100644 index 0000000000..451b4871ba --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/mondayToFriday.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: mondayToFriday + +> `const` **mondayToFriday**: ([`MONDAY`](../../recurrenceTypes/enumerations/WeekDays.md#monday) \| [`TUESDAY`](../../recurrenceTypes/enumerations/WeekDays.md#tuesday) \| [`WEDNESDAY`](../../recurrenceTypes/enumerations/WeekDays.md#wednesday) \| [`THURSDAY`](../../recurrenceTypes/enumerations/WeekDays.md#thursday) \| [`FRIDAY`](../../recurrenceTypes/enumerations/WeekDays.md#friday))[] + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L55) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/monthNames.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/monthNames.md new file mode 100644 index 0000000000..1cd7593cc0 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/monthNames.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: monthNames + +> `const` **monthNames**: `string`[] + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:71](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L71) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurrenceEndOptions.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurrenceEndOptions.md new file mode 100644 index 0000000000..bf5d490558 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurrenceEndOptions.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: recurrenceEndOptions + +> `const` **recurrenceEndOptions**: [`RecurrenceEndOption`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md)[] + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L40) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurringEventMutationOptions.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurringEventMutationOptions.md new file mode 100644 index 0000000000..41ac9b1a49 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurringEventMutationOptions.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: recurringEventMutationOptions + +> `const` **recurringEventMutationOptions**: [`RecurringEventMutationType`](../../recurrenceTypes/enumerations/RecurringEventMutationType.md)[] + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:48](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L48) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/thisAndFollowingInstances.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/thisAndFollowingInstances.md new file mode 100644 index 0000000000..743244854f --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/thisAndFollowingInstances.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: thisAndFollowingInstances + +> `const` **thisAndFollowingInstances**: [`thisAndFollowingInstances`](../../recurrenceTypes/enumerations/RecurringEventMutationType.md#thisandfollowinginstances) = `RecurringEventMutationType.thisAndFollowingInstances` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:44](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L44) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/thisInstance.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/thisInstance.md new file mode 100644 index 0000000000..013b35379f --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/thisInstance.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: thisInstance + +> `const` **thisInstance**: [`thisInstance`](../../recurrenceTypes/enumerations/RecurringEventMutationType.md#thisinstance) = `RecurringEventMutationType.thisInstance` + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L43) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/weekDayOccurences.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/weekDayOccurences.md new file mode 100644 index 0000000000..3e04883690 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/weekDayOccurences.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: weekDayOccurences + +> `const` **weekDayOccurences**: `string`[] + +Defined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:87](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceConstants.ts#L87) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md new file mode 100644 index 0000000000..e54a315c3e --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md @@ -0,0 +1,39 @@ +[Admin Docs](/) + +*** + +# Enumeration: Frequency + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:28](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L28) + +## Enumeration Members + +### DAILY + +> **DAILY**: `"DAILY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L29) + +*** + +### MONTHLY + +> **MONTHLY**: `"MONTHLY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:31](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L31) + +*** + +### WEEKLY + +> **WEEKLY**: `"WEEKLY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L30) + +*** + +### YEARLY + +> **YEARLY**: `"YEARLY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:32](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L32) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurrenceEndOption.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurrenceEndOption.md new file mode 100644 index 0000000000..4c55fbe71e --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurrenceEndOption.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Enumeration: RecurrenceEndOption + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:48](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L48) + +## Enumeration Members + +### after + +> **after**: `"after"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L51) + +*** + +### never + +> **never**: `"never"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:49](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L49) + +*** + +### on + +> **on**: `"on"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:50](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L50) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurringEventMutationType.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurringEventMutationType.md new file mode 100644 index 0000000000..5bbbc9ee22 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurringEventMutationType.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Enumeration: RecurringEventMutationType + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:55](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L55) + +## Enumeration Members + +### allInstances + +> **allInstances**: `"allInstances"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:58](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L58) + +*** + +### thisAndFollowingInstances + +> **thisAndFollowingInstances**: `"thisAndFollowingInstances"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:57](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L57) + +*** + +### thisInstance + +> **thisInstance**: `"thisInstance"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:56](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L56) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/WeekDays.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/WeekDays.md new file mode 100644 index 0000000000..8057c86b6b --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/WeekDays.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Enumeration: WeekDays + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:36](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L36) + +## Enumeration Members + +### FRIDAY + +> **FRIDAY**: `"FRIDAY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:42](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L42) + +*** + +### MONDAY + +> **MONDAY**: `"MONDAY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:38](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L38) + +*** + +### SATURDAY + +> **SATURDAY**: `"SATURDAY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:43](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L43) + +*** + +### SUNDAY + +> **SUNDAY**: `"SUNDAY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:37](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L37) + +*** + +### THURSDAY + +> **THURSDAY**: `"THURSDAY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L41) + +*** + +### TUESDAY + +> **TUESDAY**: `"TUESDAY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:39](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L39) + +*** + +### WEDNESDAY + +> **WEDNESDAY**: `"WEDNESDAY"` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:40](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L40) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md new file mode 100644 index 0000000000..9b3ebe6ba6 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceRecurrenceRule + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:17](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L17) + +## Properties + +### count + +> **count**: `number` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:23](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L23) + +*** + +### frequency + +> **frequency**: [`Frequency`](../enumerations/Frequency.md) + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:20](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L20) + +*** + +### interval + +> **interval**: `number` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L22) + +*** + +### recurrenceEndDate + +> **recurrenceEndDate**: `string` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L19) + +*** + +### recurrenceStartDate + +> **recurrenceStartDate**: `string` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:18](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L18) + +*** + +### weekDayOccurenceInMonth + +> **weekDayOccurenceInMonth**: `number` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:24](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L24) + +*** + +### weekDays + +> **weekDays**: [`WeekDays`](../enumerations/WeekDays.md)[] + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:21](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L21) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRuleState.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRuleState.md new file mode 100644 index 0000000000..3cfa3e881c --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRuleState.md @@ -0,0 +1,63 @@ +[Admin Docs](/) + +*** + +# Interface: InterfaceRecurrenceRuleState + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:6](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L6) + +## Properties + +### count + +> **count**: `number` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:12](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L12) + +*** + +### frequency + +> **frequency**: [`Frequency`](../enumerations/Frequency.md) + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:9](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L9) + +*** + +### interval + +> **interval**: `number` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:11](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L11) + +*** + +### recurrenceEndDate + +> **recurrenceEndDate**: `Date` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:8](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L8) + +*** + +### recurrenceStartDate + +> **recurrenceStartDate**: `Date` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:7](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L7) + +*** + +### weekDayOccurenceInMonth + +> **weekDayOccurenceInMonth**: `number` + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:13](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L13) + +*** + +### weekDays + +> **weekDays**: [`WeekDays`](../enumerations/WeekDays.md)[] + +Defined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:10](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceTypes.ts#L10) diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getRecurrenceRuleText.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getRecurrenceRuleText.md new file mode 100644 index 0000000000..5047841254 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getRecurrenceRuleText.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: getRecurrenceRuleText() + +> **getRecurrenceRuleText**(`recurrenceRuleState`): `string` + +Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:22](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L22) + +## Parameters + +### recurrenceRuleState + +[`InterfaceRecurrenceRuleState`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRuleState.md) + +## Returns + +`string` diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getWeekDayOccurenceInMonth.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getWeekDayOccurenceInMonth.md new file mode 100644 index 0000000000..7d7008ee08 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getWeekDayOccurenceInMonth.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: getWeekDayOccurenceInMonth() + +> **getWeekDayOccurenceInMonth**(`date`): `number` + +Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:126](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L126) + +## Parameters + +### date + +`Date` + +## Returns + +`number` diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/hasRecurrenceRuleChanged.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/hasRecurrenceRuleChanged.md new file mode 100644 index 0000000000..d64af094ea --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/hasRecurrenceRuleChanged.md @@ -0,0 +1,23 @@ +[Admin Docs](/) + +*** + +# Function: hasRecurrenceRuleChanged() + +> **hasRecurrenceRuleChanged**(`originalRecurrencerule`, `recurrenceRuleState`): `boolean` + +Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:167](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L167) + +## Parameters + +### originalRecurrencerule + +[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) + +### recurrenceRuleState + +[`InterfaceRecurrenceRuleState`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRuleState.md) + +## Returns + +`boolean` diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/haveInstanceDatesChanged.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/haveInstanceDatesChanged.md new file mode 100644 index 0000000000..ae402982c5 --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/haveInstanceDatesChanged.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Function: haveInstanceDatesChanged() + +> **haveInstanceDatesChanged**(`instanceOriginalStartDate`, `instanceOriginalEndDate`, `instanceNewStartDate`, `instanceNewEndDate`): `boolean` + +Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:154](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L154) + +## Parameters + +### instanceOriginalStartDate + +`string` + +### instanceOriginalEndDate + +`string` + +### instanceNewStartDate + +`string` + +### instanceNewEndDate + +`string` + +## Returns + +`boolean` diff --git a/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/isLastOccurenceOfWeekDay.md b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/isLastOccurenceOfWeekDay.md new file mode 100644 index 0000000000..0b26a65dde --- /dev/null +++ b/docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/isLastOccurenceOfWeekDay.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Function: isLastOccurenceOfWeekDay() + +> **isLastOccurenceOfWeekDay**(`date`): `boolean` + +Defined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:136](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L136) + +## Parameters + +### date + +`Date` + +## Returns + +`boolean` diff --git a/docs/docs/auto-docs/utils/timezoneUtils/dateTimeConfig/variables/dateTimeFields.md b/docs/docs/auto-docs/utils/timezoneUtils/dateTimeConfig/variables/dateTimeFields.md new file mode 100644 index 0000000000..b4880dd1fa --- /dev/null +++ b/docs/docs/auto-docs/utils/timezoneUtils/dateTimeConfig/variables/dateTimeFields.md @@ -0,0 +1,19 @@ +[Admin Docs](/) + +*** + +# Variable: dateTimeFields + +> `const` **dateTimeFields**: `object` + +Defined in: [src/utils/timezoneUtils/dateTimeConfig.ts:3](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/timezoneUtils/dateTimeConfig.ts#L3) + +## Type declaration + +### directFields + +> **directFields**: `string`[] + +### pairedFields + +> **pairedFields**: `object`[] diff --git a/docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/requestMiddleware.md b/docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/requestMiddleware.md new file mode 100644 index 0000000000..fb5455614b --- /dev/null +++ b/docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/requestMiddleware.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: requestMiddleware + +> `const` **requestMiddleware**: `ApolloLink` + +Defined in: [src/utils/timezoneUtils/dateTimeMiddleware.ts:84](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/timezoneUtils/dateTimeMiddleware.ts#L84) diff --git a/docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/responseMiddleware.md b/docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/responseMiddleware.md new file mode 100644 index 0000000000..e491e8f922 --- /dev/null +++ b/docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/responseMiddleware.md @@ -0,0 +1,9 @@ +[Admin Docs](/) + +*** + +# Variable: responseMiddleware + +> `const` **responseMiddleware**: `ApolloLink` + +Defined in: [src/utils/timezoneUtils/dateTimeMiddleware.ts:94](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/timezoneUtils/dateTimeMiddleware.ts#L94) diff --git a/docs/docs/auto-docs/utils/useLocalstorage/functions/getItem.md b/docs/docs/auto-docs/utils/useLocalstorage/functions/getItem.md new file mode 100644 index 0000000000..d4f78826ca --- /dev/null +++ b/docs/docs/auto-docs/utils/useLocalstorage/functions/getItem.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Function: getItem() + +> **getItem**(`prefix`, `key`): `any` + +Defined in: [src/utils/useLocalstorage.ts:29](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/useLocalstorage.ts#L29) + +Retrieves the stored value for 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 + +`any` + +- The stored value for the given key from local storage. diff --git a/docs/docs/auto-docs/utils/useLocalstorage/functions/getStorageKey.md b/docs/docs/auto-docs/utils/useLocalstorage/functions/getStorageKey.md new file mode 100644 index 0000000000..fe3fc0d6db --- /dev/null +++ b/docs/docs/auto-docs/utils/useLocalstorage/functions/getStorageKey.md @@ -0,0 +1,31 @@ +[Admin Docs](/) + +*** + +# Function: getStorageKey() + +> **getStorageKey**(`prefix`, `key`): `string` + +Defined in: [src/utils/useLocalstorage.ts:19](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/useLocalstorage.ts#L19) + +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. diff --git a/docs/docs/auto-docs/utils/useLocalstorage/functions/removeItem.md b/docs/docs/auto-docs/utils/useLocalstorage/functions/removeItem.md new file mode 100644 index 0000000000..1c207c0d43 --- /dev/null +++ b/docs/docs/auto-docs/utils/useLocalstorage/functions/removeItem.md @@ -0,0 +1,29 @@ +[Admin Docs](/) + +*** + +# Function: removeItem() + +> **removeItem**(`prefix`, `key`): `void` + +Defined in: [src/utils/useLocalstorage.ts:51](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/useLocalstorage.ts#L51) + +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` diff --git a/docs/docs/auto-docs/utils/useLocalstorage/functions/setItem.md b/docs/docs/auto-docs/utils/useLocalstorage/functions/setItem.md new file mode 100644 index 0000000000..a8e64066e8 --- /dev/null +++ b/docs/docs/auto-docs/utils/useLocalstorage/functions/setItem.md @@ -0,0 +1,35 @@ +[Admin Docs](/) + +*** + +# Function: setItem() + +> **setItem**(`prefix`, `key`, `value`): `void` + +Defined in: [src/utils/useLocalstorage.ts:41](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/useLocalstorage.ts#L41) + +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 + +`any` + +The value for the key. + +## Returns + +`void` diff --git a/docs/docs/auto-docs/utils/useLocalstorage/functions/useLocalStorage.md b/docs/docs/auto-docs/utils/useLocalstorage/functions/useLocalStorage.md new file mode 100644 index 0000000000..99469fb19c --- /dev/null +++ b/docs/docs/auto-docs/utils/useLocalstorage/functions/useLocalStorage.md @@ -0,0 +1,25 @@ +[Admin Docs](/) + +*** + +# Function: useLocalStorage() + +> **useLocalStorage**(`prefix`): `InterfaceStorageHelper` + +Defined in: [src/utils/useLocalstorage.ts:61](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/useLocalstorage.ts#L61) + +Custom hook for simplified localStorage operations. + +## Parameters + +### prefix + +`string` = `PREFIX` + +Prefix to be added to the key, common for all keys. Default is 'Talawa-admin'. + +## Returns + +`InterfaceStorageHelper` + +- Functions to getItem, setItem, removeItem, and getStorageKey. diff --git a/docs/docs/auto-docs/utils/useSession/functions/default.md b/docs/docs/auto-docs/utils/useSession/functions/default.md new file mode 100644 index 0000000000..498ca17183 --- /dev/null +++ b/docs/docs/auto-docs/utils/useSession/functions/default.md @@ -0,0 +1,24 @@ +[Admin Docs](/) + +*** + +# Function: default() + +> **default**(): `UseSessionReturnType` + +Defined in: [src/utils/useSession.tsx:30](https://github.com/gautam-divyanshu/talawa-admin/blob/d5fea688542032271211cd43ee86c7db0866bcc0/src/utils/useSession.tsx#L30) + +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. diff --git a/fix-readme-links.js b/fix-readme-links.js new file mode 100644 index 0000000000..d9930cd7c7 --- /dev/null +++ b/fix-readme-links.js @@ -0,0 +1,25 @@ +import fs from 'fs'; +import path from 'path'; + +const docsDir = path.resolve('./docs/docs/auto-docs'); + +function replaceLinks(dir) { + const files = fs.readdirSync(dir); + files.forEach((file) => { + const filePath = path.join(dir, file); + if (fs.lstatSync(filePath).isDirectory()) { + replaceLinks(filePath); + } else if (file.endsWith('.md')) { + let content = fs.readFileSync(filePath, 'utf8'); + + // Replace any README.md links with root directory ("/") + content = content.replace(/\[.*?\]\((.*?)README\.md\)/g, (match) => { + return '[Admin Docs](/)'; // Redirect broken links to the root + }); + + fs.writeFileSync(filePath, content, 'utf8'); + } + }); +} + +replaceLinks(docsDir); diff --git a/package-lock.json b/package-lock.json index 3b7c816f00..983a899097 100644 --- a/package-lock.json +++ b/package-lock.json @@ -66,8 +66,6 @@ "redux": "^5.0.1", "redux-thunk": "^3.1.0", "sanitize-html": "^2.13.0", - "typedoc": "^0.26.10", - "typedoc-plugin-markdown": "^4.2.10", "typescript": "^5.6.3", "vite": "^5.4.8", "vite-plugin-environment": "^1.1.3", @@ -119,7 +117,10 @@ "lint-staged": "^15.3.0", "postcss-modules": "^6.0.1", "sass": "^1.80.7", + "shiki": "^1.26.1", "tsx": "^4.19.1", + "typedoc": "^0.27.6", + "typedoc-plugin-markdown": "^4.4.1", "vite-plugin-svgr": "^4.2.0", "vitest": "^2.1.5", "whatwg-fetch": "^3.6.20" @@ -3259,6 +3260,18 @@ "resolved": "https://registry.npmjs.org/@floating-ui/utils/-/utils-0.2.8.tgz", "integrity": "sha512-kym7SodPp8/wloecOpcmSnWJsK7M0E5Wg8UcFA+uO4B9s5d0ywXOEro/8HM9x0rW+TljRzul/14UYz3TleT3ig==" }, + "node_modules/@gerrit0/mini-shiki": { + "version": "1.27.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-1.27.0.tgz", + "integrity": "sha512-nFZkbq4/wU+GxkyJVrXeMIS9SEcHI1HzJtK3EDtMQy16nNs1LNaI0dZTLAP2EuK/QSTYLo/Zaabm6Phxlmra1A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^1.27.0", + "@shikijs/types": "^1.27.0", + "@shikijs/vscode-textmate": "^10.0.1" + } + }, "node_modules/@graphql-typed-document-node/core": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/@graphql-typed-document-node/core/-/core-3.2.0.tgz", @@ -5565,49 +5578,80 @@ "dev": true }, "node_modules/@shikijs/core": { - "version": "1.17.6", - "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.17.6.tgz", - "integrity": "sha512-9ztslig6/YmCg/XwESAXbKjAjOhaq6HVced9NY6qcbDz1X5g/S90Wco2vMjBNX/6V71ASkzri76JewSGPa7kiQ==", - "dependencies": { - "@shikijs/engine-javascript": "1.17.6", - "@shikijs/engine-oniguruma": "1.17.6", - "@shikijs/types": "1.17.6", - "@shikijs/vscode-textmate": "^9.2.2", + "version": "1.27.2", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.27.2.tgz", + "integrity": "sha512-ns1dokDr0KE1lQ9mWd4rqaBkhSApk0qGCK1+lOqwnkQSkVZ08UGqXj1Ef8dAcTMZNFkN6PSNjkL5TYNX7pyPbQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-javascript": "1.27.2", + "@shikijs/engine-oniguruma": "1.27.2", + "@shikijs/types": "1.27.2", + "@shikijs/vscode-textmate": "^10.0.1", "@types/hast": "^3.0.4", - "hast-util-to-html": "^9.0.2" + "hast-util-to-html": "^9.0.4" } }, "node_modules/@shikijs/engine-javascript": { - "version": "1.17.6", - "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-1.17.6.tgz", - "integrity": "sha512-5EEZj8tVcierNxm4V0UMS2PVoflb0UJPalWWV8l9rRg+oOfnr5VivqBJbkyq5grltVPvByIXvVbY8GSM/356jQ==", + "version": "1.27.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-1.27.2.tgz", + "integrity": "sha512-0JB7U5vJc16NShBdxv9hSSJYSKX79+32O7F4oXIxJLdYfomyFvx4B982ackUI9ftO9T3WwagkiiD3nOxOOLiGA==", + "dev": true, + "license": "MIT", "dependencies": { - "@shikijs/types": "1.17.6", - "oniguruma-to-js": "0.4.3" + "@shikijs/types": "1.27.2", + "@shikijs/vscode-textmate": "^10.0.1", + "oniguruma-to-es": "^2.0.0" } }, "node_modules/@shikijs/engine-oniguruma": { - "version": "1.17.6", - "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.17.6.tgz", - "integrity": "sha512-NLfWDMXFYe0nDHFbEoyZdz89aIIey3bTfF3zLYSUNTXks5s4uinZVmuPOFf1HfTeGqIn8uErJSBc3VnpJO7Alw==", + "version": "1.27.2", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.27.2.tgz", + "integrity": "sha512-FZYKD1KN7srvpkz4lbGLOYWlyDU4Rd+2RtuKfABTkafAPOFr+J6umfIwY/TzOQqfNtWjL7SAwPAO0dcOraRLaQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "1.27.2", + "@shikijs/vscode-textmate": "^10.0.1" + } + }, + "node_modules/@shikijs/langs": { + "version": "1.27.2", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-1.27.2.tgz", + "integrity": "sha512-MSrknKL0DbeXvhtSigMLIzjPOOQfvK7fsbcRv2NUUB0EvuTTomY8/U+lAkczYrXY2+dygKOapJKk8ScFYbtoNw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "1.27.2" + } + }, + "node_modules/@shikijs/themes": { + "version": "1.27.2", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-1.27.2.tgz", + "integrity": "sha512-Yw/uV7EijjWavIIZLoWneTAohcbBqEKj6XMX1bfMqO3llqTKsyXukPp1evf8qPqzUHY7ibauqEaQchhfi857mg==", + "dev": true, + "license": "MIT", "dependencies": { - "@shikijs/types": "1.17.6", - "@shikijs/vscode-textmate": "^9.2.2" + "@shikijs/types": "1.27.2" } }, "node_modules/@shikijs/types": { - "version": "1.17.6", - "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.17.6.tgz", - "integrity": "sha512-ndTFa2TJi2w51ddKQDn3Jy8f6K4E5Q2x3dA3Hmsd3+YmxDQ10UWHjcw7VbVbKzv3VcUvYPLy+z9neqytSzUMUg==", + "version": "1.27.2", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.27.2.tgz", + "integrity": "sha512-DM9OWUyjmdYdnKDpaGB/GEn9XkToyK1tqxuqbmc5PV+5K8WjjwfygL3+cIvbkSw2v1ySwHDgqATq/+98pJ4Kyg==", + "dev": true, + "license": "MIT", "dependencies": { - "@shikijs/vscode-textmate": "^9.2.2", + "@shikijs/vscode-textmate": "^10.0.1", "@types/hast": "^3.0.4" } }, "node_modules/@shikijs/vscode-textmate": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-9.2.2.tgz", - "integrity": "sha512-TMp15K+GGYrWlZM8+Lnj9EaHEFmOen0WJBrfa17hF7taDOYthuPPV0GWzfd/9iMij0akS/8Yw2ikquH7uVi/fg==" + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.1.tgz", + "integrity": "sha512-fTIQwLF+Qhuws31iw7Ncl1R3HUDtGwIipiJ9iU+UsDUwMhegFcQKQHd51nZjb7CArq0MvON8rbgCGQYWHUKAdg==", + "dev": true, + "license": "MIT" }, "node_modules/@sindresorhus/is": { "version": "0.14.0", @@ -6133,6 +6177,8 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "*" } @@ -6217,6 +6263,8 @@ "version": "4.0.4", "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "*" } @@ -6419,7 +6467,9 @@ "node_modules/@types/unist": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", - "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==" + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "dev": true, + "license": "MIT" }, "node_modules/@types/use-sync-external-store": { "version": "0.0.3", @@ -6768,6 +6818,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz", "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", + "dev": true, "license": "ISC" }, "node_modules/@vitejs/plugin-react": { @@ -7986,7 +8037,8 @@ "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true }, "node_modules/base64-js": { "version": "1.5.1", @@ -8467,6 +8519,8 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -8515,6 +8569,8 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -8524,6 +8580,8 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -8853,6 +8911,8 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -9639,6 +9699,8 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "dev": true, + "license": "MIT", "dependencies": { "dequal": "^2.0.0" }, @@ -9893,6 +9955,13 @@ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" }, + "node_modules/emoji-regex-xs": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex-xs/-/emoji-regex-xs-1.0.0.tgz", + "integrity": "sha512-LRlerrMYoIDrT6jgpeZ2YYl/L8EulRTt5hQcYjy5AInh7HWXKimpqx68aknBFpGL2+/IcogTcaydJEgaTmOpDg==", + "dev": true, + "license": "MIT" + }, "node_modules/encodeurl": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", @@ -11908,9 +11977,11 @@ } }, "node_modules/hast-util-to-html": { - "version": "9.0.2", - "resolved": "https://registry.npmjs.org/hast-util-to-html/-/hast-util-to-html-9.0.2.tgz", - "integrity": "sha512-RP5wNpj5nm1Z8cloDv4Sl4RS8jH5HYa0v93YB6Wb4poEzgMo/dAAL0KcT4974dCjcNG5pkLqTImeFHHCwwfY3g==", + "version": "9.0.4", + "resolved": "https://registry.npmjs.org/hast-util-to-html/-/hast-util-to-html-9.0.4.tgz", + "integrity": "sha512-wxQzXtdbhiwGAUKrnQJXlOPmHnEehzphwkK7aluUPQ+lEc1xefC8pblMgpp2w5ldBTEfveRIrADcrhGIWrlTDA==", + "dev": true, + "license": "MIT", "dependencies": { "@types/hast": "^3.0.0", "@types/unist": "^3.0.0", @@ -11933,6 +12004,8 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "dev": true, + "license": "MIT", "dependencies": { "@types/hast": "^3.0.0" }, @@ -12029,6 +12102,8 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -14798,6 +14873,7 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, "dependencies": { "uc.micro": "^2.0.0" } @@ -15428,7 +15504,8 @@ "node_modules/lunr": { "version": "2.3.9", "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", - "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==" + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true }, "node_modules/lz-string": { "version": "1.5.0", @@ -15495,6 +15572,7 @@ "version": "14.1.0", "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "dev": true, "dependencies": { "argparse": "^2.0.1", "entities": "^4.4.0", @@ -15510,7 +15588,8 @@ "node_modules/markdown-it/node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true }, "node_modules/markdown-link": { "version": "0.1.1", @@ -15564,6 +15643,8 @@ "version": "13.2.0", "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz", "integrity": "sha512-QGYKEuUsYT9ykKBCMOEDLsU5JRObWQusAolFMeko/tYPufNkRffBAQjIE+99jbA87xv6FgmjLtwjh9wBWajwAA==", + "dev": true, + "license": "MIT", "dependencies": { "@types/hast": "^3.0.0", "@types/mdast": "^4.0.0", @@ -15583,7 +15664,8 @@ "node_modules/mdurl": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", - "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==" + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true }, "node_modules/memoize-one": { "version": "5.2.1", @@ -15611,9 +15693,10 @@ } }, "node_modules/micromark-util-character": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.0.tgz", - "integrity": "sha512-KvOVV+X1yLBfs9dCBSopq/+G1PcgT3lAK07mC4BzXi5E7ahzMAF8oIupDDJ6mievI6F+lAATkbQQlQixJfT3aQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "dev": true, "funding": [ { "type": "GitHub Sponsors", @@ -15624,15 +15707,17 @@ "url": "https://opencollective.com/unified" } ], + "license": "MIT", "dependencies": { "micromark-util-symbol": "^2.0.0", "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-util-encode": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.0.tgz", - "integrity": "sha512-pS+ROfCXAGLWCOc8egcBvT0kf27GoWMqtdarNfDcjb6YLuV5cM3ioG45Ys2qOVqeqSbjaKg72vU+Wby3eddPsA==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "dev": true, "funding": [ { "type": "GitHub Sponsors", @@ -15642,12 +15727,14 @@ "type": "OpenCollective", "url": "https://opencollective.com/unified" } - ] + ], + "license": "MIT" }, "node_modules/micromark-util-sanitize-uri": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.0.tgz", - "integrity": "sha512-WhYv5UEcZrbAtlsnPuChHUAsu/iBPOVaEVsntLBIdpibO0ddy8OzavZz3iL2xVvBZOpolujSliP65Kq0/7KIYw==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "dev": true, "funding": [ { "type": "GitHub Sponsors", @@ -15658,6 +15745,7 @@ "url": "https://opencollective.com/unified" } ], + "license": "MIT", "dependencies": { "micromark-util-character": "^2.0.0", "micromark-util-encode": "^2.0.0", @@ -15665,9 +15753,10 @@ } }, "node_modules/micromark-util-symbol": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", - "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "dev": true, "funding": [ { "type": "GitHub Sponsors", @@ -15677,12 +15766,14 @@ "type": "OpenCollective", "url": "https://opencollective.com/unified" } - ] + ], + "license": "MIT" }, "node_modules/micromark-util-types": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.0.tgz", - "integrity": "sha512-oNh6S2WMHWRZrmutsRmDDfkzKtxF+bc2VxLC9dvtrDIRFln627VsFP6fLMgTryGDljgLPjkrzQSDcPrjPyDJ5w==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.1.tgz", + "integrity": "sha512-534m2WhVTddrcKVepwmVEVnUAmtrx9bfIjNoQHRqfnvdaHQiFytEhJoTgpWJvDEXCO5gLTQh3wYC1PgOJA4NSQ==", + "dev": true, "funding": [ { "type": "GitHub Sponsors", @@ -15692,7 +15783,8 @@ "type": "OpenCollective", "url": "https://opencollective.com/unified" } - ] + ], + "license": "MIT" }, "node_modules/micromatch": { "version": "4.0.8", @@ -16280,15 +16372,16 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/oniguruma-to-js": { - "version": "0.4.3", - "resolved": "https://registry.npmjs.org/oniguruma-to-js/-/oniguruma-to-js-0.4.3.tgz", - "integrity": "sha512-X0jWUcAlxORhOqqBREgPMgnshB7ZGYszBNspP+tS9hPD3l13CdaXcHbgImoHUHlrvGx/7AvFEkTRhAGYh+jzjQ==", + "node_modules/oniguruma-to-es": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/oniguruma-to-es/-/oniguruma-to-es-2.0.0.tgz", + "integrity": "sha512-pE7+9jQgomy10aK6BJKRNHj1Nth0YLOzb3iRuhlz4gRzNSBSd7hga6U8BE6o0SoSuSkqv+PPtt511Msd1Hkl0w==", + "dev": true, + "license": "MIT", "dependencies": { - "regex": "^4.3.2" - }, - "funding": { - "url": "https://github.com/sponsors/antfu" + "emoji-regex-xs": "^1.0.0", + "regex": "^5.1.1", + "regex-recursion": "^5.1.1" } }, "node_modules/open": { @@ -17026,6 +17119,8 @@ "version": "6.5.0", "resolved": "https://registry.npmjs.org/property-information/-/property-information-6.5.0.tgz", "integrity": "sha512-PgTgs/BlvHxOu8QuEN7wi5A0OmXaBcHpmCSTehcs6Uuu9IkDIEo13Hy7n898RHfrQ49vKCoGeWZSaAK01nwVig==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -17078,6 +17173,7 @@ "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, "engines": { "node": ">=6" } @@ -18405,9 +18501,32 @@ } }, "node_modules/regex": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/regex/-/regex-4.3.2.tgz", - "integrity": "sha512-kK/AA3A9K6q2js89+VMymcboLOlF5lZRCYJv3gzszXFHBr6kO6qLGzbm+UIugBEV8SMMKCTR59txoY6ctRHYVw==" + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/regex/-/regex-5.1.1.tgz", + "integrity": "sha512-dN5I359AVGPnwzJm2jN1k0W9LPZ+ePvoOeVMMfqIMFz53sSwXkxaJoxr50ptnsC771lK95BnTrVSZxq0b9yCGw==", + "dev": true, + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-recursion": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/regex-recursion/-/regex-recursion-5.1.1.tgz", + "integrity": "sha512-ae7SBCbzVNrIjgSbh7wMznPcQel1DNlDtzensnFxpiNpXt1U2ju/bHugH422r+4LAVS1FpW1YCwilmnNsjum9w==", + "dev": true, + "license": "MIT", + "dependencies": { + "regex": "^5.1.1", + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-utilities": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/regex-utilities/-/regex-utilities-2.3.0.tgz", + "integrity": "sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==", + "dev": true, + "license": "MIT" }, "node_modules/regexp.prototype.flags": { "version": "1.5.2", @@ -19174,15 +19293,19 @@ } }, "node_modules/shiki": { - "version": "1.17.6", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.17.6.tgz", - "integrity": "sha512-RejGugKpDM75vh6YtF9R771acxHRDikC/01kxsUGW+Pnaz3pTY+c8aZB5CnD7p0vuFPs1HaoAIU/4E+NCfS+mQ==", - "dependencies": { - "@shikijs/core": "1.17.6", - "@shikijs/engine-javascript": "1.17.6", - "@shikijs/engine-oniguruma": "1.17.6", - "@shikijs/types": "1.17.6", - "@shikijs/vscode-textmate": "^9.2.2", + "version": "1.27.2", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.27.2.tgz", + "integrity": "sha512-QtA1C41oEVixKog+V8I3ia7jjGls7oCZ8Yul8vdHrVBga5uPoyTtMvFF4lMMXIyAZo5A5QbXq91bot2vA6Q+eQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/core": "1.27.2", + "@shikijs/engine-javascript": "1.27.2", + "@shikijs/engine-oniguruma": "1.27.2", + "@shikijs/langs": "1.27.2", + "@shikijs/themes": "1.27.2", + "@shikijs/types": "1.27.2", + "@shikijs/vscode-textmate": "^10.0.1", "@types/hast": "^3.0.4" } }, @@ -19348,6 +19471,8 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -19580,6 +19705,8 @@ "version": "4.0.4", "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "dev": true, + "license": "MIT", "dependencies": { "character-entities-html4": "^2.0.0", "character-entities-legacy": "^3.0.0" @@ -20031,6 +20158,8 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" @@ -20649,15 +20778,17 @@ } }, "node_modules/typedoc": { - "version": "0.26.10", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.10.tgz", - "integrity": "sha512-xLmVKJ8S21t+JeuQLNueebEuTVphx6IrP06CdV7+0WVflUSW3SPmR+h1fnWVdAR/FQePEgsSWCUHXqKKjzuUAw==", + "version": "0.27.6", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.27.6.tgz", + "integrity": "sha512-oBFRoh2Px6jFx366db0lLlihcalq/JzyCVp7Vaq1yphL/tbgx2e+bkpkCgJPunaPvPwoTOXSwasfklWHm7GfAw==", + "dev": true, + "license": "Apache-2.0", "dependencies": { + "@gerrit0/mini-shiki": "^1.24.0", "lunr": "^2.3.9", "markdown-it": "^14.1.0", "minimatch": "^9.0.5", - "shiki": "^1.16.2", - "yaml": "^2.5.1" + "yaml": "^2.6.1" }, "bin": { "typedoc": "bin/typedoc" @@ -20666,24 +20797,27 @@ "node": ">= 18" }, "peerDependencies": { - "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x" + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x" } }, "node_modules/typedoc-plugin-markdown": { - "version": "4.2.10", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.2.10.tgz", - "integrity": "sha512-PLX3pc1/7z13UJm4TDE9vo9jWGcClFUErXXtd5LdnoLjV6mynPpqZLU992DwMGFSRqJFZeKbVyqlNNeNHnk2tQ==", + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.4.1.tgz", + "integrity": "sha512-fx23nSCvewI9IR8lzIYtzDphETcgTDuxKcmHKGD4lo36oexC+B1k4NaCOY58Snqb4OlE8OXDAGVcQXYYuLRCNw==", + "dev": true, + "license": "MIT", "engines": { "node": ">= 18" }, "peerDependencies": { - "typedoc": "0.26.x" + "typedoc": "0.27.x" } }, "node_modules/typedoc/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, "dependencies": { "balanced-match": "^1.0.0" } @@ -20692,6 +20826,7 @@ "version": "9.0.5", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "dev": true, "dependencies": { "brace-expansion": "^2.0.1" }, @@ -20703,9 +20838,11 @@ } }, "node_modules/typedoc/node_modules/yaml": { - "version": "2.5.1", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.5.1.tgz", - "integrity": "sha512-bLQOjaX/ADgQ20isPJRvF0iRUHIxVhYvr53Of7wGcWlO2jvtUlH5m87DsmulFVxRpNLOnI4tB6p/oh8D7kpn9Q==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.0.tgz", + "integrity": "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA==", + "dev": true, + "license": "ISC", "bin": { "yaml": "bin.mjs" }, @@ -20728,7 +20865,8 @@ "node_modules/uc.micro": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", - "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==" + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true }, "node_modules/unbox-primitive": { "version": "1.0.2", @@ -20843,6 +20981,8 @@ "version": "6.0.0", "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.0.tgz", "integrity": "sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "^3.0.0" }, @@ -20855,6 +20995,8 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "^3.0.0" }, @@ -20867,6 +21009,8 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "^3.0.0" }, @@ -20879,6 +21023,8 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.0.0.tgz", "integrity": "sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "^3.0.0", "unist-util-is": "^6.0.0", @@ -20893,6 +21039,8 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.1.tgz", "integrity": "sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "^3.0.0", "unist-util-is": "^6.0.0" @@ -21101,6 +21249,8 @@ "version": "6.0.3", "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "^3.0.0", "vfile-message": "^4.0.0" @@ -21114,6 +21264,8 @@ "version": "4.0.2", "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.2.tgz", "integrity": "sha512-jRDZ1IMLttGj41KcZvlrYAaI3CfqpLpfpf+Mfig13viT6NKvRzWZ+lXz0Y5D60w6uJIBAOGq9mSHf0gktF0duw==", + "dev": true, + "license": "MIT", "dependencies": { "@types/unist": "^3.0.0", "unist-util-stringify-position": "^4.0.0" @@ -22052,6 +22204,8 @@ "version": "2.0.4", "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "dev": true, + "license": "MIT", "funding": { "type": "github", "url": "https://github.com/sponsors/wooorm" diff --git a/package.json b/package.json index 7fd2f550eb..c2df305987 100644 --- a/package.json +++ b/package.json @@ -63,8 +63,6 @@ "redux": "^5.0.1", "redux-thunk": "^3.1.0", "sanitize-html": "^2.13.0", - "typedoc": "^0.26.10", - "typedoc-plugin-markdown": "^4.2.10", "typescript": "^5.6.3", "vite": "^5.4.8", "vite-plugin-environment": "^1.1.3", @@ -92,7 +90,9 @@ "update:toc": "node scripts/githooks/update-toc.js", "lint-staged": "lint-staged --concurrent false", "setup": "tsx setup.ts", - "check-localstorage": "node scripts/githooks/check-localstorage-usage.js" + "check-localstorage": "node scripts/githooks/check-localstorage-usage.js", + "postgenerate-docs": "find docs/docs/auto-docs -name 'README.md' -delete", + "generate-docs": "typedoc && npm run postgenerate-docs && node fix-readme-links.js" }, "eslintConfig": { "extends": [ @@ -156,7 +156,10 @@ "lint-staged": "^15.3.0", "postcss-modules": "^6.0.1", "sass": "^1.80.7", + "shiki": "^1.26.1", "tsx": "^4.19.1", + "typedoc": "^0.27.6", + "typedoc-plugin-markdown": "^4.4.1", "vite-plugin-svgr": "^4.2.0", "vitest": "^2.1.5", "whatwg-fetch": "^3.6.20" diff --git a/talawa-admin-docs/.nojekyll b/talawa-admin-docs/.nojekyll deleted file mode 100644 index e2ac6616ad..0000000000 --- a/talawa-admin-docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/talawa-admin-docs/Dockerfile b/talawa-admin-docs/Dockerfile deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/talawa-admin-docs/README.md b/talawa-admin-docs/README.md deleted file mode 100644 index 82dc89754c..0000000000 --- a/talawa-admin-docs/README.md +++ /dev/null @@ -1,52 +0,0 @@ -talawa-admin / [Modules](modules.md) - -# Talawa Admin -💬 Join the community on Slack. The link can be found in the `Talawa` [README.md](https://github.com/PalisadoesFoundation/talawa) file. - -![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 - -\