Skip to main content

set-sort

Description​

Fires when sorting tasks

Usage​

"set-sort": ({
    by?: string | ((task: object) => string),
    dir?: "asc" | "desc",
    tree?: boolean,
}) => void;

Parameters​

The callback of the set-sort event can take an object with the following parameters:

  • by - (optional) the search criterion (either the key of the task attribute or a search function which returns a string)
  • dir - (optional) the direction of sorting: "asc" or "desc"
  • tree - (optional) defines whether sorting for child tasks is enabled
info

To handle the inner events, you can use the Event Bus methods

Example​

const { ToDo, Toolbar } = todo;
const {tasks, projects, users} = getData();

const list = new ToDo("#root", {
    tasks,
    projects,
    users
});

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

// subscribe to the "set-sort" event
list.api.on("set-sort", ({ by, dir, tree }) => {
    console.log(by, dir, tree);
});

Related article: Sorting and filtering tasks