Task Board

https://tu2-atmanand.github.io/task-board-docs
Admin
Task Board is an Obsidian plugin that scans tasks from your vault and displays them in an efficient...
Tokens:26,607
Snippets:326
Trust Score:8.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Task Board API - Getting Started

Source: https://tu2-atmanand.github.io/task-board-docs/docs/How_To/HowToUseAPIs

Demonstrates how to access the Task Board API within your Obsidian plugin.

```APIDOC
## Getting the Task Board API

To use the Task Board API in your plugin, you need to access it through the Obsidian app’s plugin registry.

```javascript
// In your plugin's onload method or in your scripts
const taskBoardPlugin = this.app.plugins.plugins["task-board"];
const taskBoardApi = taskBoardPlugin?.taskBoardApi;

if (!taskBoardApi) {
  console.error("Task Board plugin not found or API not available");
  return;
}

// Now you can use the API
// Example: const taskContent = await taskBoardApi.addNewTask(false);
```
```

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

### Create New Task using Task Board API

Source: https://tu2-atmanand.github.io/task-board-docs/docs/How_To/HowToUseAPIs

Provides examples of using the `addNewTask` method from the Task Board API. This method allows creating either Task Notes or inline tasks. The examples cover different scenarios, including creating a task note, an inline task in a specific file, and a task note at a designated location. It also shows how to handle the returned task content, including empty strings for cancellations and error messages.

```typescript
const taskContent = await taskBoardApi.addNewTask(true);

if (taskContent === "") {
  console.log("User cancelled the task creation");
} else if (taskContent.startsWith("Error")) {
  console.error("Failed to create task:", taskContent);
} else {
  console.log("Task created successfully!");
  console.log("Task content:", taskContent);
}
```

```typescript
const filePath = "Projects/MyProject/README.md";
const taskContent = await taskBoardApi.addNewTask(false, filePath);

if (taskContent) {
  // Write the task to the file
  const file = this.app.vault.getAbstractFileByPath(filePath);
  if (file instanceof TFile) {
    const currentContent = await this.app.vault.read(file);
    await this.app.vault.modify(file, currentContent + "\n" + taskContent);
  }
}
```

```typescript
const noteLocation = "Archive/Tasks/2025-01.md";
const taskContent = await taskBoardApi.addNewTask(true, noteLocation);

if (taskContent && taskContent !== "") {
  // Task was created at the specified location
  new Notice("Task Note created successfully!");
}
```

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

### Task Board: Task with Separated Metadata Example

Source: https://tu2-atmanand.github.io/task-board-docs/docs/Components/Task_Formats

Shows an example of a task with metadata separated from the title using a pipe symbol ('|'). This format influences how the Task Item Card is displayed, potentially allowing for cleaner presentation by hiding headers and footers.

```markdown
- [ ] This is a simple task with separated metadata | 🔼 ⏰[13:00 - 14:00] 📅 2024-11-06 #home #Test 
 This is a line inside the task description.
 - [ ] This is a single sub-task

```

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

### Task Board: Multi-level Sub-tasks Example

Source: https://tu2-atmanand.github.io/task-board-docs/docs/Components/Task_Formats

Demonstrates how to create multi-level sub-tasks within Task Board. It requires at least one level of indentation for sub-tasks and no empty lines between the main task and its sub-tasks. This example shows up to four levels of indentation.

```markdown
- [ ] Adding a new task to show multi-level sub-tasks | 📅 2024-10-29 #Test #Bug
    - [ ] This is a First level sub-Task.
        - [ ] This is a Second level sub-task.
            - [ ] This is a Third level sub-Task.
                - [ ] This is a Fourth level sub-Task. And so on.
            - [ ] This is another Third level sub-Task.
                - [ ] This is another Fourth level sub-Task. And so on.

```

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

### Filter Tasks by Tags (Markdown Example)

Source: https://tu2-atmanand.github.io/task-board-docs/docs/Features/Filters_for_Scanning

This snippet demonstrates how to format tag names for filtering tasks. Tags should be prefixed with '#' and separated by commas. This is used in the 'Tag Names' input field.

```markdown
#Bug, #docs/bug, #feature
```

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

### Handle Task Creation Return States (JavaScript)

Source: https://tu2-atmanand.github.io/task-board-docs/docs/How_To/HowToUseAPIs

Illustrates how to handle the different possible return values from the `addNewTask` API method. It checks for empty strings indicating user cancellation and error strings, logging appropriate messages to the console. Valid task content is then processed.

```javascript
const result = await taskBoardApi.addNewTask(true);

// Check for cancellation (user closed modal without saving)
if (result === "") {
  console.log("Operation cancelled");
  return;
}

// Check for errors
if (result.startsWith("Error") || result.includes("error")) {
  console.error("Operation failed:", result);
  return;
}

// Result contains task content
console.log("Success:", result);
```

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

### Create Task with Error Handling (JavaScript)

Source: https://tu2-atmanand.github.io/task-board-docs/docs/How_To/HowToUseAPIs

Demonstrates a complete workflow for creating a task using the Task Board API, including checks for plugin availability, user cancellation, task creation errors, and successful task addition to the active file. It utilizes Obsidian's API for file operations and user notifications.

```javascript
async function createTaskFromCommand() {
  const taskBoardPlugin = this.app.plugins.plugins["task-board"];
  
  if (!taskBoardPlugin?.taskBoardApi) {
    new Notice("Task Board plugin is not available");
    return;
  }

  try {
    const taskContent = await taskBoardPlugin.taskBoardApi.addNewTask(false);
    
    if (taskContent === "") {
      console.log("Task creation was cancelled by user");
      return;
    }
    
    if (taskContent.startsWith("Error")) {
      new Notice(`Failed to create task: ${taskContent}`);
      return;
    }
    
    // Successfully created, add to current file
    const activeFile = this.app.workspace.getActiveFile();
    if (activeFile) {
      const content = await this.app.vault.read(activeFile);
      await this.app.vault.modify(activeFile, content + "\n" + taskContent);
      new Notice("Task added successfully!");
    }
  } catch (error) {
    console.error("Unexpected error:", error);
    new Notice("An unexpected error occurred");
  }
}
```

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

### Access Task Board API in Obsidian Plugin

Source: https://tu2-atmanand.github.io/task-board-docs/docs/How_To/HowToUseAPIs

Demonstrates how to retrieve the Task Board API instance from the Obsidian plugin registry. This is a prerequisite for using any Task Board API functionalities within another Obsidian plugin. It includes error handling for cases where the plugin or API is not available.

```typescript
const taskBoardPlugin = this.app.plugins.plugins["task-board"];
const taskBoardApi = taskBoardPlugin?.taskBoardApi;

if (!taskBoardApi) {
  console.error("Task Board plugin not found or API not available");
  return;
}

// Now you can use the API
const taskContent = await taskBoardApi.addNewTask(false);
```
Tokens:
Raw