Sync with Todoist Plugin

https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/
Admin
An unofficial Obsidian plugin that integrates Todoist tasks into your Obsidian vault, enabling you...
Tokens:7,957
Snippets:125
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Build and Development Commands

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/contributing/general

These commands are used to manage the development and build process of the Sync with Todoist Plugin. 'npm install' downloads dependencies, 'npm run dev' starts the development build process, and 'npm run test' executes the test suite. You can filter tests by providing a path.

```shell
cd plugin
npm install
npm run dev
```

```shell
npm run test
```

```shell
npm run test ./src/utils
```

--------------------------------

### Install Obsidian Todoist Plugin (Bash)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Provides bash commands for manually installing the Todoist Sync plugin from Obsidian's community plugins browser. Requires Obsidian desktop client.

```bash
# Manual installation steps:
# 1. Open Obsidian Settings
# 2. Navigate to Community Plugins
# 3. Enable Community Plugins (if not already enabled)
# 4. Click "Browse" and search for "Todoist Sync"
# 5. Install and enable the plugin
```

--------------------------------

### Build and Develop Sync with Todoist Plugin

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.0.0/contributing/general

Steps to build the Sync with Todoist plugin using npm. Includes installing dependencies, starting the development build, and options for directing output to a specific Obsidian vault.

```shell
cd plugin
npm install
npm run dev
```

--------------------------------

### Build Obsidian Todoist Plugin

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Commands to install dependencies and build the plugin for development. It uses npm for package management and Vite for building. The output is typically placed in the 'plugin/dist/' directory, but can be configured via environment variables.

```bash
# Prerequisites: git, npm (or use Nix with direnv)

# Clone and build:
cd plugin
npm install
npm run dev

# Output location:
# - Default: plugin/dist/
# - Custom: Set VITE_OBSIDIAN_VAULT environment variable

# Configure custom output:
# Create plugin/.env.local with:
export VITE_OBSIDIAN_VAULT=/Users/username/Documents/my-vault

# Continuous development:
npm run dev
# Watches for changes and rebuilds automatically
# Files placed directly in target vault for testing
```

--------------------------------

### Todoist Query Block Displaying Specific Metadata

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/next/query-blocks

This example configures which task metadata is displayed in a query block. The `show` option allows you to selectively render `due`, `description`, `project`, or `labels`. Setting it to `none` hides all metadata.

```markdown
```todoist  
filter: "today | overdue"  
show:  
    - due  
    - project  
```  
```

```markdown
```todoist  
filter: "today | overdue"  
show: none  
```  
```

--------------------------------

### CSS Customization for Todoist Plugin (CSS)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

This CSS code provides examples for customizing the appearance of Todoist tasks and elements within Obsidian. It includes styling for different priority levels, overdue and today's tasks, empty states, metadata layout, and the overall query container.

```css
/* Priority-based styling */
.todoist-p1 > input[type="checkbox"] {
  /* Priority 1 (highest) tasks */
  accent-color: red;
}

.todoist-p2 > input[type="checkbox"] {
  /* Priority 2 tasks */
  accent-color: orange;
}

.todoist-p3 > input[type="checkbox"] {
  /* Priority 3 tasks */
  accent-color: blue;
}

.todoist-p4 > input[type="checkbox"] {
  /* Priority 4 (lowest) tasks */
  accent-color: gray;
}

/* Task state styling */
.task-overdue {
  /* Overdue tasks */
  color: red;
  font-weight: bold;
}

.task-today {
  /* Tasks due today */
  background-color: #fffbcc;
}

/* No tasks message */
.todoist-no-tasks {
  /* Customize empty state */
  font-style: italic;
  color: gray;
}

/* Metadata layout */
.task-metadata {
  display: inline; /* Date, project, labels on one line */
  /* OR */
  display: block;  /* Stack vertically */
}

/* Task list styling */
.todoist-task-list {
  /* All task lists created by plugin */
  list-style-type: none;
}

/* Query container */
.contains-todoist-query {
  /* Workspace leaves containing Todoist queries */
  border-left: 3px solid #e44232;
}

```

--------------------------------

### CSS for Styling Todoist Task Priorities (Obsidian)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/changelog

Provides CSS examples for styling Todoist tasks based on their priority level. This is useful for customizing the appearance of tasks within Obsidian notes. The classes like `.todoist-p1` are applied to elements representing priority 1 tasks.

```css
.todoist-p1 input[type="checkbox"] {
  /* This matches against the input element rendered for a priority 1 task. */
}

```

```css
+ .todoist-p1 > input[type="checkbox"] {
- .todoist-p1 input[type="checkbox"] {
    /* This matches against the input element rendered for a priority 1 task. */
}

```

--------------------------------

### Todoist Query Block with Custom Sorting

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/next/query-blocks

This example demonstrates how to define custom sorting for tasks fetched by a query block. The `sorting` option accepts a list of properties to sort by, such as `date`, `priority`, or `order`.

```markdown
```todoist  
filter: "today | overdue"  
sorting:  
    - date  
    - priority  
```  
```

--------------------------------

### Todoist Query Block with Sorting Options

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/query-blocks

This example demonstrates how to sort tasks fetched by a Todoist query block. The 'sorting' option accepts a list of criteria (e.g., 'date', 'priority') to order the tasks. If omitted, tasks are sorted by their Todoist order. The 'filter' option is necessary.

```markdown
```todoist  
filter: "today | overdue"
sorting:  
    - date  
    - priority  
```
```

--------------------------------

### Get Current Translations in TypeScript

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/contributing/translation

This snippet demonstrates how to import and use the `t` function to get the current language translations within the plugin. It initializes the translation object and provides an example of accessing a specific translation key.

```typescript
import { t } from "@/i18n";  
  
const i18n = t();  
  
const getSettingsHeader = () => {  
  return i18n.settings.general.header;  
};

```

--------------------------------

### JSON Configuration for Todoist Task Sorting (Obsidian Todoist Plugin)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/changelog

This JSON configuration example shows how to define custom sorting for tasks within the Obsidian Todoist plugin. It allows specifying sorting criteria such as 'date' and 'priority'.

```json
{
  "name": "My Tasks",
  "filter": "today | overdue",
  "autorefresh": 30,
  "sorting": ["date", "priority"]
}
```

--------------------------------

### Todoist Query Block with Show Options

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/query-blocks

This example illustrates how to control which task metadata elements are displayed in a Todoist query block using the 'show' option. You can specify 'due', 'description', 'project', or 'labels', or set it to 'none' to hide all metadata. The 'filter' option is included.

```markdown
```todoist  
filter: "today | overdue"  
show:  
    - due  
    - project  
```  
```

--------------------------------

### Todoist Query Block with Deprecated Group Option

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/query-blocks

This example uses the deprecated 'group' option to group tasks by project. Users are advised to use 'groupBy' instead. The 'filter' option is required for the query to function.

```markdown
```todoist  
filter: "today | overdue"
group: true  
```
```

--------------------------------

### CSS for Task Priority Styling

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/changelog

Adjust CSS to accommodate changes in how subtasks are rendered in the Todoist plugin. This example shows how to correctly target checkboxes for priority 1 tasks.

```css
+ .todoist-p1 > input[type="checkbox"] {
- .todoist-p1 input[type="checkbox"] {
    /* This matches against the input element rendered for a priority 1 task. */
}
```

--------------------------------

### Todoist Query Block with Name Option

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/query-blocks

This example shows how to add a name to the Todoist query block. The 'name' option renders an embedded header (h4) above the fetched tasks, providing context. It also includes the required 'filter' option.

```markdown
```todoist  
name: "Today & Overdue"
filter: "today | overdue"
```
```

--------------------------------

### Todoist Query Block with Embedded Header

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/next/query-blocks

This example shows how to add a custom header to your Todoist query block. The `name` option allows you to specify a title that will be rendered as an `<h4>` element above the task list.

```markdown
```todoist  
name: "Today & Overdue"  
filter: "today | overdue"  
```  
```

--------------------------------

### Add Translated Phrase in TypeScript

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/contributing/translation

This example illustrates how to add a translated phrase for a specific language. It shows how to update the language's translation object, potentially creating nested objects for the key path, and assigning the translated string.

```typescript
export const fr: DeepPartial<Translations> = {  
  settings: {  
    rendering: {  
      header: "translation of 'Rendering'",  
    },  
  },  
};

```

--------------------------------

### Accessing Translations in Plugin (TypeScript)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/contributing/translation

Demonstrates how to import and use the translation function `t()` within the plugin to retrieve translated strings. It shows how to get the translation object and access specific phrases using a nested key structure. The imported `t` function is assumed to be globally available or exported from a local i18n module.

```typescript
import { t } from "@/i18n";  
  
const i18n = t();  
  
const getSettingsHeader = () => {  
  return i18n.settings.general.header;  
};  

```

--------------------------------

### Run Tests for Sync with Todoist Plugin

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.0.0/contributing/general

Commands to execute the test suite for the Sync with Todoist plugin. Allows running all tests or filtering by a specific path.

```shell
npm run test
npm run test ./src/utils
```

--------------------------------

### Run Tests for Obsidian Todoist Plugin

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Commands to execute the test suite for the plugin. Supports running all tests or specific subsets based on file paths. Tests cover filter parsing, task sorting, date handling, and metadata rendering.

```bash
# Run all tests:
cd plugin
npm run test

# Run specific test subset:
npm run test ./src/utils

# Tests cover:
# - Filter parsing and validation
# - Task sorting and grouping logic
# - Date handling and timezone conversions
# - Metadata rendering
```

--------------------------------

### Bump Documentation Version (npm)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/contributing/release-process

Updates the version of the documentation for the plugin. This command is run in the `docs` directory and requires the new version number as an argument. It is typically used for minor or major releases.

```bash
npm run bump-version -- ${VERSION}
```

--------------------------------

### Tag and Push Git Release (git)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/contributing/release-process

Tags a new release version in Git and pushes the tag to the origin repository. This is a crucial step in the release process to mark a specific commit as a release.

```bash
git tag -a ${VERSION}
```

```bash
git push origin ${VERSION}
```

--------------------------------

### Lint and Format Sync with Todoist Plugin Code

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.0.0/contributing/general

Commands to check code formatting and linting using BiomeJS, and to automatically fix formatting issues within the Sync with Todoist plugin's codebase.

```shell
npm run lint:check
npm run lint:fix
```

--------------------------------

### Todoist Query Block Basic Usage

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/query-blocks

This code snippet demonstrates the basic usage of a Todoist query block. It requires a 'filter' option to specify which tasks to fetch from Todoist. The tasks matching the filter are rendered directly in the Obsidian note.

```markdown
```todoist  
filter: "today | overdue"
```
```

--------------------------------

### Set Obsidian Vault for Plugin Development

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.0.0/contributing/general

Configure the build process to automatically copy plugin files to a specified Obsidian vault for easier testing. This is achieved by setting the VITE_OBSIDIAN_VAULT environment variable in a local .env file.

```shell
export VITE_OBSIDIAN_VAULT=/Users/jamiebrynes/Documents/my-vault
```

--------------------------------

### Todoist Query Block with Show Options

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/query-blocks

Details how to control which task metadata elements are displayed in the query results using the 'show' property. This overrides plugin-level settings and allows selective rendering of due dates, descriptions, projects, and labels.

```markdown
```todoist  
filter: "today | overdue"  
show:  
    - due  
    - project  
```
```

--------------------------------

### Todoist Query Block Basic Usage

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/query-blocks

Demonstrates the basic structure of a Todoist query block used within a note. This block fetches tasks based on a specified Todoist filter and renders them in place. The 'filter' option is mandatory and must be a valid Todoist filter string.

```markdown
```todoist  
filter: "today | overdue"  
```
```

--------------------------------

### Basic Todoist Task Query Block

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/next/query-blocks

This code block demonstrates the fundamental usage of a query block to fetch tasks from Todoist. It requires a valid Todoist filter. The output replaces the code block with the fetched tasks.

```markdown
```todoist  
filter: "today | overdue"  
```  
```

--------------------------------

### Configure Todoist API Token (TypeScript)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Details on configuring the Todoist API token for the Obsidian plugin. The token is stored locally and should be kept secure. Requires a Todoist integration token obtained from Todoist settings.

```typescript
// The API token is stored at: .obsidian/todoist-token
// Configuration via Settings UI:
// 1. Enable the plugin
// 2. A modal will prompt for your Todoist API token
// 3. Paste token from https://todoist.com/prefs/integrations
// 4. Plugin validates the token automatically
// 5. Click "Submit" to save

// Note: Exclude .obsidian/todoist-token from vault sync for security
```

--------------------------------

### Selective Todoist Metadata Display (Markdown)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Configures which metadata fields (due date, description, project, labels) are displayed for Todoist tasks. Supports showing specific fields or hiding all metadata. Requires a filter and a 'show' configuration.

```markdown
# Show only specific task metadata
```todoist
filter: "today"
show:
  - due
  - project
```

# Available metadata fields:
# - due/date: task due date
# - description: task description
# - project: project and section
# - labels: task labels

# Hide all metadata:
```todoist
filter: "today"
show: none
```

# Result: Tasks render with only selected metadata or no metadata
```

--------------------------------

### Add Todoist Task Command (TypeScript)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Describes the 'Add task' command functionality within Obsidian, allowing users to create new Todoist tasks with options for content, due date, duration, project, labels, and description. Supports pre-filling from selected text.

```typescript
// Command: "Add task"
// Opens modal with fields:
// - Task content (pre-filled with selected text if any)
// - Due date (none/today/tomorrow based on default settings)
// - Duration (optional, e.g., "30m", "1h")
// - Project (dropdown, defaults to configured project or Inbox)
// - Labels (multi-select, defaults to configured labels)
// - Description (optional)

// Example workflow:
// 1. Select text: "Review design mockups"
// 2. Run command (Ctrl/Cmd+P → "Add task")
// 3. Modal opens with "Review design mockups" pre-filled
// 4. Set due date: "tomorrow"
// 5. Set duration: "1h"
// 6. Select project: "Work"
// 7. Add labels: "review", "design"
// 8. Press Enter or click Submit
// Result: Task created in Todoist with specified properties
```

--------------------------------

### Configure Auto-Refresh Settings (YAML)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Configuration options for auto-refreshing Todoist tasks within Obsidian. Supports global settings and per-query overrides. Requires valid interval in seconds.

```yaml
# Global auto-refresh settings (in plugin settings):
# - Auto-refresh enabled: true/false
# - Auto-refresh interval: 60 (seconds)

# Per-query auto-refresh override:
```todoist
filter: "today | overdue"
autorefresh: 120
```
# This query refreshes every 120 seconds regardless of global settings
```

--------------------------------

### Todoist Query Block with Show Options

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/query-blocks

This snippet illustrates how to control which task metadata is displayed in a Todoist query block using the 'show' option. Options include 'due', 'description', 'project', and 'labels'. This overrides global plugin settings. A 'filter' is required.

```markdown
```todoist  
filter: "today | overdue"
show:  
    - due  
    - project  
```
```

--------------------------------

### Sorted and Grouped Todoist Query (Markdown)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

An advanced Todoist query configuration allowing sorting tasks by date or priority and grouping them by project, section, due date, labels, or priority. Supports various sorting and grouping options.

```markdown
# Advanced query with sorting and grouping
```todoist
name: "Priority Tasks"
filter: "p1 | p2"
sorting:
  - priority
  - date
groupBy: project
```

# Sorting options:
# - date/dateAscending: sort by due date (ascending)
# - dateDescending: sort by due date (descending)
# - priority/priorityAscending: sort by priority (ascending)
# - priorityDescending: sort by priority (descending)
# - order: use Todoist's task order
# - dateAdded/dateAddedAscending: sort by creation date
# - dateAddedDescending: sort by creation date (descending)

# Grouping options:
# - project: group by project
# - section: group by project and section
# - due/date: group by due date (overdue tasks together)
# - labels: group by task labels
# - priority: group by priority (high to low)

# Result: Tasks sorted by priority then date, grouped by project
```

--------------------------------

### Basic Todoist Task Query (Markdown)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

A minimal Todoist query block in Markdown to display tasks due today or overdue. Requires a valid Todoist filter syntax; does not support wildcard or comma-combined filters.

```markdown
# Minimal query - shows all tasks due today or overdue
```todoist
filter: "today | overdue"
```

# The filter field is required and must be valid Todoist filter syntax
# Unsupported: wildcard filters (@*ball), comma-combined filters (today | overdue, p1)
# Result: Renders all matching tasks in place of the code block
```

--------------------------------

### Code Quality Checks with BiomeJS

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Commands for maintaining code quality using BiomeJS. Includes checking for formatting and linting errors, and automatically fixing them. These commands help ensure a consistent code style across the plugin.

```bash
# Linting with BiomeJS:
cd plugin

# Check formatting and linting:
npm run lint:check

# Auto-fix issues (modifies files):
npm run lint:fix

# Ensures consistent code style across the plugin
```

--------------------------------

### Template for New Language Translations in TypeScript

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/contributing/translation

This code provides a template for creating new language translation files. It imports necessary types and exports a `DeepPartial` of the `Translations` type, intended to be populated with language-specific phrases.

```typescript
import type { Translations } from "@/i18n/translation";  
import type { DeepPartial } from "@/utils/types";  
  
export const $langCode: DeepPartial<Translations> = {};  

```

--------------------------------

### JSON Configuration for Todoist Task Sorting (Obsidian)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/changelog

Demonstrates the JSON configuration for enabling custom sorting of Todoist tasks within Obsidian. Users can specify sorting criteria such as 'date' and 'priority' to organize their tasks. This feature requires amending the query configurations.

```json
{
  "name": "My Tasks",
  "filter": "today | overdue",
  "autorefresh": 30,
  "sorting": ["date", "priority"]
}

```

--------------------------------

### Add Task with Page Link in Description (TypeScript)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

This function creates a new task in Todoist, including a provided description, and appends a link to the current Obsidian page to the end of the description. This is useful for associating tasks with specific documentation pages.

```typescript
// Command: "Add task with current page in task description"
// Current page: "Project Documentation"

// Workflow:
// 1. Run command
// 2. Enter task: "Update API documentation"
// 3. Add description: "Sections 3.1-3.4 need revision"
// 4. Submit

// Task created in Todoist:
// Content: "Update API documentation"
// Description: "Sections 3.1-3.4 need revision\n\n[[Project Documentation]]"
// Note: Page link appended to description, not shown in modal

```

--------------------------------

### Dynamic Filename Filter for Todoist (Markdown)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Utilizes dynamic filename replacement in Todoist filters, allowing queries to automatically reference the current Markdown file's name. Useful for project-specific task views. Requires the `{{filename}}` placeholder.

```markdown
# In file: "Project Alpha.md"
```todoist
filter: "#{{filename}}"
```

# {{filename}} replaced with "Project Alpha"
# Actual filter becomes: "#Project Alpha"
# Result: Shows all tasks in Todoist project named "Project Alpha"
```

--------------------------------

### Sync with Todoist Command (TypeScript)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

This command forces a manual synchronization of metadata between Obsidian and Todoist. It's used to refresh projects, sections, and labels, especially after making changes in Todoist or encountering unknown metadata errors. This manual refresh helps avoid excessive API calls.

```typescript
// Command: "Sync with Todoist"
// Purpose: Force re-synchronization of metadata (projects, sections, labels)

// When to use:
// - After creating new projects in Todoist
// - After renaming projects, sections, or labels
// - When seeing "Unknown Project", "Unknown Section", or "Unknown Label"

// Behavior:
// - Metadata is cached at plugin startup
// - Not automatically refreshed to avoid API rate limits
// - This command forces immediate refresh

// Usage:
// 1. Run command (Ctrl/Cmd+P → "Sync with Todoist")
// 2. Plugin fetches latest metadata from Todoist API
// 3. All queries automatically update with new metadata
// Result: Projects, sections, and labels display correctly

```

--------------------------------

### Manual Query Refresh (Markdown)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

This documentation explains how to manually refresh individual Todoist queries within Obsidian. Each query displays a refresh button, allowing for immediate updates. It also notes the auto-refresh configuration, where queries can be set to update at a specified interval.

```markdown
# Each rendered query has a refresh button
# Click the refresh icon to manually update that specific query
# Tooltip shows last refresh timestamp

# Auto-refresh configuration:
```todoist
filter: "today"
autorefresh: 30
```
# This query auto-refreshes every 30 seconds
# Manual refresh button still available for immediate updates

```

--------------------------------

### Todoist Query Block with Grouping

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.0.0/query-blocks

Explains how to group rendered Todoist tasks based on specified criteria. The 'groupBy' option (e.g., 'project', 'due', 'labels') organizes tasks visually, with no grouping applied if omitted.

```markdown
```todoist  
filter: "today | overdue"  
groupBy: project  
```
```

--------------------------------

### CSS for Task Metadata Layout

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/changelog

These CSS snippets demonstrate how to configure the layout of task metadata, specifically the project, date, and label combination, within the Obsidian Todoist plugin. Users can choose to display these elements inline or stacked vertically.

```CSS
/* To make date & project sit inline */
.task-metadata {
  display: inline;
}

/* To make date & project sit on top of each other. */
.task-metadata {
  display: block;
}
```

--------------------------------

### Named Todoist Query with Refresh (Markdown)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

Configures a Todoist task query with a custom name header and a specific auto-refresh interval. Useful for organizing and ensuring timely updates of task lists. Requires a name and filter.

```markdown
# Query with title header and custom refresh interval
```todoist
name: "Today & Overdue"
filter: "today | overdue"
autorefresh: 120
```

# Renders <h4> header "Today & Overdue" above the task list
# Refreshes automatically every 120 seconds
```

--------------------------------

### Todoist Query Block with Show Metadata

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/query-blocks

Illustrates how to control which task metadata elements are displayed in a Todoist query block using the 'show' property. You can specify elements like 'due', 'description', 'project', or 'labels'. Setting 'show' to 'none' will hide all metadata.

```markdown
```todoist  
filter: "today | overdue"  
show:  
    - due  
    - project  
```
```

```markdown
```todoist  
filter: "today | overdue"  
show: none  
```
```

--------------------------------

### Registering a New Language in Registry (TypeScript)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/contributing/translation

Illustrates how to register a newly added language within the plugin's translation registry. This involves importing the language-specific translation object and adding an entry to the `registry` object. The entry includes the language name, code, and the imported translations.

```typescript
// plugin/src/i18n/index.ts  
import { fr } from "@/i18n/langs/fr";  
  
// A bunch of things you don't need to worry about...  
  
const registry: Record<string, DeepPartial<Translations>> = {  
  fr: {  
    name: "Français",  
    code: "fr",  
    translations: fr,  
  },  
};  


```

--------------------------------

### Template for New Language Translation File (TypeScript)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/contributing/translation

Provides a template for creating a new translation file for a specific language. It imports necessary types for `Translations` and `DeepPartial`. The exported object `$langCode` should be populated with the translations for the new language. This structure ensures type safety and organization.

```typescript
import type { Translations } from "@/i18n/translation";  
import type { DeepPartial } from "@/utils/types";  
  
export const $langCode: DeepPartial<Translations> = {};  


```

--------------------------------

### Styling Todoist Tasks with CSS

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.0.0/changelog

Demonstrates how to apply custom CSS to style Todoist tasks based on their priority. This allows for visual differentiation of tasks within Obsidian. Note that specific selectors might need adjustments based on your theme.

```css
.todoist-p1 > input[type="checkbox"] {
  /* This matches against the input element rendered for a priority 1 task. */
}

.todoist-p1 input[type="checkbox"] {
  /* This matches against the input element rendered for a priority 1 task. */
}
```

--------------------------------

### Todoist Query Block with Grouping Options

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/query-blocks

This code shows how to group tasks within a Todoist query block using the 'groupBy' option. Possible values include 'project', 'section', 'due', 'labels', or 'priority'. If omitted, no grouping is applied. A 'filter' is required.

```markdown
```todoist  
filter: "today | overdue"
groupBy: project  
```
```

--------------------------------

### CSS for Priority 1 Task Styling (Obsidian Todoist Plugin)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/changelog

This CSS snippet demonstrates how to target and style elements associated with Todoist priority 1 tasks within the Obsidian plugin. It's useful for custom theming based on task priority.

```css
.todoist-p1 input[type="checkbox"] {
  /* This matches against the input element rendered for a priority 1 task. */
}
```

--------------------------------

### JSON Configuration for Auto-Refreshing Queries (Obsidian)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/changelog

Shows how to configure auto-refreshing for Todoist queries in Obsidian using JSON. The 'autorefresh' property, set in seconds, allows queries to update automatically. This can be set globally in settings or overridden per query.

```json
{
  "name": "My Tasks",
  "filter": "today | overdue",
  "autorefresh": 30
}

```

--------------------------------

### Registering a New Language in the Registry (TypeScript)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.0.0/contributing/translation

Illustrates how to register a newly added language translation within the plugin's i18n index file. This involves importing the language-specific file and adding it to the registry object using the language code as the key.

```typescript
// plugin/src/i18n/index.ts  
import { fr } from "@/i18n/langs/fr";  
  
// A bunch of things you don't need to worry about...  
  
const registry: Record<string, DeepPartial<Translations>> = {  
  fr: fr,  
};

```

--------------------------------

### JSON Configuration for Auto-Refreshing Queries (Obsidian Todoist Plugin)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/changelog

Illustrates the JSON configuration for enabling and setting the auto-refresh interval for Todoist queries within the Obsidian plugin. This feature helps keep tasks up-to-date automatically.

```json
{
  "name": "My Tasks",
  "filter": "today | overdue",
  "autorefresh": 30
}
```

--------------------------------

### Todoist Query Block with Autorefresh

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/query-blocks

Illustrates how to configure automatic refreshing of the query results at a specified interval in seconds using the 'autorefresh' option. This setting overrides the global plugin-level refresh configuration.

```markdown
```todoist  
filter: "today | overdue"  
autorefresh: 120  
```
```

--------------------------------

### Todoist Query Block Grouped by Project

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/next/query-blocks

This code shows how to group tasks within a query block by their project. The `groupBy` option can be set to `project`, `section`, `due`, `labels`, or `priority` for different organizational views.

```markdown
```todoist  
filter: "today | overdue"  
groupBy: project  
```  
```

--------------------------------

### Todoist Query Block with Grouping Enabled

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/query-blocks

Explains how to enable task grouping by project within the query results using the 'group' option. This is a boolean flag, with further grouping enhancements planned for future releases.

```markdown
```todoist  
filter: "today | overdue"  
group: true  
```
```

--------------------------------

### Adding Translated Phrases to a Language File (TypeScript)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/contributing/translation

Shows how to add translated phrases to a specific language's translation file. It demonstrates creating or updating nested objects within the language's `DeepPartial<Translations>` object to match the key structure found in the English translations. This allows for specific phrase translations.

```typescript
export const fr: DeepPartial<Translations> = {  
  settings: {  
    rendering: {  
      header: "translation of 'Rendering'",  
    },  
  },  
};  


```

--------------------------------

### Todoist Query Block with Sorting Options

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/query-blocks

Demonstrates how to define custom sorting for the displayed tasks using the 'sorting' property. This option accepts a list of sorting criteria, such as date, priority, or date added, in ascending or descending order. If not specified, tasks default to their Todoist order.

```markdown
```todoist  
filter: "today | overdue"  
sorting:  
    - date  
    - priority  
```
```

--------------------------------

### Register New Language in Registry in TypeScript

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/contributing/translation

This snippet shows how to register a newly added language within the plugin's translation registry. It involves importing the language's translation object and adding an entry to the `registry` Record, mapping a language code to its translations.

```typescript
// plugin/src/i18n/index.ts  
import { fr } from "@/i18n/langs/fr";  
  
// A bunch of things you don't need to worry about...  
  
const registry: Record<string, DeepPartial<Translations>> = {  
  fr: {  
    name: "Français",  
    code: "fr",  
    translations: fr,  
  },  
};

```

--------------------------------

### Todoist Query Block with Name Option

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/query-blocks

Shows how to add a custom header to the rendered query results using the 'name' option. This option embeds an h4 element above the tasks, providing a descriptive title for the query block.

```markdown
```todoist  
name: "Today & Overdue"  
filter: "today | overdue"  
```
```

--------------------------------

### Add Task with Page Link in Content (TypeScript)

Source: https://context7.com/context7/jamiebrynes7_github_io_obsidian-todoist-plugin/llms.txt

This function adds a new task to Todoist and automatically appends a link to the current Obsidian page within the task's content. It respects configuration settings for how the link is appended and if parentheses are used.

```typescript
// Command: "Add task with current page in task content"
// Current page: "Meeting Notes 2025-10-13"

// Workflow:
// 1. Run command
// 2. Enter task: "Follow up on action items"
// 3. Modal shows: "(Will append link to current page)"
// 4. Submit task

// Task created in Todoist:
// Content: "Follow up on action items [[Meeting Notes 2025-10-13]]"
// Note: Link is appended but not shown in modal UI

// Configuration option:
// Settings → Task creation → "Add task button adds page link"
// Options: None, Append to content, Append to description

// Settings → Task creation → "Add parenthesis to page links"
// When enabled: "Follow up ([[Meeting Notes 2025-10-13]])"
// Useful for: Better visibility on Todoist mobile apps

```

--------------------------------

### CSS for Task Calendar Icons (Obsidian)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/2.1.0/changelog

Offers CSS for styling task calendar icons within the Obsidian Todoist plugin. This helps in visually representing dates associated with tasks. The provided styles ensure the icons are vertically aligned and have appropriate dimensions.

```css
.task-calendar-icon {
  vertical-align: middle;
  height: 17px;
  width: 17px;
}

```

--------------------------------

### Todoist Query Block with Auto Refresh

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/next/query-blocks

This snippet illustrates how to configure automatic refreshing for a Todoist query block. The `autorefresh` option takes the refresh interval in seconds, overriding the global plugin setting.

```markdown
```todoist  
filter: "today | overdue"  
autorefresh: 120  
```  
```

--------------------------------

### Todoist Query Block with Show None

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/query-blocks

This snippet demonstrates how to hide all task metadata in a Todoist query block by setting the 'show' option to 'none'. This is useful when only the task title is needed. The 'filter' option is also included.

```markdown
```todoist  
filter: "today | overdue"  
show: none  
```  
```

--------------------------------

### Todoist Query Block with Autorefresh

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.13.0/query-blocks

This snippet illustrates how to configure automatic refreshing for a Todoist query block. The 'autorefresh' option specifies the interval in seconds for refreshing tasks, overriding global plugin settings. The 'filter' option is also required.

```markdown
```todoist  
filter: "today | overdue"
autorefresh: 120
```
```

--------------------------------

### CSS for Task Calendar Icon Styling (Obsidian Todoist Plugin)

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/changelog

Provides CSS to style the calendar icon used for displaying task dates in the Obsidian Todoist plugin. This allows for customization of the icon's appearance, such as vertical alignment and dimensions.

```css
.task-calendar-icon {
  vertical-align: middle;
  height: 17px;
  width: 17px;
}
```

--------------------------------

### Group Query Results in Todoist Plugin

Source: https://jamiebrynes7.github.io/obsidian-todoist-plugin/docs/1.12.0/changelog

This feature allows users to group the results of a Todoist query by project and section. It is enabled by adding a 'group': true field to the JSON query configuration. This improves organization by visually separating tasks based on their project hierarchy.

```JSON
{
  "name": "My Tasks",
  "filter": "today | overdue",
  "group": true
}
```
Tokens:
Raw