Skip to main content

hasChildren()

Description​

Checks whether the specified task has child tasks

Usage​

hasChildren({
    id: string | number,
    filtered?: boolean, // false by default
    hideCompleted?: boolean // false by default
}): boolean;

Parameters​

  • id - (required) the ID of the task
  • filtered - (optional) if false, the filtered child tasks will be also included into the result; otherwise, will be excluded from it
  • hideCompleted - (optional) if false, the completed tasks will be included into the result; otherwise, will be excluded from it
tip

The filtered parameter is used if the filtering has been applied

Returns​

The method returns true if the task has children; otherwise, returns false

Example​

const { ToDo, Toolbar } = todo;

const list = new ToDo("#root", {
    tasks: [
        { id: "1", text: "Task 1 #tag1 #tag3" },
        { id: "1.1", text: "Task 1.1", parent: "1" },
        { id: "1.1.1", text: "Task 1.1.1 #tag1", parent: "1.1", checked: true },
        { id: "1.2", text: "Task 1.2", parent: "1" },
    ]
});

const toolbar = new Toolbar("#toolbar", {
    api: list.api,
});

// check whether the task has children (before filtering)
console.log(list.hasChildren({ id: "1.1" })); // -> true

console.log(list.hasChildren({ id: "1.1", hideCompleted: true})); // -> false

// filter the tasks
list.setFilter({ match: "#tag3", highlight: true });

// check whether the task has children (after filtering)
console.log(list.hasChildren({ id: "1.1" })); // -> true
console.log(list.hasChildren({ id: "1.1", hideCompleted: true })); // -> false

console.log(list.hasChildren({ id: "1.1", filtered: true })); // -> false

Change log: The hideCompleted parameter was added in v1.1

Related article: Task object/Id