Skip to content

Commit

Permalink
Updated talawa admin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anwersayeed committed Oct 20, 2024
1 parent 8f99906 commit 07bffed
Show file tree
Hide file tree
Showing 325 changed files with 1,887 additions and 380 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsContainer.test

# components/ActionItems/ActionItemsContainer.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsContainer

# components/ActionItems/ActionItemsContainer

## Index

### Functions

- [default](functions/default.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsContainer](../README.md) / default

# Function: default()

\> **default**(`__namedParameters`): `JSX.Element`

ActionItemsContainer component is responsible for displaying, managing, and updating action items
related to either an organization or an event. It provides a UI for previewing, updating, and deleting
action items, as well as changing their status.

## Parameters

**\_\_namedParameters**

**\_\_namedParameters.actionItemsConnection**: `"Organization"` \| `"Event"`

**\_\_namedParameters.actionItemsData**: `undefined` \| `InterfaceActionItemInfo`[]

**\_\_namedParameters.actionItemsRefetch**

**\_\_namedParameters.membersData**: `undefined` \| `InterfaceMemberInfo`[]

## Returns

`JSX.Element`

## Example

```tsx
\<ActionItemsContainer
actionItemsConnection="Organization"
actionItemsData=\{actionItems\}
membersData=\{members\}
actionItemsRefetch=\{refetchActionItems\}
/\>
```
This example renders the `ActionItemsContainer` component with organization connection, providing the necessary action items and members data along with a refetch function.

## Defined in

[src/components/ActionItems/ActionItemsContainer.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsContainer.tsx#L54)
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsContainerMocks

# components/ActionItems/ActionItemsContainerMocks

## Index

### Variables

- [MOCKS](variables/MOCKS.md)
- [MOCKS\_ERROR\_MUTATIONS](variables/MOCKS_ERROR_MUTATIONS.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsContainerMocks](../README.md) / MOCKS

# Variable: MOCKS

\> `const` **MOCKS**: (`object` \| `object`)[]

## Defined in

[src/components/ActionItems/ActionItemsContainerMocks.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsContainerMocks.ts#L6)
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsContainerMocks](../README.md) / MOCKS\_ERROR\_MUTATIONS

# Variable: MOCKS\_ERROR\_MUTATIONS

\> `const` **MOCKS\_ERROR\_MUTATIONS**: (`object` \| `object`)[]

## Defined in

[src/components/ActionItems/ActionItemsContainerMocks.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsContainerMocks.ts#L87)
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsContainerProps

# components/ActionItems/ActionItemsContainerProps

## Index

### Variables

- [props](variables/props.md)
- [props2](variables/props2.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsContainerProps](../README.md) / props

# Variable: props

\> `const` **props**: `object`

## Type declaration

### actionItemsConnection

\> **actionItemsConnection**: `ActionItemsConnectionType`

### actionItemsData

\> **actionItemsData**: `object`[]

### actionItemsRefetch

\> **actionItemsRefetch**: `Mock`\<`any`, `any`\>

### membersData

\> **membersData**: `object`[]

## Defined in

[src/components/ActionItems/ActionItemsContainerProps.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsContainerProps.ts#L3)
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsContainerProps](../README.md) / props2

# Variable: props2

\> `const` **props2**: `object`

## Type declaration

### actionItemsConnection

\> **actionItemsConnection**: `ActionItemsConnectionType`

### actionItemsData

\> **actionItemsData**: `never`[] = `[]`

### actionItemsRefetch

\> **actionItemsRefetch**: `Mock`\<`any`, `any`\>

### membersData

\> **membersData**: `never`[] = `[]`

## Defined in

[src/components/ActionItems/ActionItemsContainerProps.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsContainerProps.ts#L126)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsModal.test

# components/ActionItems/ActionItemsModal.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsModal

# components/ActionItems/ActionItemsModal

## Index

### Interfaces

- [InterfaceModalProp](interfaces/InterfaceModalProp.md)

### Functions

- [ActionItemsModal](functions/ActionItemsModal.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsModal](../README.md) / ActionItemsModal

# Function: ActionItemsModal()

\> **ActionItemsModal**(`props`): `Element`

ActionItemsModal component displays a modal containing action items for a specific event within an organization.
It includes a header with a title and a body that renders the ActionItemsModalBody component.

## Parameters

**props**: [`InterfaceModalProp`](../interfaces/InterfaceModalProp.md)

The props for the ActionItemsModal component.

## Returns

`Element`

## Example

```tsx
\<ActionItemsModal
show=\{true\}
eventId="event123"
orgId="org456"
handleClose=\{() =\> setShowModal(false)\}
/\>
```
This example renders the `ActionItemsModal` component with the modal shown, using specific event and organization IDs, and a function to handle closing the modal.

## Defined in

[src/components/ActionItems/ActionItemsModal.tsx:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsModal.tsx#L39)
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsModal](../README.md) / InterfaceModalProp

# Interface: InterfaceModalProp

Interface defining the props for the ActionItemsModal component.

## Properties

### eventId

\> **eventId**: `string`

#### Defined in

[src/components/ActionItems/ActionItemsModal.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsModal.tsx#L12)

***

### handleClose()

\> **handleClose**: () =\> `void`

#### Returns

`void`

#### Defined in

[src/components/ActionItems/ActionItemsModal.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsModal.tsx#L14)

***

### orgId

\> **orgId**: `string`

#### Defined in

[src/components/ActionItems/ActionItemsModal.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsModal.tsx#L13)

***

### show

\> **show**: `boolean`

#### Defined in

[src/components/ActionItems/ActionItemsModal.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsModal.tsx#L11)
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsModalBody

# components/ActionItems/ActionItemsModalBody

## Index

### Functions

- [ActionItemsModalBody](functions/ActionItemsModalBody.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[**talawa-admin**](../../../../README.md)**Docs**

***

[talawa-admin](../../../../modules.md) / [components/ActionItems/ActionItemsModalBody](../README.md) / ActionItemsModalBody

# Function: ActionItemsModalBody()

\> **ActionItemsModalBody**(`__namedParameters`): `Element`

Component displaying the body of the Action Items modal.
Fetches and displays action items, members, and action item categories related to a specific event within an organization.

## Parameters

**\_\_namedParameters**

**\_\_namedParameters.eventId**: `string`

**\_\_namedParameters.organizationId**: `string`

## Returns

`Element`

## Example

```tsx
\<ActionItemsModalBody organizationId="org123" eventId="event456" /\>
```
This example renders the `ActionItemsModalBody` component with the provided organization and event IDs.

## Defined in

[src/components/ActionItems/ActionItemsModalBody.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/7496bb3a4c3730e7e3caee73f8bf91c3031e4ae6/src/components/ActionItems/ActionItemsModalBody.tsx#L40)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsWrapper.test

# components/ActionItems/ActionItemsWrapper.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[**talawa-admin**](../../../README.md)**Docs**

***

[talawa-admin](../../../modules.md) / components/ActionItems/ActionItemsWrapper

# components/ActionItems/ActionItemsWrapper

## Index

### Functions

- [ActionItemsWrapper](functions/ActionItemsWrapper.md)
Loading

0 comments on commit 07bffed

Please sign in to comment.