docs.json

{
  "src/components/Activity.tsx": {
    "description": "Activity is a component that lists the log of the task.",
    "displayName": "Activity",
    "methods": [],
    "props": {
      "task": {
        "required": true,
        "tsType": {
          "name": "Task"
        },
        "description": ""
      }
    }
  },
  "src/components/Board.tsx": {
    "description": "Board is the main feature of the app. \nIt includes all tasks categorized in columns by their statuses.",
    "displayName": "Board",
    "methods": []
  },
  "src/components/ContextProviders.tsx": {
    "description": "ContextProviders inits and provides all contexts used in the app.\nIt includes providers as follows:\n  - ThemeProvider for styled-components theme\n  - TasksContext.Provider - managing tasks\n  - TaskEditorContext.Provider - managing editing tasks\n  - UserContext.Provider - managing users",
    "displayName": "ContextProviders",
    "methods": [],
    "props": {
      "children": {
        "required": true,
        "tsType": {
          "name": "ReactReactElement",
          "raw": "React.ReactElement"
        },
        "description": ""
      }
    }
  },
  "src/components/NavigationBar.tsx": {
    "description": "NavigationBar implements a navigation bar with a user selector inside.",
    "displayName": "NavigationBar",
    "methods": []
  },
  "src/components/Task.tsx": {
    "description": "Task is displaying a task title and handles clicks on it.",
    "displayName": "Task",
    "methods": []
  },
  "src/components/TaskEditor.tsx": {
    "description": "TaskEditor is a component where all the task management operations are performed.\nIt implements a form for creating/editing a task.\nIt includes the activity log.\nIt works like a modal.",
    "displayName": "TaskEditor",
    "methods": []
  },
  "src/components/TaskForm.tsx": {
    "description": "TaskForm is a component dedicated for task form only.",
    "displayName": "TaskForm",
    "methods": [],
    "props": {
      "onSubmit": {
        "required": true,
        "tsType": {
          "name": "signature",
          "type": "function",
          "raw": "(form: Form) => void",
          "signature": {
            "arguments": [
              {
                "name": "form",
                "type": {
                  "name": "Form"
                }
              }
            ],
            "return": {
              "name": "void"
            }
          }
        },
        "description": ""
      },
      "editedTask": {
        "required": true,
        "tsType": {
          "name": "union",
          "raw": "Task | null",
          "elements": [
            {
              "name": "Task"
            },
            {
              "name": "null"
            }
          ]
        },
        "description": ""
      },
      "users": {
        "required": true,
        "tsType": {
          "name": "Array",
          "elements": [
            {
              "name": "string"
            }
          ],
          "raw": "string[]"
        },
        "description": ""
      }
    }
  },
  "src/components/UserSelector.tsx": {
    "description": "UserSelector user UserContext for displaying and selecting users.",
    "displayName": "UserSelector",
    "methods": []
  }
}