To Do component in Microsoft Graph Toolkit

The To Do component is used to enable the signed-in user to view, add, remove, complete, and/or edit tasks from Microsoft To Do using the To Do API in Microsoft Graph.

Example

The following example displays the signed-in user's Microsoft To Do tasks using the mgt-todo component. You can use the code editor to see how properties change the behavior of the component.

Open this example in mgt.dev

Properties

You can use the following attributes and properties to customize the component.

Attribute	Property	Description
read-only	readOnly	A Boolean to set the task interface to be read only (no adding or removing tasks). Default is false.
hide-header	hideHeader	A Boolean to show or hide the header of the component. Default is false.
hide-options	hideOptions	A Boolean to show or hide the options in tasks. Default is false.
initial-id="folder_id"	initialId	A string ID to set the initially displayed folder to the provided ID.
target-id="folder_id"	targetId	A string ID to lock the tasks interface to the provided folder ID.
N/A	isNewTaskVisible	Determines whether new task view is visible at render.
N/A	taskFilter	An optional function to filter which tasks are shown to the user.

The following example shows only tasks from the folder with ID 12345 and does not allow the user to create new tasks.

<mgt-todo read-only initial-id="12345"></mgt-todo>

Custom CSS variables

The mgt-todo component defines the following CSS custom properties.

mgt-todo {
  --tasks-background-color
  --tasks-header-padding
  --tasks-title-padding
  --tasks-plan-title-font-size
  --tasks-plan-title-padding

  --tasks-new-button-width
  --tasks-new-button-height
  --tasks-new-button-color
  --tasks-new-button-background
  --tasks-new-button-border
  --tasks-new-button-hover-background
  --tasks-new-button-active-background

  --task-margin
  --task-background
  --task-border
  --task-header-color
  --task-header-margin

  --task-new-margin
  --task-new-border
  --task-new-input-margin
  --task-new-input-padding
  --task-new-input-font-size
  --task-new-select-border

  --task-new-add-button-background
  --task-new-add-button-disabled-background
  --task-new-cancel-button-color

  --task-complete-background
  --task-complete-border

  --task-icon-alignment: flex-start (default) | center | flex-end
  --task-icon-background
  --task-icon-background-completed
  --task-icon-border
  --task-icon-border-completed
  --task-icon-border-radius
  --task-icon-color
  --task-icon-color-completed
}

To learn more, see styling components.

Events

The following events are fired from the component.

Event	When is it emitted	Custom data	Cancelable	Bubbles	Works with custom template
taskClick	Fires when the user clicks or taps on a task	Selected task	No	No	No

For more information about handling events, see events.

Templates

The tasks component supports several templates that allow you to replace certain parts of the component. To specify a template, include a <template> element inside a component and set the data-type value to one of the following.

Data type	Data context	Description
task	task: a to-do task object	Replaces the whole default task.
task-details	task: a to-do task object	Template replaces the details section of the task.

The following example defines a template for the tasks component.

<mgt-todo>
    <template data-type="task-details">
        <div>
            Importance Level: {{task.importance}}
        </div>
    </template>
</mgt-todo>

Microsoft Graph permissions

This control uses the following Microsoft Graph APIs and permissions.

Configuration	Permission	API
targetId set	Tasks.Read	/me/todo/lists/${listId}, /me/todo/lists/{todoTaskListId}/tasks
targetId not set	Tasks.Read	/me/todo/lists, /me/todo/lists/{todoTaskListId}/tasks
create, update or delete task	Tasks.ReadWrite	/me/todo/lists/{todoTaskListId}/tasks/{taskId}

Authentication

The tasks component uses the global authentication provider described in the authentication documentation.

Cache

The mgt-todo component doesn't cache any data.