Main content goes here
``` + +## Defined in + +[src/components/AddOn/support/components/MainContent/MainContent.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/components/MainContent/MainContent.tsx#L25) 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 index 56393085ed..ebd121904a 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/AddOn/support/components/SidePanel/SidePanel.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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` +• **props**: `InterfaceSidePanelProps` The properties for the component. @@ -31,3 +27,7 @@ A JSX element containing the side panel with the provided child elements.Side panel content
``` + +## Defined in + +[src/components/AddOn/support/components/SidePanel/SidePanel.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/components/SidePanel/SidePanel.tsx#L30) 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 index 28fa9d3a9a..eca50c420a 100644 --- 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 @@ -1,11 +1,9 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Class: default -Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 @@ -24,8 +22,6 @@ Helper class for managing plugin-related tasks such as fetching store data, inst > **fetchInstalled**(): `Promise`\<`any`\> -Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/services/Plugin.helper.ts#L21) - Fetches the list of installed plugins from a local server. #### Returns @@ -34,14 +30,16 @@ Fetches the list of installed plugins from a local server. A promise that resolves to the installed plugins data in JSON format. +#### Defined in + +[src/components/AddOn/support/services/Plugin.helper.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/services/Plugin.helper.ts#L21) + *** ### fetchStore() > **fetchStore**(): `Promise`\<`any`\> -Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/services/Plugin.helper.ts#L11) - Fetches the store data from a local server. #### Returns @@ -50,21 +48,21 @@ Fetches the store data from a local server. A promise that resolves to the store data in JSON format. +#### Defined in + +[src/components/AddOn/support/services/Plugin.helper.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/services/Plugin.helper.ts#L11) + *** ### generateLinks() > **generateLinks**(`plugins`): `object`[] -Defined in: [src/components/AddOn/support/services/Plugin.helper.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/services/Plugin.helper.ts#L32) - Generates an array of links for the enabled plugins. #### Parameters -##### plugins - -`any`[] +• **plugins**: `any`[] An array of plugin objects. @@ -73,3 +71,7 @@ An array of plugin objects. `object`[] An array of objects containing the name and URL of each enabled plugin. + +#### Defined in + +[src/components/AddOn/support/services/Plugin.helper.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/services/Plugin.helper.ts#L32) 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 index 79eb0f64cd..47055e6e75 100644 --- 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 @@ -1,11 +1,9 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Class: default -Defined in: [src/components/AddOn/support/services/Render.helper.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddOn/support/services/Render.helper.ts#L1) - ## Constructors ### new default() diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md index e6b51b1791..4abf69e37f 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,17 +6,11 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L63) - ## Parameters -### props - -[`InterfaceAddPeopleToTagProps`](../interfaces/InterfaceAddPeopleToTagProps.md) - -### deprecatedLegacyContext? +• **props**: [`InterfaceAddPeopleToTagProps`](../interfaces/InterfaceAddPeopleToTagProps.md) -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -27,3 +21,7 @@ Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:63](https://github ## Returns `ReactNode` + +## Defined in + +[src/components/AddPeopleToTag/AddPeopleToTag.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L63) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md index 725cc64e7a..928e84c220 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTag/interfaces/InterfaceAddPeopleToTagProps.md @@ -1,11 +1,9 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceAddPeopleToTagProps -Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L49) - Props for the `AddPeopleToTag` component. ## CSS Strategy Explanation: @@ -35,7 +33,9 @@ For more details on the reusable classes, refer to the global CSS file. > **addPeopleToTagModalIsOpen**: `boolean` -Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L50) +#### Defined in + +[src/components/AddPeopleToTag/AddPeopleToTag.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L50) *** @@ -43,36 +43,44 @@ Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:50](https://github > **hideAddPeopleToTagModal**: () => `void` -Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L51) - #### Returns `void` +#### Defined in + +[src/components/AddPeopleToTag/AddPeopleToTag.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L51) + *** ### refetchAssignedMembersData() > **refetchAssignedMembersData**: () => `void` -Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L52) - #### Returns `void` +#### Defined in + +[src/components/AddPeopleToTag/AddPeopleToTag.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L52) + *** ### t -> **t**: `TFunction`\<`"manageTag"`\> +> **t**: `TFunction`\<`"translation"`, `"manageTag"`\> -Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L53) +#### Defined in + +[src/components/AddPeopleToTag/AddPeopleToTag.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L53) *** ### tCommon -> **tCommon**: `TFunction`\<`"common"`\> +> **tCommon**: `TFunction`\<`"common"`, `undefined`\> + +#### Defined in -Defined in: [src/components/AddPeopleToTag/AddPeopleToTag.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L54) +[src/components/AddPeopleToTag/AddPeopleToTag.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTag.tsx#L54) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md index d46097782f..7617338e8e 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **MOCKS**: (`object` \| `object` \| `object`)[] -Defined in: [src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L5) +## Defined in + +[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 2fabcc4de5..859aeb5767 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS_ERROR.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS_ERROR.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,50 +6,6 @@ > `const` **MOCKS\_ERROR**: `object`[] -Defined in: [src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L277) +## Defined in -## 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` = `''` +[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L277) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_EMPTY.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_EMPTY.md index dc17afac1e..b2b863459b 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_EMPTY.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_EMPTY.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,74 +6,6 @@ > `const` **MOCK\_EMPTY**: `object`[] -Defined in: [src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L294) +## Defined in -## Type declaration - -### request - -> **request**: `object` - -#### request.query - -> **query**: `DocumentNode` = `USER_TAGS_MEMBERS_TO_ASSIGN_TO` - -#### request.variables - -> **variables**: `object` - -#### request.variables.first - -> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE` - -#### request.variables.id - -> **id**: `string` = `'1'` - -#### request.variables.where - -> **where**: `object` - -#### request.variables.where.firstName - -> **firstName**: `object` - -#### request.variables.where.firstName.starts\_with - -> **starts\_with**: `string` = `''` - -#### request.variables.where.lastName - -> **lastName**: `object` - -#### request.variables.where.lastName.starts\_with - -> **starts\_with**: `string` = `''` - -### result - -> **result**: `object` - -#### result.data - -> **data**: `object` - -#### result.data.getUsersToAssignTo - -> **getUsersToAssignTo**: `object` - -#### result.data.getUsersToAssignTo.usersToAssignTo - -> **usersToAssignTo**: `object` - -#### result.data.getUsersToAssignTo.usersToAssignTo.edges - -> **edges**: `any`[] = `[]` - -#### result.data.getUsersToAssignTo.usersToAssignTo.pageInfo - -> **pageInfo**: `object` - -#### result.data.getUsersToAssignTo.usersToAssignTo.pageInfo.hasNextPage - -> **hasNextPage**: `boolean` = `false` +[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L294) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NON_ERROR.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NON_ERROR.md index f2b5fdabb6..87ec4279a1 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NON_ERROR.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NON_ERROR.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Variable: MOCK\_NON\_ERROR -> `const` **MOCK\_NON\_ERROR**: (\{ `error`: `undefined`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `id`: `string`; `tagId`: `undefined`; `userIds`: `undefined`; `where`: \{ `firstName`: \{ `starts_with`: `string`; \}; `lastName`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `getUsersToAssignTo`: \{ `usersToAssignTo`: \{ `edges`: `object`[]; `pageInfo`: \{ `endCursor`: `string`; `hasNextPage`: `boolean`; \}; \}; \}; \}; \}; \} \| \{ `error`: `Error`; `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `tagId`: `string`; `userIds`: `string`[]; `where`: `undefined`; \}; \}; `result`: `undefined`; \})[] +> `const` **MOCK\_NON\_ERROR**: (`object` \| `object`)[] -Defined in: [src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L322) +## Defined in + +[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L322) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NO_DATA.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NO_DATA.md index fa9241cdd6..d7451eb545 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NO_DATA.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NO_DATA.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Variable: MOCK\_NO\_DATA -> `const` **MOCK\_NO\_DATA**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `number`; `id`: `string`; `tagId`: `undefined`; `userIds`: `undefined`; `where`: \{ `firstName`: \{ `starts_with`: `string`; \}; `lastName`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `getUsersToAssignTo`: \{ `usersToAssignTo`: \{ `edges`: `object`[]; `pageInfo`: \{ `endCursor`: `string`; `hasNextPage`: `boolean`; \}; \}; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `first`: `undefined`; `id`: `undefined`; `tagId`: `string`; `userIds`: `string`[]; `where`: `undefined`; \}; \}; `result`: \{ `data`: `any`; \}; \})[] +> `const` **MOCK\_NO\_DATA**: (`object` \| `object`)[] -Defined in: [src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:413](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L413) +## Defined in + +[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:413](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L413) diff --git a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NULL_FETCH_MORE.md b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NULL_FETCH_MORE.md index 296337df61..22a5727e48 100644 --- a/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NULL_FETCH_MORE.md +++ b/docs/docs/auto-docs/components/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NULL_FETCH_MORE.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Variable: MOCK\_NULL\_FETCH\_MORE -> `const` **MOCK\_NULL\_FETCH\_MORE**: (\{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `undefined`; `first`: `number`; `id`: `string`; `where`: \{ `firstName`: \{ `starts_with`: `string`; \}; `lastName`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: \{ `getUsersToAssignTo`: \{ `usersToAssignTo`: \{ `edges`: `object`[]; `pageInfo`: \{ `endCursor`: `string`; `hasNextPage`: `boolean`; \}; \}; \}; \}; \}; \} \| \{ `request`: \{ `query`: `DocumentNode`; `variables`: \{ `after`: `string`; `first`: `number`; `id`: `string`; `where`: \{ `firstName`: \{ `starts_with`: `string`; \}; `lastName`: \{ `starts_with`: `string`; \}; \}; \}; \}; `result`: \{ `data`: `any`; \}; \})[] +> `const` **MOCK\_NULL\_FETCH\_MORE**: (`object` \| `object`)[] -Defined in: [src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:362](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L362) +## Defined in + +[src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts:362](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AddPeopleToTag/AddPeopleToTagsMocks.ts#L362) diff --git a/docs/docs/auto-docs/components/Advertisements/Advertisements/functions/default.md b/docs/docs/auto-docs/components/Advertisements/Advertisements/functions/default.md index 6e8011f189..0290d1c9fc 100644 --- a/docs/docs/auto-docs/components/Advertisements/Advertisements/functions/default.md +++ b/docs/docs/auto-docs/components/Advertisements/Advertisements/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,10 @@ > **default**(): `JSX.Element` -Defined in: [src/components/Advertisements/Advertisements.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Advertisements/Advertisements.tsx#L14) - ## Returns `JSX.Element` + +## Defined in + +[src/components/Advertisements/Advertisements.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Advertisements/Advertisements.tsx#L14) 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 index 9766195e1d..cdd68f3784 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,16 +6,12 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx#L49) - Component for displaying an advertisement entry. Allows viewing, editing, and deleting of the advertisement. ## Parameters -### props - -`InterfaceAddOnEntryProps` +• **props**: `InterfaceAddOnEntryProps` Component properties @@ -42,3 +38,7 @@ class (e.g., .addButton) is now applied. - `.removeButton` For more details on the reusable classes, refer to the global CSS file. + +## Defined in + +[src/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx#L49) 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 index 66be13b7ff..571853903f 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx#L79) - Component for registering or editing an advertisement. ## Parameters -### props - -`InterfaceAddOnRegisterProps` +• **props**: `InterfaceAddOnRegisterProps` Contains form status, advertisement details, and a function to update parent state. @@ -32,3 +28,7 @@ A JSX element that renders a form inside a modal for creating or editing an adve setAfter={(value) => console.log(value)} /> ``` + +## Defined in + +[src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx#L79) diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainer/functions/default.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainer/functions/default.md index 12a24ac766..d3ef2d2eb3 100644 --- a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainer/functions/default.md +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainer/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,27 +6,19 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/AgendaCategory/AgendaCategoryContainer.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainer.tsx#L34) - Component for displaying and managing agenda item categories. ## Parameters -### props +• **props** Contains agenda category data and functions for data management. -#### agendaCategoryConnection - -`"Organization"` - -#### agendaCategoryData +• **props.agendaCategoryConnection**: `"Organization"` -[`InterfaceAgendaItemCategoryInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md)[] +• **props.agendaCategoryData**: [`InterfaceAgendaItemCategoryInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md)[] -#### agendaCategoryRefetch - -() => `void` +• **props.agendaCategoryRefetch** ## Returns @@ -43,3 +35,7 @@ A JSX element that renders agenda item categories with options to preview, edit, agendaCategoryRefetch={refetch} /> ``` + +## Defined in + +[src/components/AgendaCategory/AgendaCategoryContainer.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainer.tsx#L34) diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS.md index 61e8e0e987..f143863720 100644 --- a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS.md +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerMocks/variables/MOCKS.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **MOCKS**: (`object` \| `object`)[] -Defined in: [src/components/AgendaCategory/AgendaCategoryContainerMocks.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainerMocks.ts#L6) +## Defined in + +[src/components/AgendaCategory/AgendaCategoryContainerMocks.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 3ebffacbef..0ebea883dc 100644 --- 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 @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **MOCKS\_ERROR\_MUTATIONS**: (`object` \| `object`)[] -Defined in: [src/components/AgendaCategory/AgendaCategoryContainerMocks.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainerMocks.ts#L81) +## Defined in + +[src/components/AgendaCategory/AgendaCategoryContainerMocks.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 2d1193aa36..3040a4b9d9 100644 --- a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props.md +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > `const` **props**: `object` -Defined in: [src/components/AgendaCategory/AgendaCategoryContainerProps.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainerProps.ts#L4) - ## Type declaration ### agendaCategoryConnection @@ -20,4 +18,8 @@ Defined in: [src/components/AgendaCategory/AgendaCategoryContainerProps.ts:4](ht ### agendaCategoryRefetch -> **agendaCategoryRefetch**: `Mock` +> **agendaCategoryRefetch**: `Mock`\<`Procedure`\> + +## Defined in + +[src/components/AgendaCategory/AgendaCategoryContainerProps.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainerProps.ts#L4) diff --git a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props2.md b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props2.md index a6f2019fc9..de18f4cf68 100644 --- a/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props2.md +++ b/docs/docs/auto-docs/components/AgendaCategory/AgendaCategoryContainerProps/variables/props2.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > `const` **props2**: `object` -Defined in: [src/components/AgendaCategory/AgendaCategoryContainerProps.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainerProps.ts#L31) - ## Type declaration ### agendaCategoryConnection @@ -20,4 +18,8 @@ Defined in: [src/components/AgendaCategory/AgendaCategoryContainerProps.ts:31](h ### agendaCategoryRefetch -> **agendaCategoryRefetch**: `Mock` +> **agendaCategoryRefetch**: `Mock`\<`Procedure`\> + +## Defined in + +[src/components/AgendaCategory/AgendaCategoryContainerProps.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaCategory/AgendaCategoryContainerProps.ts#L31) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainer/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainer/functions/default.md index 3c05f0960c..e48544c2b5 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainer/functions/default.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainer/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,36 +6,30 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/AgendaItems/AgendaItemsContainer.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 +• **props** The props for the component. -#### agendaItemCategories - -[`InterfaceAgendaItemCategoryInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md)[] - -#### agendaItemConnection - -`"Event"` +• **props.agendaItemCategories**: [`InterfaceAgendaItemCategoryInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemCategoryInfo.md)[] -#### agendaItemData +• **props.agendaItemConnection**: `"Event"` -[`InterfaceAgendaItemInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemInfo.md)[] +• **props.agendaItemData**: [`InterfaceAgendaItemInfo`](../../../../utils/interfaces/interfaces/InterfaceAgendaItemInfo.md)[] -#### agendaItemRefetch - -() => `void` +• **props.agendaItemRefetch** ## Returns `JSX.Element` JSX.Element + +## Defined in + +[src/components/AgendaItems/AgendaItemsContainer.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsContainer.tsx#L32) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS.md index bcbc733733..2271118585 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **MOCKS**: (`object` \| `object`)[] -Defined in: [src/components/AgendaItems/AgendaItemsContainerMocks.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsContainerMocks.ts#L6) +## Defined in + +[src/components/AgendaItems/AgendaItemsContainerMocks.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index b8f06ef939..4a8c17d8c5 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS_ERROR.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerMocks/variables/MOCKS_ERROR.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **MOCKS\_ERROR**: (`object` \| `object`)[] -Defined in: [src/components/AgendaItems/AgendaItemsContainerMocks.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsContainerMocks.ts#L96) +## Defined in + +[src/components/AgendaItems/AgendaItemsContainerMocks.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 4f865890f2..186c023a83 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > `const` **props**: `object` -Defined in: [src/components/AgendaItems/AgendaItemsContainerProps.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsContainerProps.ts#L4) - ## Type declaration ### agendaItemCategories @@ -24,4 +22,8 @@ Defined in: [src/components/AgendaItems/AgendaItemsContainerProps.ts:4](https:// ### agendaItemRefetch -> **agendaItemRefetch**: `Mock` +> **agendaItemRefetch**: `Mock`\<`Procedure`\> + +## Defined in + +[src/components/AgendaItems/AgendaItemsContainerProps.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsContainerProps.ts#L4) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props2.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props2.md index d183744cd1..3f51531070 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props2.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsContainerProps/variables/props2.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > `const` **props2**: `object` -Defined in: [src/components/AgendaItems/AgendaItemsContainerProps.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsContainerProps.ts#L97) - ## Type declaration ### agendaItemCategories @@ -24,4 +22,8 @@ Defined in: [src/components/AgendaItems/AgendaItemsContainerProps.ts:97](https:/ ### agendaItemRefetch -> **agendaItemRefetch**: `Mock` +> **agendaItemRefetch**: `Mock`\<`Procedure`\> + +## Defined in + +[src/components/AgendaItems/AgendaItemsContainerProps.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsContainerProps.ts#L97) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsCreateModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsCreateModal/functions/default.md index b76deee04e..5f45f9ea4f 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsCreateModal/functions/default.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsCreateModal/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,20 +6,14 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/AgendaItems/AgendaItemsCreateModal.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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? +• **props**: `InterfaceAgendaItemsCreateModalProps` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -30,3 +24,7 @@ Displays a modal form where users can input details for a new agenda item, inclu ## Returns `ReactNode` + +## Defined in + +[src/components/AgendaItems/AgendaItemsCreateModal.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsCreateModal.tsx#L43) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsDeleteModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsDeleteModal/functions/default.md index 8657261827..12a5d1b7c3 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsDeleteModal/functions/default.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsDeleteModal/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,20 +6,14 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/AgendaItems/AgendaItemsDeleteModal.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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? +• **props**: `InterfaceAgendaItemsDeleteModalProps` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -30,3 +24,7 @@ Displays a confirmation dialog when a user attempts to delete an agenda item. ## Returns `ReactNode` + +## Defined in + +[src/components/AgendaItems/AgendaItemsDeleteModal.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsDeleteModal.tsx#L23) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsPreviewModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsPreviewModal/functions/default.md index cac219b1ab..20bc350242 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsPreviewModal/functions/default.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsPreviewModal/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,21 +6,15 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/AgendaItems/AgendaItemsPreviewModal.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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? +• **props**: `InterfaceAgendaItemsPreviewModalProps` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -31,3 +25,7 @@ Also provides options to update or delete the agenda item. ## Returns `ReactNode` + +## Defined in + +[src/components/AgendaItems/AgendaItemsPreviewModal.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsPreviewModal.tsx#L41) diff --git a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsUpdateModal/functions/default.md b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsUpdateModal/functions/default.md index 81e7b5548a..aa733f9137 100644 --- a/docs/docs/auto-docs/components/AgendaItems/AgendaItemsUpdateModal/functions/default.md +++ b/docs/docs/auto-docs/components/AgendaItems/AgendaItemsUpdateModal/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,21 +6,15 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/AgendaItems/AgendaItemsUpdateModal.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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? +• **props**: `InterfaceAgendaItemsUpdateModalProps` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -31,3 +25,7 @@ Also includes functionality to add, remove URLs and attachments. ## Returns `ReactNode` + +## Defined in + +[src/components/AgendaItems/AgendaItemsUpdateModal.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AgendaItems/AgendaItemsUpdateModal.tsx#L49) diff --git a/docs/docs/auto-docs/components/Avatar/Avatar/functions/default.md b/docs/docs/auto-docs/components/Avatar/Avatar/functions/default.md index ff8b1a579a..c2c1f10836 100644 --- a/docs/docs/auto-docs/components/Avatar/Avatar/functions/default.md +++ b/docs/docs/auto-docs/components/Avatar/Avatar/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,19 +6,19 @@ > **default**(`__namedParameters`): `Element` -Defined in: [src/components/Avatar/Avatar.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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` +• **\_\_namedParameters**: `InterfaceAvatarProps` ## Returns `Element` JSX.Element - The rendered avatar image component. + +## Defined in + +[src/components/Avatar/Avatar.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Avatar/Avatar.tsx#L29) diff --git a/docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md b/docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md index 1f367307bd..acb7e89465 100644 --- a/docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md +++ b/docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,16 +6,12 @@ > **default**(`props`): `Element` -Defined in: [src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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` +• **props**: `InterfaceChangeLanguageDropDownProps` The properties for customizing the dropdown component. @@ -24,3 +20,7 @@ The properties for customizing the dropdown component. `Element` JSX.Element - The rendered dropdown component for changing languages. + +## Defined in + +[src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx#L29) diff --git a/docs/docs/auto-docs/components/CheckIn/CheckInModal/functions/CheckInModal.md b/docs/docs/auto-docs/components/CheckIn/CheckInModal/functions/CheckInModal.md index b839cf4399..5b75b946d1 100644 --- a/docs/docs/auto-docs/components/CheckIn/CheckInModal/functions/CheckInModal.md +++ b/docs/docs/auto-docs/components/CheckIn/CheckInModal/functions/CheckInModal.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,19 +6,19 @@ > **CheckInModal**(`__namedParameters`): `Element` -Defined in: [src/components/CheckIn/CheckInModal.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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) +• **\_\_namedParameters**: [`InterfaceModalProp`](../../types/interfaces/InterfaceModalProp.md) ## Returns `Element` JSX.Element - The rendered modal component. + +## Defined in + +[src/components/CheckIn/CheckInModal.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/CheckInModal.tsx#L26) diff --git a/docs/docs/auto-docs/components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md b/docs/docs/auto-docs/components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md index 9fb1081a55..bf63deb080 100644 --- a/docs/docs/auto-docs/components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md +++ b/docs/docs/auto-docs/components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **CheckInWrapper**(`eventId`): `Element` -Defined in: [src/components/CheckIn/CheckInWrapper.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/CheckInWrapper.tsx#L17) - Wrapper component that displays a button to open the CheckInModal. ## Parameters -### eventId - -`PropType` +• **eventId**: `PropType` The ID of the event for which check-in management is being handled. @@ -23,3 +19,7 @@ The ID of the event for which check-in management is being handled. `Element` JSX.Element - The rendered CheckInWrapper component. + +## Defined in + +[src/components/CheckIn/CheckInWrapper.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/CheckInWrapper.tsx#L17) diff --git a/docs/docs/auto-docs/components/CheckIn/TableRow/functions/TableRow.md b/docs/docs/auto-docs/components/CheckIn/TableRow/functions/TableRow.md index 86f5030b1b..0bdc325446 100644 --- a/docs/docs/auto-docs/components/CheckIn/TableRow/functions/TableRow.md +++ b/docs/docs/auto-docs/components/CheckIn/TableRow/functions/TableRow.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,25 +6,23 @@ > **TableRow**(`__namedParameters`): `Element` -Defined in: [src/components/CheckIn/TableRow.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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) +• **\_\_namedParameters** -#### refetch +• **\_\_namedParameters.data**: [`InterfaceTableCheckIn`](../../types/interfaces/InterfaceTableCheckIn.md) -() => `void` +• **\_\_namedParameters.refetch** ## Returns `Element` JSX.Element - The rendered TableRow component. + +## Defined in + +[src/components/CheckIn/TableRow.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/TableRow.tsx#L19) diff --git a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationSuccess.md b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationSuccess.md index 1be41d1243..21dc7316b7 100644 --- a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationSuccess.md +++ b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationSuccess.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,42 +6,6 @@ > `const` **checkInMutationSuccess**: `object`[] -Defined in: [src/components/CheckIn/mocks.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/mocks.ts#L46) +## Defined in -## 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'` +[src/components/CheckIn/mocks.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/mocks.ts#L46) diff --git a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationUnsuccess.md b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationUnsuccess.md index 658f352ced..02682321e5 100644 --- a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationUnsuccess.md +++ b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInMutationUnsuccess.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,30 +6,6 @@ > `const` **checkInMutationUnsuccess**: `object`[] -Defined in: [src/components/CheckIn/mocks.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/mocks.ts#L65) +## Defined in -## 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'` +[src/components/CheckIn/mocks.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/mocks.ts#L65) diff --git a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInQueryMock.md b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInQueryMock.md index 674eaa2751..e67e9968d3 100644 --- a/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInQueryMock.md +++ b/docs/docs/auto-docs/components/CheckIn/mocks/variables/checkInQueryMock.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,30 +6,6 @@ > `const` **checkInQueryMock**: `object`[] -Defined in: [src/components/CheckIn/mocks.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/mocks.ts#L34) +## Defined in -## 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` +[src/components/CheckIn/mocks.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/mocks.ts#L34) diff --git a/docs/docs/auto-docs/components/CheckIn/tagTemplate/variables/tagTemplate.md b/docs/docs/auto-docs/components/CheckIn/tagTemplate/variables/tagTemplate.md index e01884afef..5d716a7588 100644 --- a/docs/docs/auto-docs/components/CheckIn/tagTemplate/variables/tagTemplate.md +++ b/docs/docs/auto-docs/components/CheckIn/tagTemplate/variables/tagTemplate.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,4 +6,6 @@ > `const` **tagTemplate**: `Template` -Defined in: [src/components/CheckIn/tagTemplate.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/tagTemplate.ts#L4) +## Defined in + +[src/components/CheckIn/tagTemplate.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 5d72320957..afdebe3268 100644 --- a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeCheckIn.md +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeCheckIn.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceAttendeeCheckIn -Defined in: [src/components/CheckIn/types.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L7) - ## Properties ### \_id > **\_id**: `string` -Defined in: [src/components/CheckIn/types.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L8) +#### Defined in + +[src/components/CheckIn/types.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L8) *** @@ -20,8 +20,6 @@ Defined in: [src/components/CheckIn/types.ts:8](https://github.com/PalisadoesFou > **checkIn**: `object` -Defined in: [src/components/CheckIn/types.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L10) - #### \_id > **\_id**: `string` @@ -30,10 +28,16 @@ Defined in: [src/components/CheckIn/types.ts:10](https://github.com/PalisadoesFo > **time**: `string` +#### Defined in + +[src/components/CheckIn/types.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L10) + *** ### user > **user**: [`InterfaceUser`](InterfaceUser.md) -Defined in: [src/components/CheckIn/types.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L9) +#### Defined in + +[src/components/CheckIn/types.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 9b60353d71..c1fc562020 100644 --- a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeQueryResponse.md +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceAttendeeQueryResponse.md @@ -1,19 +1,15 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceAttendeeQueryResponse -Defined in: [src/components/CheckIn/types.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L16) - ## Properties ### event > **event**: `object` -Defined in: [src/components/CheckIn/types.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L17) - #### \_id > **\_id**: `string` @@ -21,3 +17,7 @@ Defined in: [src/components/CheckIn/types.ts:17](https://github.com/PalisadoesFo #### attendeesCheckInStatus > **attendeesCheckInStatus**: [`InterfaceAttendeeCheckIn`](InterfaceAttendeeCheckIn.md)[] + +#### Defined in + +[src/components/CheckIn/types.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L17) diff --git a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceModalProp.md b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceModalProp.md index 5d225d7855..ed70408a7d 100644 --- a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceModalProp.md +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceModalProp.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceModalProp -Defined in: [src/components/CheckIn/types.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L23) - ## Properties ### eventId > **eventId**: `string` -Defined in: [src/components/CheckIn/types.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L25) +#### Defined in + +[src/components/CheckIn/types.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L25) *** @@ -20,16 +20,20 @@ Defined in: [src/components/CheckIn/types.ts:25](https://github.com/PalisadoesFo > **handleClose**: () => `void` -Defined in: [src/components/CheckIn/types.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L26) - #### Returns `void` +#### Defined in + +[src/components/CheckIn/types.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L26) + *** ### show > **show**: `boolean` -Defined in: [src/components/CheckIn/types.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L24) +#### Defined in + +[src/components/CheckIn/types.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 04f7c57591..d511e2dec0 100644 --- a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableCheckIn.md +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableCheckIn.md @@ -1,19 +1,15 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceTableCheckIn -Defined in: [src/components/CheckIn/types.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L29) - ## Properties ### checkIn > **checkIn**: `object` -Defined in: [src/components/CheckIn/types.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L33) - #### \_id > **\_id**: `string` @@ -22,13 +18,19 @@ Defined in: [src/components/CheckIn/types.ts:33](https://github.com/PalisadoesFo > **time**: `string` +#### Defined in + +[src/components/CheckIn/types.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L33) + *** ### eventId > **eventId**: `string` -Defined in: [src/components/CheckIn/types.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L37) +#### Defined in + +[src/components/CheckIn/types.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L37) *** @@ -36,7 +38,9 @@ Defined in: [src/components/CheckIn/types.ts:37](https://github.com/PalisadoesFo > **id**: `string` -Defined in: [src/components/CheckIn/types.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L30) +#### Defined in + +[src/components/CheckIn/types.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L30) *** @@ -44,7 +48,9 @@ Defined in: [src/components/CheckIn/types.ts:30](https://github.com/PalisadoesFo > **name**: `string` -Defined in: [src/components/CheckIn/types.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L31) +#### Defined in + +[src/components/CheckIn/types.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L31) *** @@ -52,4 +58,6 @@ Defined in: [src/components/CheckIn/types.ts:31](https://github.com/PalisadoesFo > **userId**: `string` -Defined in: [src/components/CheckIn/types.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L32) +#### Defined in + +[src/components/CheckIn/types.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 87b6ad6223..f57c939568 100644 --- a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableData.md +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceTableData.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceTableData -Defined in: [src/components/CheckIn/types.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L40) - ## Properties ### checkInData > **checkInData**: [`InterfaceTableCheckIn`](InterfaceTableCheckIn.md) -Defined in: [src/components/CheckIn/types.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L43) +#### Defined in + +[src/components/CheckIn/types.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L43) *** @@ -20,7 +20,9 @@ Defined in: [src/components/CheckIn/types.ts:43](https://github.com/PalisadoesFo > **id**: `string` -Defined in: [src/components/CheckIn/types.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L42) +#### Defined in + +[src/components/CheckIn/types.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L42) *** @@ -28,4 +30,6 @@ Defined in: [src/components/CheckIn/types.ts:42](https://github.com/PalisadoesFo > **userName**: `string` -Defined in: [src/components/CheckIn/types.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L41) +#### Defined in + +[src/components/CheckIn/types.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 46ab382288..7ce047a4f6 100644 --- a/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceUser.md +++ b/docs/docs/auto-docs/components/CheckIn/types/interfaces/InterfaceUser.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceUser -Defined in: [src/components/CheckIn/types.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L1) - ## Properties ### \_id > **\_id**: `string` -Defined in: [src/components/CheckIn/types.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L2) +#### Defined in + +[src/components/CheckIn/types.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L2) *** @@ -20,7 +20,9 @@ Defined in: [src/components/CheckIn/types.ts:2](https://github.com/PalisadoesFou > **firstName**: `string` -Defined in: [src/components/CheckIn/types.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L3) +#### Defined in + +[src/components/CheckIn/types.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L3) *** @@ -28,4 +30,6 @@ Defined in: [src/components/CheckIn/types.ts:3](https://github.com/PalisadoesFou > **lastName**: `string` -Defined in: [src/components/CheckIn/types.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CheckIn/types.ts#L4) +#### Defined in + +[src/components/CheckIn/types.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index e0ba82cd13..080e730082 100644 --- a/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/functions/default.md +++ b/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`__namedParameters`): `Element` -Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L24) - A collapsible dropdown component that toggles visibility of sub-targets. ## Parameters -### \_\_namedParameters - -[`InterfaceCollapsibleDropdown`](../interfaces/InterfaceCollapsibleDropdown.md) +• **\_\_namedParameters**: [`InterfaceCollapsibleDropdown`](../interfaces/InterfaceCollapsibleDropdown.md) ## Returns `Element` JSX.Element - The rendered CollapsibleDropdown component. + +## Defined in + +[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L24) diff --git a/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/interfaces/InterfaceCollapsibleDropdown.md b/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/interfaces/InterfaceCollapsibleDropdown.md index bbf3fcd5ed..848020ccb8 100644 --- a/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/interfaces/InterfaceCollapsibleDropdown.md +++ b/docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/interfaces/InterfaceCollapsibleDropdown.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceCollapsibleDropdown -Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L9) - ## Properties ### setShowDropdown > **setShowDropdown**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> -Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L12) +#### Defined in + +[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L12) *** @@ -20,7 +20,9 @@ Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:12](http > **showDropdown**: `boolean` -Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L10) +#### Defined in + +[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L10) *** @@ -28,4 +30,6 @@ Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:10](http > **target**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md) -Defined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L11) +#### Defined in + +[src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 62c8d516d5..a67b3467c6 100644 --- a/docs/docs/auto-docs/components/ContriStats/ContriStats/functions/default.md +++ b/docs/docs/auto-docs/components/ContriStats/ContriStats/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`__namedParameters`): `JSX.Element` -Defined in: [src/components/ContriStats/ContriStats.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ContriStats/ContriStats.tsx#L22) - A component that displays contribution statistics. ## Parameters -### \_\_namedParameters - -`InterfaceContriStatsProps` +• **\_\_namedParameters**: `InterfaceContriStatsProps` ## Returns `JSX.Element` JSX.Element - The rendered component displaying the contribution stats. + +## Defined in + +[src/components/ContriStats/ContriStats.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ContriStats/ContriStats.tsx#L22) diff --git a/docs/docs/auto-docs/components/CurrentHourIndicator/CurrentHourIndicator/functions/default.md b/docs/docs/auto-docs/components/CurrentHourIndicator/CurrentHourIndicator/functions/default.md index 8514b0c501..783f775fcd 100644 --- a/docs/docs/auto-docs/components/CurrentHourIndicator/CurrentHourIndicator/functions/default.md +++ b/docs/docs/auto-docs/components/CurrentHourIndicator/CurrentHourIndicator/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(): `Element` -Defined in: [src/components/CurrentHourIndicator/CurrentHourIndicator.tsx:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CurrentHourIndicator/CurrentHourIndicator.tsx#L9) - A component that displays an indicator for the current hour. ## Returns @@ -15,3 +13,7 @@ A component that displays an indicator for the current hour. `Element` JSX.Element - The rendered component showing the current hour indicator. + +## Defined in + +[src/components/CurrentHourIndicator/CurrentHourIndicator.tsx:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CurrentHourIndicator/CurrentHourIndicator.tsx#L9) diff --git a/docs/docs/auto-docs/components/DynamicDropDown/DynamicDropDown/functions/default.md b/docs/docs/auto-docs/components/DynamicDropDown/DynamicDropDown/functions/default.md index 0239654094..f720f0f745 100644 --- a/docs/docs/auto-docs/components/DynamicDropDown/DynamicDropDown/functions/default.md +++ b/docs/docs/auto-docs/components/DynamicDropDown/DynamicDropDown/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**\<`T`\>(`__namedParameters`): `Element` -Defined in: [src/components/DynamicDropDown/DynamicDropDown.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 @@ -19,12 +17,14 @@ opens a menu with options. When an option is selected, it updates the form state ## Parameters -### \_\_namedParameters - -`InterfaceChangeDropDownProps`\<`T`\> +• **\_\_namedParameters**: `InterfaceChangeDropDownProps`\<`T`\> ## Returns `Element` JSX.Element - The rendered dropdown component. + +## Defined in + +[src/components/DynamicDropDown/DynamicDropDown.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/DynamicDropDown/DynamicDropDown.tsx#L34) diff --git a/docs/docs/auto-docs/components/EditCustomFieldDropDown/EditCustomFieldDropDown/functions/default.md b/docs/docs/auto-docs/components/EditCustomFieldDropDown/EditCustomFieldDropDown/functions/default.md index 8b49db08e7..ee255b7b1c 100644 --- a/docs/docs/auto-docs/components/EditCustomFieldDropDown/EditCustomFieldDropDown/functions/default.md +++ b/docs/docs/auto-docs/components/EditCustomFieldDropDown/EditCustomFieldDropDown/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(`__namedParameters`): `Element` -Defined in: [src/components/EditCustomFieldDropDown/EditCustomFieldDropDown.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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. @@ -16,12 +14,14 @@ When a new type is selected, it updates the custom field data. ## Parameters -### \_\_namedParameters - -`InterfaceEditCustomFieldDropDownProps` +• **\_\_namedParameters**: `InterfaceEditCustomFieldDropDownProps` ## Returns `Element` JSX.Element - The rendered dropdown component. + +## Defined in + +[src/components/EditCustomFieldDropDown/EditCustomFieldDropDown.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EditCustomFieldDropDown/EditCustomFieldDropDown.tsx#L33) diff --git a/docs/docs/auto-docs/components/EventCalendar/EventCalendar/functions/default.md b/docs/docs/auto-docs/components/EventCalendar/EventCalendar/functions/default.md index de0a200cfe..c72024c16e 100644 --- a/docs/docs/auto-docs/components/EventCalendar/EventCalendar/functions/default.md +++ b/docs/docs/auto-docs/components/EventCalendar/EventCalendar/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,17 +6,11 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/EventCalendar/EventCalendar.tsx:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/EventCalendar.tsx#L78) - ## Parameters -### props - -`InterfaceCalendarProps` - -### deprecatedLegacyContext? +• **props**: `InterfaceCalendarProps` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -27,3 +21,7 @@ Defined in: [src/components/EventCalendar/EventCalendar.tsx:78](https://github.c ## Returns `ReactNode` + +## Defined in + +[src/components/EventCalendar/EventCalendar.tsx:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/EventCalendar.tsx#L78) diff --git a/docs/docs/auto-docs/components/EventCalendar/EventHeader/functions/default.md b/docs/docs/auto-docs/components/EventCalendar/EventHeader/functions/default.md index a88539f0fb..7928489c96 100644 --- a/docs/docs/auto-docs/components/EventCalendar/EventHeader/functions/default.md +++ b/docs/docs/auto-docs/components/EventCalendar/EventHeader/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,16 +6,12 @@ > **default**(`__namedParameters`): `JSX.Element` -Defined in: [src/components/EventCalendar/EventHeader.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/EventHeader.tsx#L45) - 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` +• **\_\_namedParameters**: `InterfaceEventHeaderProps` ## Returns @@ -39,3 +35,7 @@ class (e.g., .addButton) is now applied. - `.dropdown` For more details on the reusable classes, refer to the global CSS file. + +## Defined in + +[src/components/EventCalendar/EventHeader.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/EventHeader.tsx#L45) diff --git a/docs/docs/auto-docs/components/EventCalendar/YearlyEventCalender/functions/default.md b/docs/docs/auto-docs/components/EventCalendar/YearlyEventCalender/functions/default.md index 7b8b823262..7728161f5b 100644 --- a/docs/docs/auto-docs/components/EventCalendar/YearlyEventCalender/functions/default.md +++ b/docs/docs/auto-docs/components/EventCalendar/YearlyEventCalender/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/EventCalendar/YearlyEventCalender.tsx:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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. @@ -15,13 +13,9 @@ It displays events for each day, with functionality to expand and view details o ## Parameters -### props - -`InterfaceCalendarProps` - -### deprecatedLegacyContext? +• **props**: `InterfaceCalendarProps` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -34,3 +28,7 @@ It displays events for each day, with functionality to expand and view details o `ReactNode` JSX.Element - The rendered calendar component. + +## Defined in + +[src/components/EventCalendar/YearlyEventCalender.tsx:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/YearlyEventCalender.tsx#L95) diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/holidays.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/holidays.md index b3f2404324..fe4883fd0d 100644 --- a/docs/docs/auto-docs/components/EventCalendar/constants/variables/holidays.md +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/holidays.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,6 @@ > `const` **holidays**: `object`[] -Defined in: [src/components/EventCalendar/constants.js:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/constants.js#L1) +## Defined in -## Type declaration - -### date - -> **date**: `string` = `'05-01'` - -### month - -> **month**: `string` = `'May'` - -### name - -> **name**: `string` = `'May Day / Labour Day'` +[src/components/EventCalendar/constants.js:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/constants.js#L1) diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/hours.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/hours.md index 17e0850647..38ddcff22c 100644 --- a/docs/docs/auto-docs/components/EventCalendar/constants/variables/hours.md +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/hours.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,4 +6,6 @@ > `const` **hours**: `string`[] -Defined in: [src/components/EventCalendar/constants.js:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/constants.js#L39) +## Defined in + +[src/components/EventCalendar/constants.js:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/constants.js#L39) diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/months.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/months.md index 0a4aa59493..0ca9bb6b62 100644 --- a/docs/docs/auto-docs/components/EventCalendar/constants/variables/months.md +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/months.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,4 +6,6 @@ > `const` **months**: `string`[] -Defined in: [src/components/EventCalendar/constants.js:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/constants.js#L25) +## Defined in + +[src/components/EventCalendar/constants.js:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/constants.js#L25) diff --git a/docs/docs/auto-docs/components/EventCalendar/constants/variables/weekdays.md b/docs/docs/auto-docs/components/EventCalendar/constants/variables/weekdays.md index b153e3b3c9..b2bfa1a65e 100644 --- a/docs/docs/auto-docs/components/EventCalendar/constants/variables/weekdays.md +++ b/docs/docs/auto-docs/components/EventCalendar/constants/variables/weekdays.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,4 +6,6 @@ > `const` **weekdays**: `string`[] -Defined in: [src/components/EventCalendar/constants.js:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalendar/constants.js#L16) +## Defined in + +[src/components/EventCalendar/constants.js:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index a6a8af6c89..379e5fbeab 100644 --- a/docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreen/functions/default.md +++ b/docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreen/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(): `Element` -Defined in: [src/components/EventDashboardScreen/EventDashboardScreen.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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. @@ -16,3 +14,7 @@ It includes navigation, a sidebar, and a profile dropdown. `Element` JSX.Element - The rendered EventDashboardScreen component. + +## Defined in + +[src/components/EventDashboardScreen/EventDashboardScreen.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventDashboardScreen/EventDashboardScreen.tsx#L21) diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCard/functions/default.md b/docs/docs/auto-docs/components/EventListCard/EventListCard/functions/default.md index c81bd391c0..0ee88e4031 100644 --- a/docs/docs/auto-docs/components/EventListCard/EventListCard/functions/default.md +++ b/docs/docs/auto-docs/components/EventListCard/EventListCard/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/EventListCard/EventListCard.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L45) - Component that displays an event card with a modal for event details. ## Parameters -### props - -[`InterfaceEventListCardProps`](../interfaces/InterfaceEventListCardProps.md) +• **props**: [`InterfaceEventListCardProps`](../interfaces/InterfaceEventListCardProps.md) The props for the EventListCard component. @@ -23,3 +19,7 @@ The props for the EventListCard component. `JSX.Element` The rendered EventListCard component. + +## Defined in + +[src/components/EventListCard/EventListCard.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L45) diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCard/interfaces/InterfaceEventListCardProps.md b/docs/docs/auto-docs/components/EventListCard/EventListCard/interfaces/InterfaceEventListCardProps.md index 4db4fa46fd..cf8b3b6ae6 100644 --- a/docs/docs/auto-docs/components/EventListCard/EventListCard/interfaces/InterfaceEventListCardProps.md +++ b/docs/docs/auto-docs/components/EventListCard/EventListCard/interfaces/InterfaceEventListCardProps.md @@ -1,11 +1,9 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceEventListCardProps -Defined in: [src/components/EventListCard/EventListCard.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L11) - Props for the EventListCard component. ## Properties @@ -14,7 +12,9 @@ Props for the EventListCard component. > **allDay**: `boolean` -Defined in: [src/components/EventListCard/EventListCard.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L23) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L23) *** @@ -22,8 +22,6 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:23](https://github.c > `optional` **creator**: `object` -Defined in: [src/components/EventListCard/EventListCard.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L32) - #### \_id > **\_id**: `string` @@ -36,13 +34,19 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:32](https://github.c > **lastName**: `string` +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L32) + *** ### endDate > **endDate**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L20) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L20) *** @@ -50,7 +54,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:20](https://github.c > **endTime**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L22) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L22) *** @@ -58,7 +64,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:22](https://github.c > **eventDescription**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L18) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L18) *** @@ -66,7 +74,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:18](https://github.c > **eventLocation**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L16) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L16) *** @@ -74,7 +84,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:16](https://github.c > **eventName**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L17) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L17) *** @@ -82,7 +94,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:17](https://github.c > **id**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L15) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L15) *** @@ -90,7 +104,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:15](https://github.c > **isPublic**: `boolean` -Defined in: [src/components/EventListCard/EventListCard.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L27) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L27) *** @@ -98,7 +114,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:27](https://github.c > **isRecurringEventException**: `boolean` -Defined in: [src/components/EventListCard/EventListCard.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L26) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L26) *** @@ -106,7 +124,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:26](https://github.c > **isRegisterable**: `boolean` -Defined in: [src/components/EventListCard/EventListCard.tsx:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L28) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L28) *** @@ -114,7 +134,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:28](https://github.c > **key**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L14) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L14) *** @@ -122,7 +144,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:14](https://github.c > **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md) -Defined in: [src/components/EventListCard/EventListCard.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L25) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L25) *** @@ -130,7 +154,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:25](https://github.c > **recurring**: `boolean` -Defined in: [src/components/EventListCard/EventListCard.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L24) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L24) *** @@ -138,23 +164,23 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:24](https://github.c > `optional` **refetchEvents**: () => `void` -Defined in: [src/components/EventListCard/EventListCard.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L12) - #### Returns `void` +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L12) + *** ### registrants? > `optional` **registrants**: `object`[] -Defined in: [src/components/EventListCard/EventListCard.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L29) +#### Defined in -#### \_id - -> **\_id**: `string` +[src/components/EventListCard/EventListCard.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L29) *** @@ -162,7 +188,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:29](https://github.c > **startDate**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L19) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L19) *** @@ -170,7 +198,9 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:19](https://github.c > **startTime**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L21) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L21) *** @@ -178,4 +208,6 @@ Defined in: [src/components/EventListCard/EventListCard.tsx:21](https://github.c > `optional` **userRole**: `string` -Defined in: [src/components/EventListCard/EventListCard.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCard.tsx#L13) +#### Defined in + +[src/components/EventListCard/EventListCard.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index dac303dad1..640ec19d98 100644 --- a/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/ERROR_MOCKS.md +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/ERROR_MOCKS.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,26 +6,6 @@ > `const` **ERROR\_MOCKS**: `object`[] -Defined in: [src/components/EventListCard/EventListCardMocks.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCardMocks.ts#L191) +## Defined in -## 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'` +[src/components/EventListCard/EventListCardMocks.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCardMocks.ts#L191) diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/MOCKS.md b/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/MOCKS.md index 33074373a9..7c563098e8 100644 --- a/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/MOCKS.md +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardMocks/variables/MOCKS.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **MOCKS**: (`object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object` \| `object`)[] -Defined in: [src/components/EventListCard/EventListCardMocks.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCardMocks.ts#L7) +## Defined in + +[src/components/EventListCard/EventListCardMocks.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 60f0890294..77585511c9 100644 --- a/docs/docs/auto-docs/components/EventListCard/EventListCardModals/functions/default.md +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardModals/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,16 +6,12 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/EventListCard/EventListCardModals.tsx:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCardModals.tsx#L93) - The `EventListCardModals` component displays the modals related to events, such as viewing, updating, and deleting events. ## Parameters -### props - -`InterfaceEventListCardModalProps` +• **props**: `InterfaceEventListCardModalProps` The properties for the component. @@ -24,3 +20,7 @@ The properties for the component. `JSX.Element` A JSX element containing the event modals. + +## Defined in + +[src/components/EventListCard/EventListCardModals.tsx:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCardModals.tsx#L93) diff --git a/docs/docs/auto-docs/components/EventListCard/EventListCardProps/variables/props.md b/docs/docs/auto-docs/components/EventListCard/EventListCardProps/variables/props.md index 4b2fff081d..55c6ae6698 100644 --- a/docs/docs/auto-docs/components/EventListCard/EventListCardProps/variables/props.md +++ b/docs/docs/auto-docs/components/EventListCard/EventListCardProps/variables/props.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,4 +6,6 @@ > `const` **props**: [`InterfaceEventListCardProps`](../../EventListCard/interfaces/InterfaceEventListCardProps.md)[] -Defined in: [src/components/EventListCard/EventListCardProps.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventListCard/EventListCardProps.ts#L4) +## Defined in + +[src/components/EventListCard/EventListCardProps.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 5c09916288..03118410df 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,94 +6,6 @@ > `const` **MOCKS\_WITHOUT\_TIME**: `object`[] -Defined in: [src/components/EventManagement/Dashboard/EventDashboard.mocks.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/Dashboard/EventDashboard.mocks.ts#L34) +## Defined in -## 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'` +[src/components/EventManagement/Dashboard/EventDashboard.mocks.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/Dashboard/EventDashboard.mocks.ts#L34) 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 index 9ec1c831e4..0a3bb571cf 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,94 +6,6 @@ > `const` **MOCKS\_WITH\_TIME**: `object`[] -Defined in: [src/components/EventManagement/Dashboard/EventDashboard.mocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/Dashboard/EventDashboard.mocks.ts#L3) +## Defined in -## 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'` +[src/components/EventManagement/Dashboard/EventDashboard.mocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/Dashboard/EventDashboard.mocks.ts#L3) 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 index 207c0f114c..81475312df 100644 --- a/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard/functions/default.md +++ b/docs/docs/auto-docs/components/EventManagement/Dashboard/EventDashboard/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,22 +6,22 @@ > **default**(`props`): `Element` -Defined in: [src/components/EventManagement/Dashboard/EventDashboard.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/Dashboard/EventDashboard.tsx#L20) - Component that displays event details. ## Parameters -### props +• **props** The props for the EventDashboard component. -#### eventId - -`string` +• **props.eventId**: `string` ## Returns `Element` The rendered EventDashboard component. + +## Defined in + +[src/components/EventManagement/Dashboard/EventDashboard.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/Dashboard/EventDashboard.tsx#L20) 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 index 378e5642d1..31f68eb088 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItems/functions/default.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItems/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,22 +6,22 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItems.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAgendaItems/EventAgendaItems.tsx#L33) - Component to manage and display agenda items for a specific event. ## Parameters -### props +• **props** The component props. -#### eventId - -`string` +• **props.eventId**: `string` ## Returns `JSX.Element` The rendered component. + +## Defined in + +[src/components/EventManagement/EventAgendaItems/EventAgendaItems.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAgendaItems/EventAgendaItems.tsx#L33) 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 index 5f20cbdc54..f06d414ffd 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks/variables/MOCKS.md @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \}; \})[] +> `const` **MOCKS**: (`object` \| `object` \| `object`)[] -Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts#L6) +## Defined in + +[src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 9882b70565..11ae493002 100644 --- 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 @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **MOCKS\_ERROR\_MUTATION**: (`object` \| `object` \| `object`)[] -Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts#L97) +## Defined in + +[src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 12272b7823..635fb7fa41 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,4 +6,6 @@ > `const` **MOCKS\_ERROR\_QUERY**: `any`[] = `[]` -Defined in: [src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts#L133) +## Defined in + +[src/components/EventManagement/EventAgendaItems/EventAgendaItemsMocks.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 894a6ef91e..25842de92b 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,34 +6,6 @@ > `const` **MOCKS**: `object`[] -Defined in: [src/components/EventManagement/EventAttendance/Attendance.mocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/Attendance.mocks.ts#L3) +## Defined in -## 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`[] +[src/components/EventManagement/EventAttendance/Attendance.mocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/Attendance.mocks.ts#L3) 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 index 919ba88bd8..c91454dc16 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,22 +6,6 @@ > `const` **MOCKS\_ERROR**: `object`[] -Defined in: [src/components/EventManagement/EventAttendance/Attendance.mocks.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/Attendance.mocks.ts#L54) +## Defined in -## Type declaration - -### error - -> **error**: `Error` - -### request - -> **request**: `object` - -#### request.query - -> **query**: `DocumentNode` = `EVENT_ATTENDEES` - -#### request.variables - -> **variables**: `object` = `{}` +[src/components/EventManagement/EventAttendance/Attendance.mocks.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/Attendance.mocks.ts#L54) 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 index 77edc420dd..3f046f7121 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAttendance/AttendedEventList/functions/default.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/AttendedEventList/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,19 +6,13 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/EventManagement/EventAttendance/AttendedEventList.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/AttendedEventList.tsx#L16) - Component to display a list of events attended by a member ## Parameters -### props - -`InterfaceEventsAttended` - -### deprecatedLegacyContext? +• **props**: `InterfaceEventsAttended` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -31,3 +25,7 @@ Component to display a list of events attended by a member `ReactNode` A table row containing event details with a link to the event + +## Defined in + +[src/components/EventManagement/EventAttendance/AttendedEventList.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/AttendedEventList.tsx#L16) 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 index da5a44d71f..20f7ace04c 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventAttendance/functions/default.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventAttendance/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(): `JSX.Element` -Defined in: [src/components/EventManagement/EventAttendance/EventAttendance.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/EventAttendance.tsx#L34) - Component to manage and display event attendance information Includes filtering and sorting functionality for attendees @@ -16,3 +14,7 @@ Includes filtering and sorting functionality for attendees `JSX.Element` JSX element containing the event attendance interface + +## Defined in + +[src/components/EventManagement/EventAttendance/EventAttendance.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/EventAttendance.tsx#L34) 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 index 9bb688a1bd..0747b53f0d 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventStatistics/functions/AttendanceStatisticsModal.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/EventStatistics/functions/AttendanceStatisticsModal.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,20 +6,14 @@ > **AttendanceStatisticsModal**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/EventManagement/EventAttendance/EventStatistics.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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? +• **props**: [`InterfaceAttendanceStatisticsModalProps`](../../InterfaceEvents/interfaces/InterfaceAttendanceStatisticsModalProps.md) -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -32,3 +26,7 @@ Shows metrics like total attendees, filtering options, and attendance trends `ReactNode` JSX element with event statistics dashboard + +## Defined in + +[src/components/EventManagement/EventAttendance/EventStatistics.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/EventStatistics.tsx#L50) 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 index 6d5d0b3c25..fd411195f2 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceAttendanceStatisticsModalProps.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceAttendanceStatisticsModalProps.md @@ -1,30 +1,32 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceAttendanceStatisticsModalProps -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L1) - ## Properties ### handleClose() > **handleClose**: () => `void` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L3) - #### Returns `void` +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L3) + *** ### memberData > **memberData**: [`InterfaceMember`](InterfaceMember.md)[] -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L9) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L9) *** @@ -32,7 +34,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:9 > **show**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L2) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L2) *** @@ -40,8 +44,6 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:2 > **statistics**: `object` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L4) - #### attendanceRate > **attendanceRate**: `number` @@ -54,20 +56,24 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **totalMembers**: `number` +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L4) + *** ### t() > **t**: (`key`) => `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L10) - #### Parameters -##### key - -`string` +• **key**: `string` #### Returns `string` + +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L10) 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 index 3f11aa691c..08f9a6b8b8 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceEvent.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceEvent.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceEvent -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L35) - ## Properties ### \_\_typename > **\_\_typename**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L66) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L66) *** @@ -20,7 +20,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:6 > **\_id**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L36) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L36) *** @@ -28,7 +30,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:3 > **allDay**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L44) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L44) *** @@ -36,31 +40,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **attendees**: `object`[] -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L58) - -#### \_id - -> **\_id**: `string` - -#### birthDate - -> **birthDate**: `string` - -#### email - -> **email**: `string` - -#### firstName - -> **firstName**: `string` - -#### gender - -> **gender**: `string` +#### Defined in -#### lastName - -> **lastName**: `string` +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L58) *** @@ -68,7 +50,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:5 > **description**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L38) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L38) *** @@ -76,7 +60,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:3 > **endDate**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L40) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L40) *** @@ -84,7 +70,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **endTime**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L43) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L43) *** @@ -92,7 +80,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **isPublic**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L56) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L56) *** @@ -100,7 +90,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:5 > **isRecurringEventException**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L55) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L55) *** @@ -108,7 +100,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:5 > **isRegisterable**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L57) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L57) *** @@ -116,7 +110,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:5 > **location**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L41) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L41) *** @@ -124,8 +120,6 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **recurrenceRule**: `object` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L46) - #### count? > `optional` **count**: `number` @@ -154,13 +148,19 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **weekDays**: `string`[] +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L46) + *** ### recurring > **recurring**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L45) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L45) *** @@ -168,7 +168,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **startDate**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L39) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L39) *** @@ -176,7 +178,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:3 > **startTime**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L42) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L42) *** @@ -184,4 +188,6 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:4 > **title**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L37) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 942b4cfb70..65982f5656 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceMember.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceMember.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceMember -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L13) - ## Properties ### \_\_typename > **\_\_typename**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L23) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L23) *** @@ -20,7 +20,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:2 > **\_id**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L24) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L24) *** @@ -28,7 +30,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:2 > **birthDate**: `Date` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L22) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L22) *** @@ -36,15 +40,19 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:2 > **createdAt**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L14) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L14) *** ### email -> **email**: `` `${string}@${string}.${string}` `` +> **email**: \`$\{string\}@$\{string\}.$\{string\}\` + +#### Defined in -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L17) +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L17) *** @@ -52,11 +60,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:1 > `optional` **eventsAttended**: `object`[] -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L19) - -#### \_id +#### Defined in -> **\_id**: `string` +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L19) *** @@ -64,7 +70,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:1 > **firstName**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L15) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L15) *** @@ -72,7 +80,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:1 > **gender**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L18) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L18) *** @@ -80,7 +90,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:1 > **lastName**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L16) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L16) *** @@ -88,8 +100,10 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:1 > **tagsAssignedWith**: `object` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L25) - #### edges > **edges**: `object`[] + +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L25) 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 index 4eb1836556..71db8b8a28 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceRecurringEvent.md +++ b/docs/docs/auto-docs/components/EventManagement/EventAttendance/InterfaceEvents/interfaces/InterfaceRecurringEvent.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceRecurringEvent -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L69) - ## Properties ### \_id > **\_id**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L70) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L70) *** @@ -20,15 +20,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:7 > **attendees**: `object`[] -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L76) +#### Defined in -#### \_id - -> **\_id**: `string` - -#### gender - -> **gender**: `"MALE"` \| `"FEMALE"` \| `"OTHER"` \| `"PREFER_NOT_TO_SAY"` +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L76) *** @@ -36,7 +30,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:7 > **endDate**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L73) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L73) *** @@ -44,7 +40,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:7 > **frequency**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L74) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L74) *** @@ -52,7 +50,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:7 > **interval**: `number` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L75) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L75) *** @@ -60,7 +60,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:7 > **isPublic**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L80) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L80) *** @@ -68,7 +70,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:8 > **isRegisterable**: `boolean` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L81) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L81) *** @@ -76,7 +80,9 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:8 > **startDate**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L72) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L72) *** @@ -84,4 +90,6 @@ Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:7 > **title**: `string` -Defined in: [src/components/EventManagement/EventAttendance/InterfaceEvents.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventAttendance/InterfaceEvents.ts#L71) +#### Defined in + +[src/components/EventManagement/EventAttendance/InterfaceEvents.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 0f46085dd9..3ca03357e8 100644 --- a/docs/docs/auto-docs/components/EventManagement/EventRegistrant/EventRegistrants/functions/default.md +++ b/docs/docs/auto-docs/components/EventManagement/EventRegistrant/EventRegistrants/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(): `JSX.Element` -Defined in: [src/components/EventManagement/EventRegistrant/EventRegistrants.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 @@ -16,3 +14,7 @@ Includes adding new registrants and check-in functionality for registrants `JSX.Element` JSX element containing the event attendance interface + +## Defined in + +[src/components/EventManagement/EventRegistrant/EventRegistrants.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventRegistrant/EventRegistrants.tsx#L34) 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 index c10d67ee4c..c824e3b273 100644 --- 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 @@ -1,9 +1,11 @@ -[Admin Docs](/) +[Admin Docs](/) • **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`; \}; \}; \})[] +> `const` **REGISTRANTS\_MOCKS**: (`object` \| `object`)[] -Defined in: [src/components/EventManagement/EventRegistrant/Registrations.mocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventRegistrant/Registrations.mocks.ts#L3) +## Defined in + +[src/components/EventManagement/EventRegistrant/Registrations.mocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 8c5acd3148..3ecd116eca 100644 --- 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 @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,26 +6,6 @@ > `const` **REGISTRANTS\_MOCKS\_ERROR**: `object`[] -Defined in: [src/components/EventManagement/EventRegistrant/Registrations.mocks.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventRegistrant/Registrations.mocks.ts#L58) +## Defined in -## Type declaration - -### error - -> **error**: `Error` - -### request - -> **request**: `object` - -#### request.query - -> **query**: `DocumentNode` = `EVENT_REGISTRANTS` - -#### request.variables - -> **variables**: `object` - -#### request.variables.eventId - -> **eventId**: `string` = `'event123'` +[src/components/EventManagement/EventRegistrant/Registrations.mocks.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventManagement/EventRegistrant/Registrations.mocks.ts#L58) diff --git a/docs/docs/auto-docs/components/EventRegistrantsModal/AddOnSpotAttendee/functions/default.md b/docs/docs/auto-docs/components/EventRegistrantsModal/AddOnSpotAttendee/functions/default.md index 4e9ddf3e00..1b380c7cef 100644 --- a/docs/docs/auto-docs/components/EventRegistrantsModal/AddOnSpotAttendee/functions/default.md +++ b/docs/docs/auto-docs/components/EventRegistrantsModal/AddOnSpotAttendee/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,19 +6,13 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/EventRegistrantsModal/AddOnSpotAttendee.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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? +• **props**: [`InterfaceAddOnSpotAttendeeProps`](../../../../utils/interfaces/interfaces/InterfaceAddOnSpotAttendeeProps.md) -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -31,3 +25,7 @@ Modal component for adding on-spot attendees to an event `ReactNode` Modal component with form for adding new attendee + +## Defined in + +[src/components/EventRegistrantsModal/AddOnSpotAttendee.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventRegistrantsModal/AddOnSpotAttendee.tsx#L21) diff --git a/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsModal/functions/EventRegistrantsModal.md b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsModal/functions/EventRegistrantsModal.md index 8644dcecc7..1b90a961c9 100644 --- a/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsModal/functions/EventRegistrantsModal.md +++ b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsModal/functions/EventRegistrantsModal.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,19 +6,19 @@ > **EventRegistrantsModal**(`props`): `Element` -Defined in: [src/components/EventRegistrantsModal/EventRegistrantsModal.tsx:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventRegistrantsModal/EventRegistrantsModal.tsx#L44) - Modal component for managing event registrants. Allows adding and removing attendees from an event. ## Parameters -### props - -`ModalPropType` +• **props**: `ModalPropType` ## Returns `Element` JSX element representing the modal. + +## Defined in + +[src/components/EventRegistrantsModal/EventRegistrantsModal.tsx:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventRegistrantsModal/EventRegistrantsModal.tsx#L44) diff --git a/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md index 73b0b42b73..3e7aa79e48 100644 --- a/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md +++ b/docs/docs/auto-docs/components/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **EventRegistrantsWrapper**(`__namedParameters`): `Element` -Defined in: [src/components/EventRegistrantsModal/EventRegistrantsWrapper.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventRegistrantsModal/EventRegistrantsWrapper.tsx#L20) - Wrapper component that displays a button to show the event registrants modal. ## Parameters -### \_\_namedParameters - -`PropType` +• **\_\_namedParameters**: `PropType` ## Returns `Element` JSX element representing the wrapper with a button to show the modal. + +## Defined in + +[src/components/EventRegistrantsModal/EventRegistrantsWrapper.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventRegistrantsModal/EventRegistrantsWrapper.tsx#L20) diff --git a/docs/docs/auto-docs/components/EventStats/EventStats/functions/EventStats.md b/docs/docs/auto-docs/components/EventStats/EventStats/functions/EventStats.md index 010833eb8f..07fef8fa07 100644 --- a/docs/docs/auto-docs/components/EventStats/EventStats/functions/EventStats.md +++ b/docs/docs/auto-docs/components/EventStats/EventStats/functions/EventStats.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,19 +6,19 @@ > **EventStats**(`__namedParameters`): `Element` -Defined in: [src/components/EventStats/EventStats.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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` +• **\_\_namedParameters**: `ModalPropType` ## Returns `Element` JSX element representing the event statistics modal. + +## Defined in + +[src/components/EventStats/EventStats.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStats.tsx#L27) diff --git a/docs/docs/auto-docs/components/EventStats/EventStatsWrapper/functions/EventStatsWrapper.md b/docs/docs/auto-docs/components/EventStats/EventStatsWrapper/functions/EventStatsWrapper.md index 5c30504e34..9abce17ba9 100644 --- a/docs/docs/auto-docs/components/EventStats/EventStatsWrapper/functions/EventStatsWrapper.md +++ b/docs/docs/auto-docs/components/EventStats/EventStatsWrapper/functions/EventStatsWrapper.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **EventStatsWrapper**(`eventId`): `Element` -Defined in: [src/components/EventStats/EventStatsWrapper.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsWrapper.tsx#L18) - Wrapper component that displays a button to show event statistics. ## Parameters -### eventId - -`PropType` +• **eventId**: `PropType` The ID of the event. @@ -23,3 +19,7 @@ The ID of the event. `Element` JSX element representing the wrapper with a button to view event statistics. + +## Defined in + +[src/components/EventStats/EventStatsWrapper.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsWrapper.tsx#L18) 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 index 3e0261cd1a..2942980d66 100644 --- a/docs/docs/auto-docs/components/EventStats/Statistics/AverageRating/functions/AverageRating.md +++ b/docs/docs/auto-docs/components/EventStats/Statistics/AverageRating/functions/AverageRating.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,16 +6,12 @@ > **AverageRating**(`data`): `Element` -Defined in: [src/components/EventStats/Statistics/AverageRating.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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**: `ModalPropType` Data containing the average feedback score to be displayed. @@ -24,3 +20,7 @@ Data containing the average feedback score to be displayed. `Element` JSX element representing the average rating card with a star rating. + +## Defined in + +[src/components/EventStats/Statistics/AverageRating.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/AverageRating.tsx#L33) 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 index 7cd8e8c07c..0e24c25450 100644 --- a/docs/docs/auto-docs/components/EventStats/Statistics/Feedback/functions/FeedbackStats.md +++ b/docs/docs/auto-docs/components/EventStats/Statistics/Feedback/functions/FeedbackStats.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,16 +6,12 @@ > **FeedbackStats**(`data`): `Element` -Defined in: [src/components/EventStats/Statistics/Feedback.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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**: `ModalPropType` Data containing event feedback to be displayed in the chart. @@ -24,3 +20,7 @@ Data containing event feedback to be displayed in the chart. `Element` JSX element representing the feedback analysis card with a pie chart. + +## Defined in + +[src/components/EventStats/Statistics/Feedback.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/Feedback.tsx#L34) 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 index 8f249a6a01..c65e98c1be 100644 --- a/docs/docs/auto-docs/components/EventStats/Statistics/Review/functions/ReviewStats.md +++ b/docs/docs/auto-docs/components/EventStats/Statistics/Review/functions/ReviewStats.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,16 +6,12 @@ > **ReviewStats**(`data`): `Element` -Defined in: [src/components/EventStats/Statistics/Review.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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**: `ModalPropType` Data containing event feedback to be displayed. @@ -24,3 +20,7 @@ Data containing event feedback to be displayed. `Element` JSX element representing the reviews card. + +## Defined in + +[src/components/EventStats/Statistics/Review.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/Review.tsx#L30) diff --git a/docs/docs/auto-docs/components/GroupChatDetails/GroupChatDetails/functions/default.md b/docs/docs/auto-docs/components/GroupChatDetails/GroupChatDetails/functions/default.md index 6d760d0921..728303c0f2 100644 --- a/docs/docs/auto-docs/components/GroupChatDetails/GroupChatDetails/functions/default.md +++ b/docs/docs/auto-docs/components/GroupChatDetails/GroupChatDetails/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`__namedParameters`): `JSX.Element` -Defined in: [src/components/GroupChatDetails/GroupChatDetails.tsx:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/GroupChatDetails/GroupChatDetails.tsx#L120) - Component for displaying and managing group chat details. ## Parameters -### \_\_namedParameters - -`InterfaceGoroupChatDetailsProps` +• **\_\_namedParameters**: `InterfaceGoroupChatDetailsProps` ## Returns `JSX.Element` The rendered component. + +## Defined in + +[src/components/GroupChatDetails/GroupChatDetails.tsx:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/GroupChatDetails/GroupChatDetails.tsx#L120) diff --git a/docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md b/docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md index e28ab34632..43fba686e1 100644 --- a/docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md +++ b/docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **default**(`props`): `Element` -Defined in: [src/components/HolidayCards/HolidayCard.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/HolidayCards/HolidayCard.tsx#L15) - Component that displays a card with the name of a holiday. ## Parameters -### props - -`InterfaceHolidayList` +• **props**: `InterfaceHolidayList` Contains the holidayName to be displayed on the card. @@ -23,3 +19,7 @@ Contains the holidayName to be displayed on the card. `Element` JSX element representing a card with the holiday name. + +## Defined in + +[src/components/HolidayCards/HolidayCard.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/HolidayCards/HolidayCard.tsx#L15) diff --git a/docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md b/docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md index 48d3187173..7f73d3e411 100644 --- a/docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md +++ b/docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **default**(`props`): `Element` -Defined in: [src/components/IconComponent/IconComponent.tsx:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L39) - Renders an icon based on the provided name. ## Parameters -### props - -[`InterfaceIconComponent`](../interfaces/InterfaceIconComponent.md) +• **props**: [`InterfaceIconComponent`](../interfaces/InterfaceIconComponent.md) Contains the name of the icon and optional styles (fill, height, width). @@ -23,3 +19,7 @@ Contains the name of the icon and optional styles (fill, height, width). `Element` JSX element representing the icon. + +## Defined in + +[src/components/IconComponent/IconComponent.tsx:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L39) diff --git a/docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md b/docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md index 16c5f8f615..befc4f8b06 100644 --- a/docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md +++ b/docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/InterfaceIconComponent.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceIconComponent -Defined in: [src/components/IconComponent/IconComponent.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L27) - ## Properties ### fill? > `optional` **fill**: `string` -Defined in: [src/components/IconComponent/IconComponent.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L29) +#### Defined in + +[src/components/IconComponent/IconComponent.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L29) *** @@ -20,7 +20,9 @@ Defined in: [src/components/IconComponent/IconComponent.tsx:29](https://github.c > `optional` **height**: `string` -Defined in: [src/components/IconComponent/IconComponent.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L30) +#### Defined in + +[src/components/IconComponent/IconComponent.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L30) *** @@ -28,7 +30,9 @@ Defined in: [src/components/IconComponent/IconComponent.tsx:30](https://github.c > **name**: `string` -Defined in: [src/components/IconComponent/IconComponent.tsx:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L28) +#### Defined in + +[src/components/IconComponent/IconComponent.tsx:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L28) *** @@ -36,4 +40,6 @@ Defined in: [src/components/IconComponent/IconComponent.tsx:28](https://github.c > `optional` **width**: `string` -Defined in: [src/components/IconComponent/IconComponent.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L31) +#### Defined in + +[src/components/IconComponent/IconComponent.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 119193e89c..8d4a9488d1 100644 --- a/docs/docs/auto-docs/components/InfiniteScrollLoader/InfiniteScrollLoader/functions/default.md +++ b/docs/docs/auto-docs/components/InfiniteScrollLoader/InfiniteScrollLoader/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,10 +6,12 @@ > **default**(): `Element` -Defined in: [src/components/InfiniteScrollLoader/InfiniteScrollLoader.tsx:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/InfiniteScrollLoader/InfiniteScrollLoader.tsx#L8) - A Loader for infinite scroll. ## Returns `Element` + +## Defined in + +[src/components/InfiniteScrollLoader/InfiniteScrollLoader.tsx:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/InfiniteScrollLoader/InfiniteScrollLoader.tsx#L8) diff --git a/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/functions/default.md b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/functions/default.md index b6052d20d0..6a8faded30 100644 --- a/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/functions/default.md +++ b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`__namedParameters`): `Element` -Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawer/LeftDrawer.tsx#L25) - LeftDrawer component for displaying navigation options. ## Parameters -### \_\_namedParameters - -[`InterfaceLeftDrawerProps`](../interfaces/InterfaceLeftDrawerProps.md) +• **\_\_namedParameters**: [`InterfaceLeftDrawerProps`](../interfaces/InterfaceLeftDrawerProps.md) ## Returns `Element` JSX element for the left navigation drawer. + +## Defined in + +[src/components/LeftDrawer/LeftDrawer.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawer/LeftDrawer.tsx#L25) diff --git a/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/interfaces/InterfaceLeftDrawerProps.md b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/interfaces/InterfaceLeftDrawerProps.md index 270d7a5c1c..32a4f1760f 100644 --- a/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/interfaces/InterfaceLeftDrawerProps.md +++ b/docs/docs/auto-docs/components/LeftDrawer/LeftDrawer/interfaces/InterfaceLeftDrawerProps.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceLeftDrawerProps -Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawer/LeftDrawer.tsx#L13) - ## Properties ### hideDrawer > **hideDrawer**: `boolean` -Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawer/LeftDrawer.tsx#L14) +#### Defined in + +[src/components/LeftDrawer/LeftDrawer.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawer/LeftDrawer.tsx#L14) *** @@ -20,4 +20,6 @@ Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:14](https://github.com/Pal > **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> -Defined in: [src/components/LeftDrawer/LeftDrawer.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawer/LeftDrawer.tsx#L15) +#### Defined in + +[src/components/LeftDrawer/LeftDrawer.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawer/LeftDrawer.tsx#L15) diff --git a/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md index 34a21e1837..c680a3e80d 100644 --- a/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md +++ b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`__namedParameters`): `Element` -Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L35) - LeftDrawerOrg component for displaying organization details and navigation options. ## Parameters -### \_\_namedParameters - -[`InterfaceLeftDrawerProps`](../interfaces/InterfaceLeftDrawerProps.md) +• **\_\_namedParameters**: [`InterfaceLeftDrawerProps`](../interfaces/InterfaceLeftDrawerProps.md) ## Returns `Element` JSX element for the left navigation drawer with organization details. + +## Defined in + +[src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L35) diff --git a/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md index ce801156d0..59cb8c6817 100644 --- a/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md +++ b/docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/InterfaceLeftDrawerProps.md @@ -1,18 +1,18 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceLeftDrawerProps -Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L18) - ## Properties ### hideDrawer > **hideDrawer**: `boolean` -Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L21) +#### Defined in + +[src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L21) *** @@ -20,7 +20,9 @@ Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:21](https://github.c > **orgId**: `string` -Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L19) +#### Defined in + +[src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L19) *** @@ -28,7 +30,9 @@ Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:19](https://github.c > **setHideDrawer**: `Dispatch`\<`SetStateAction`\<`boolean`\>\> -Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L22) +#### Defined in + +[src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L22) *** @@ -36,4 +40,6 @@ Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:22](https://github.c > **targets**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md)[] -Defined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L20) +#### Defined in + +[src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 5db0ccc088..ad296df281 100644 --- a/docs/docs/auto-docs/components/Loader/Loader/functions/default.md +++ b/docs/docs/auto-docs/components/Loader/Loader/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`props`): `Element` -Defined in: [src/components/Loader/Loader.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Loader/Loader.tsx#L17) - Loader component for displaying a loading spinner. ## Parameters -### props - -`InterfaceLoaderProps` +• **props**: `InterfaceLoaderProps` ## Returns `Element` JSX element for a loading spinner. + +## Defined in + +[src/components/Loader/Loader.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Loader/Loader.tsx#L17) diff --git a/docs/docs/auto-docs/components/LoginPortalToggle/LoginPortalToggle/functions/default.md b/docs/docs/auto-docs/components/LoginPortalToggle/LoginPortalToggle/functions/default.md index 78abe51e19..e1a01f3be1 100644 --- a/docs/docs/auto-docs/components/LoginPortalToggle/LoginPortalToggle/functions/default.md +++ b/docs/docs/auto-docs/components/LoginPortalToggle/LoginPortalToggle/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **default**(`onToggle`): `JSX.Element` -Defined in: [src/components/LoginPortalToggle/LoginPortalToggle.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LoginPortalToggle/LoginPortalToggle.tsx#L18) - Component for toggling between admin and user login portals. ## Parameters -### onToggle - -`InterfaceLoginPortalToggleProps` +• **onToggle**: `InterfaceLoginPortalToggleProps` Callback function to handle role changes ('admin' or 'user'). @@ -23,3 +19,7 @@ Callback function to handle role changes ('admin' or 'user'). `JSX.Element` JSX element for login portal toggle. + +## Defined in + +[src/components/LoginPortalToggle/LoginPortalToggle.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LoginPortalToggle/LoginPortalToggle.tsx#L18) diff --git a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedByMember/functions/default.md b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedByMember/functions/default.md index 44479bae34..430f3b9262 100644 --- a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedByMember/functions/default.md +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedByMember/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,14 +6,14 @@ > **default**(`__namedParameters`): `JSX.Element` -Defined in: [src/components/MemberDetail/EventsAttendedByMember.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedByMember.tsx#L15) - ## Parameters -### \_\_namedParameters - -`InterfaceEventsAttendedByMember` +• **\_\_namedParameters**: `InterfaceEventsAttendedByMember` ## Returns `JSX.Element` + +## Defined in + +[src/components/MemberDetail/EventsAttendedByMember.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedByMember.tsx#L15) diff --git a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/functions/default.md b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/functions/default.md index 2b37c74a77..85ae2a5614 100644 --- a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/functions/default.md +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,14 +6,14 @@ > **default**(`props`): `Element` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L26) - ## Parameters -### props - -[`InterfaceCardItem`](../interfaces/InterfaceCardItem.md) +• **props**: [`InterfaceCardItem`](../interfaces/InterfaceCardItem.md) ## Returns `Element` + +## Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L26) diff --git a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/interfaces/InterfaceCardItem.md b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/interfaces/InterfaceCardItem.md index dd6aced8f7..a6e090da4f 100644 --- a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/interfaces/InterfaceCardItem.md +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedCardItem/interfaces/InterfaceCardItem.md @@ -1,11 +1,9 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceCardItem -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L16) - Card component to display individual event attendance information Shows event details including title, date, location and organization @@ -35,7 +33,9 @@ Event location > `optional` **creator**: `string` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L20) +#### Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L20) *** @@ -43,7 +43,9 @@ Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:20](https:// > `optional` **eventId**: `string` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L22) +#### Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L22) *** @@ -51,7 +53,9 @@ Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:22](https:// > `optional` **location**: `string` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L21) +#### Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L21) *** @@ -59,7 +63,9 @@ Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:21](https:// > `optional` **orgId**: `string` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L23) +#### Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L23) *** @@ -67,7 +73,9 @@ Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:23](https:// > `optional` **startdate**: `string` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L19) +#### Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L19) *** @@ -75,7 +83,9 @@ Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:19](https:// > `optional` **time**: `string` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L18) +#### Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L18) *** @@ -83,4 +93,6 @@ Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:18](https:// > **title**: `string` -Defined in: [src/components/MemberDetail/EventsAttendedCardItem.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedCardItem.tsx#L17) +#### Defined in + +[src/components/MemberDetail/EventsAttendedCardItem.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index f5f5aed6ef..5e69e8aa96 100644 --- a/docs/docs/auto-docs/components/MemberDetail/EventsAttendedMemberModal/functions/default.md +++ b/docs/docs/auto-docs/components/MemberDetail/EventsAttendedMemberModal/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,17 +6,11 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/MemberDetail/EventsAttendedMemberModal.tsx:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedMemberModal.tsx#L39) - ## Parameters -### props - -`InterfaceEventsAttendedMemberModalProps` - -### deprecatedLegacyContext? +• **props**: `InterfaceEventsAttendedMemberModalProps` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -27,3 +21,7 @@ Defined in: [src/components/MemberDetail/EventsAttendedMemberModal.tsx:39](https ## Returns `ReactNode` + +## Defined in + +[src/components/MemberDetail/EventsAttendedMemberModal.tsx:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/EventsAttendedMemberModal.tsx#L39) diff --git a/docs/docs/auto-docs/components/MemberDetail/customTableCell/functions/CustomTableCell.md b/docs/docs/auto-docs/components/MemberDetail/customTableCell/functions/CustomTableCell.md index 5864ffde36..8531077936 100644 --- a/docs/docs/auto-docs/components/MemberDetail/customTableCell/functions/CustomTableCell.md +++ b/docs/docs/auto-docs/components/MemberDetail/customTableCell/functions/CustomTableCell.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,21 +6,15 @@ > **CustomTableCell**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/MemberDetail/customTableCell.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/customTableCell.tsx#L13) - Custom table cell component to display event details ## Parameters -### props - -#### eventId - -`string` +• **props** -### deprecatedLegacyContext? +• **props.eventId**: `string` -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -33,3 +27,7 @@ Custom table cell component to display event details `ReactNode` TableRow component with event information + +## Defined in + +[src/components/MemberDetail/customTableCell.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberDetail/customTableCell.tsx#L13) diff --git a/docs/docs/auto-docs/components/MemberRequestCard/MemberRequestCard/functions/default.md b/docs/docs/auto-docs/components/MemberRequestCard/MemberRequestCard/functions/default.md index e6705a54c6..235a5789a1 100644 --- a/docs/docs/auto-docs/components/MemberRequestCard/MemberRequestCard/functions/default.md +++ b/docs/docs/auto-docs/components/MemberRequestCard/MemberRequestCard/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,15 +6,11 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/MemberRequestCard/MemberRequestCard.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberRequestCard/MemberRequestCard.tsx#L31) - Component for displaying and managing member requests. ## Parameters -### props - -`InterfaceMemberRequestCardProps` +• **props**: `InterfaceMemberRequestCardProps` Properties for the member request card. @@ -23,3 +19,7 @@ Properties for the member request card. `JSX.Element` JSX element for member request card. + +## Defined in + +[src/components/MemberRequestCard/MemberRequestCard.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/MemberRequestCard/MemberRequestCard.tsx#L31) diff --git a/docs/docs/auto-docs/components/NotFound/NotFound/functions/default.md b/docs/docs/auto-docs/components/NotFound/NotFound/functions/default.md index d8d786dd48..a2b8cb8994 100644 --- a/docs/docs/auto-docs/components/NotFound/NotFound/functions/default.md +++ b/docs/docs/auto-docs/components/NotFound/NotFound/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/NotFound/NotFound.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/NotFound/NotFound.tsx#L18) - Component to display a "Not Found" message. ## Parameters -### props - -`InterfaceNotFoundProps` +• **props**: `InterfaceNotFoundProps` ## Returns `JSX.Element` JSX element for the "Not Found" page. + +## Defined in + +[src/components/NotFound/NotFound.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/NotFound/NotFound.tsx#L18) diff --git a/docs/docs/auto-docs/components/OrgAdminListCard/OrgAdminListCard/functions/default.md b/docs/docs/auto-docs/components/OrgAdminListCard/OrgAdminListCard/functions/default.md index 4d01581988..50fd85507f 100644 --- a/docs/docs/auto-docs/components/OrgAdminListCard/OrgAdminListCard/functions/default.md +++ b/docs/docs/auto-docs/components/OrgAdminListCard/OrgAdminListCard/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,18 +6,18 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/OrgAdminListCard/OrgAdminListCard.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgAdminListCard/OrgAdminListCard.tsx#L22) - Component to confirm and handle the removal of an admin. ## Parameters -### props - -`InterfaceOrgPeopleListCardProps` +• **props**: `InterfaceOrgPeopleListCardProps` ## Returns `JSX.Element` JSX element for the removal confirmation modal. + +## Defined in + +[src/components/OrgAdminListCard/OrgAdminListCard.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgAdminListCard/OrgAdminListCard.tsx#L22) diff --git a/docs/docs/auto-docs/components/OrgContriCards/OrgContriCards/functions/default.md b/docs/docs/auto-docs/components/OrgContriCards/OrgContriCards/functions/default.md index b890243d55..32e8f13585 100644 --- a/docs/docs/auto-docs/components/OrgContriCards/OrgContriCards/functions/default.md +++ b/docs/docs/auto-docs/components/OrgContriCards/OrgContriCards/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/OrgContriCards/OrgContriCards.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 @@ -15,9 +13,7 @@ the user's name, email, contribution date, transaction ID, and the contribution ## Parameters -### props - -`InterfaceOrgContriCardsProps` +• **props**: `InterfaceOrgContriCardsProps` The properties passed to the component @@ -26,3 +22,7 @@ The properties passed to the component `JSX.Element` JSX.Element representing a contribution card + +## Defined in + +[src/components/OrgContriCards/OrgContriCards.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgContriCards/OrgContriCards.tsx#L30) diff --git a/docs/docs/auto-docs/components/OrgDelete/OrgDelete/functions/default.md b/docs/docs/auto-docs/components/OrgDelete/OrgDelete/functions/default.md index 293b8ec3e9..7a535ab470 100644 --- a/docs/docs/auto-docs/components/OrgDelete/OrgDelete/functions/default.md +++ b/docs/docs/auto-docs/components/OrgDelete/OrgDelete/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(): `JSX.Element` -Defined in: [src/components/OrgDelete/OrgDelete.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgDelete/OrgDelete.tsx#L11) - Component for displaying organization deletion message This component renders a message related to deleting an organization. @@ -17,3 +15,7 @@ This component renders a message related to deleting an organization. `JSX.Element` JSX.Element representing the organization deletion message + +## Defined in + +[src/components/OrgDelete/OrgDelete.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgDelete/OrgDelete.tsx#L11) diff --git a/docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md index 1b38f4d6e7..d8c9614040 100644 --- a/docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md +++ b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(`props`): `JSX.Element` -Defined in: [src/components/OrgListCard/OrgListCard.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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, @@ -16,9 +14,7 @@ to manage the organization, navigating to the organization's dashboard. ## Parameters -### props - -[`InterfaceOrgListCardProps`](../interfaces/InterfaceOrgListCardProps.md) +• **props**: [`InterfaceOrgListCardProps`](../interfaces/InterfaceOrgListCardProps.md) The properties passed to the component @@ -27,3 +23,7 @@ The properties passed to the component `JSX.Element` JSX.Element representing an organization list card + +## Defined in + +[src/components/OrgListCard/OrgListCard.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgListCard/OrgListCard.tsx#L38) diff --git a/docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardProps.md b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardProps.md index 7713ac5664..8c855e1444 100644 --- a/docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardProps.md +++ b/docs/docs/auto-docs/components/OrgListCard/OrgListCard/interfaces/InterfaceOrgListCardProps.md @@ -1,11 +1,9 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** # Interface: InterfaceOrgListCardProps -Defined in: [src/components/OrgListCard/OrgListCard.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgListCard/OrgListCard.tsx#L24) - Props for the OrgListCard component ## Properties @@ -14,4 +12,6 @@ Props for the OrgListCard component > **data**: [`InterfaceOrgConnectionInfoType`](../../../../utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md) -Defined in: [src/components/OrgListCard/OrgListCard.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/OrgListCard/OrgListCard.tsx#L25) +#### Defined in + +[src/components/OrgListCard/OrgListCard.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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 index 0520106ebe..da0ce91a99 100644 --- a/docs/docs/auto-docs/components/OrgListCard/TruncatedText/functions/default.md +++ b/docs/docs/auto-docs/components/OrgListCard/TruncatedText/functions/default.md @@ -1,4 +1,4 @@ -[Admin Docs](/) +[Admin Docs](/) • **Docs** *** @@ -6,8 +6,6 @@ > **default**(`props`, `deprecatedLegacyContext`?): `ReactNode` -Defined in: [src/components/OrgListCard/TruncatedText.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/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. @@ -16,15 +14,11 @@ or the `maxWidthOverride` value. It also listens for window resize events to rea ## Parameters -### props - -`InterfaceTruncatedTextProps` +• **props**: `InterfaceTruncatedTextProps` The props for the component. -### deprecatedLegacyContext? - -`any` +• **deprecatedLegacyContext?**: `any` **Deprecated** @@ -43,3 +37,7 @@ A heading element (`