TaskSelection

Configs

Selected tasks.

A template method (empty by default) allowing you to control if a task can be selected or not.

new TaskBoard({
    isTaskSelectable(taskRecord) {
        return taskRecord.status !== 'done';
    }
})

Parameter	Type	Description
`taskRecord`	TaskModel	The task record

Returns: Boolean -

true if the task can be selected, otherwise false

Selected tasks.

isTaskSelection: Boolean= truereadonly

Identifies an object as an instance of TaskSelection class, or subclass thereof.

isTaskSelection: Boolean= truereadonlystatic

Identifies an object as an instance of TaskSelection class, or subclass thereof.

A template method (empty by default) allowing you to control if a task can be selected or not.

new TaskBoard({
    isTaskSelectable(taskRecord) {
        return taskRecord.status !== 'done';
    }
})

Parameter	Type	Description
`taskRecord`	TaskModel	The task record

Returns: Boolean -

true if the task can be selected, otherwise false

Deselect all tasks.

Deselect the supplied task.

Parameter	Type	Description
`taskRecord`	TaskModel

Check if the supplied task is selected or not

Parameter	Type	Description
`taskRecord`	TaskModel

Returns: Boolean -

Returns true if it is selected, false if not

Select the supplied task, deselecting any previously selected by default.

Parameter	Type	Description
`taskRecord`	TaskModel	Task to select
`add`	Boolean	Specify `true` to add to selection instead of replacing it

Triggered when task selection changes.

// Adding a listener using the "on" method
taskSelection.on('selectionChange', ({ source, action, selection, select, deselect }) => {

});

Parameter	Type	Description
`source`	TaskBoard	TaskBoard instance
`action`	select \| deselect	Either 'select' or 'deselect', depending on operation
`selection`	TaskModel[]	All currently selected tasks
`select`	TaskModel[]	Tasks selected by the operation
`deselect`	TaskModel[]	Tasks deselected by the operation

Called when task selection changes.

new TaskSelection({
    onSelectionChange({ source, action, selection, select, deselect }) {

    }
});

Parameter	Type	Description
`source`	TaskBoard	TaskBoard instance
`action`	select \| deselect	Either 'select' or 'deselect', depending on operation
`selection`	TaskModel[]	All currently selected tasks
`select`	TaskModel[]	Tasks selected by the operation
`deselect`	TaskModel[]	Tasks deselected by the operation