SimpleTaskEdit
Feature

This feature allows inline editing of tasks. Double-clicking an item starts editing it:

Each task item can define an editor. To prevent an item from being edited inline, configure it with editor : null:

This feature is disabled by default.

Keyboard shortcuts

The feature has the following default keyboard shortcuts:

Keys	Action	Action description
`Enter`	editNext	In an editor this will accept the change and start editing the next item on that card or the first item on the next card. By default it adds a new task when pressed on the last item of the last card in a column. This behaviour is configurable using the addNewAtEnd config.
`Escape`	cancel	Cancels editing and reverts changes for that item which is currently being edited
`Shift`+`Enter`	editPrevious	In an editor this will accept the change and start editing the previous item on that card or the last item on the previous card
`Ctrl`+`Enter`	complete	Accepts the edit and closes the editor

Please note that Ctrl is the equivalent to Command and Alt is the equivalent to Option for Mac users

For more information on how to customize keyboard shortcuts, please see our guide.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

addNewAtEnd : Booleantrue

Pressing Enter in last item on last task in a column adds a new task.
editorConfig : EditorConfig

A configuration object for the Editor used by this feature. Useful when you want to validate the value being set by the end user (see beforeComplete).
keyMap : Object<String, KeyMapConfig>

See Keyboard shortcuts for details

Properties

Properties are getters/setters or publicly accessible variables on this class

isSimpleTaskEdit : Booleantrue

READONLY

static

ADVANCED

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

isSimpleTaskEdit : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

editTask( taskRecord, element )
: Boolean

ON-OWNER

Starts inline editing of the supplied task, optionally for a specific item on its card.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

beforeSimpleTaskEdit

PREVENTABLE

ON-OWNER

Fires on the owning TaskBoard before displaying an inline editor. Returning false stops the editor from being shown.

const taskBoard = new TaskBoard({
   listeners : {
       beforeSimpleTaskEdit({ taskRecord }) {
           // Some condition for which editing should be blocked...
           if (taskRecord.disallowed) {
               return false;
           }
       }
   }
});

Note that this event is triggered on the owning widget:

simpleTaskEditCancel

PREVENTABLE

ON-OWNER
Fires on the owning TaskBoard when inline editing of a field is cancelled (by pressing ESC).
```
const taskBoard = new TaskBoard({
   listeners : {
       simpleTaskEditCancel({ taskRecord }) {
           Toast.show(`Aborted editing of ${taskRecord.name}`);
       }
   }
});
```
Note that this event is triggered on the owning widget:

simpleTaskEditComplete

PREVENTABLE

ON-OWNER

Fires on the owning TaskBoard when inline editing of a field has successfully finished.

const taskBoard = new TaskBoard({
   listeners : {
       simpleTaskEditComplete({ taskRecord, field }) {
           Toast.show(`Finished editing ${field} of ${taskRecord.name}`);
       }
   }
});

Note that this event is triggered on the owning widget:

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onBeforeSimpleTaskEdit

PREVENTABLE

ON-OWNER

Called on the owning TaskBoard before displaying an inline editor. Returning false stops the editor from being shown.

const taskBoard = new TaskBoard({
   listeners : {
       beforeSimpleTaskEdit({ taskRecord }) {
           // Some condition for which editing should be blocked...
           if (taskRecord.disallowed) {
               return false;
           }
       }
   }
});

Note that this handler is called on the owning widget:

onSimpleTaskEditCancel

PREVENTABLE

ON-OWNER
Called on the owning TaskBoard when inline editing of a field is cancelled (by pressing ESC).
```
const taskBoard = new TaskBoard({
   listeners : {
       simpleTaskEditCancel({ taskRecord }) {
           Toast.show(`Aborted editing of ${taskRecord.name}`);
       }
   }
});
```
Note that this handler is called on the owning widget:

onSimpleTaskEditComplete

PREVENTABLE

ON-OWNER

Called on the owning TaskBoard when inline editing of a field has successfully finished.

const taskBoard = new TaskBoard({
   listeners : {
       simpleTaskEditComplete({ taskRecord, field }) {
           Toast.show(`Finished editing ${field} of ${taskRecord.name}`);
       }
   }
});

Note that this handler is called on the owning widget:

CSS variables

CSS variables that can be set to adjust appearance

Name	Description
--b-task-board-simple-task-edit-background	Editor background
--b-task-board-simple-task-edit-border	Editor border
--b-task-board-simple-task-edit-box-shadow	Editor box shadow

SimpleTaskEdit
Feature

Keyboard shortcuts

Configs

Properties

Functions

Events

Event handlers

CSS variables

Source path

Inheritance tree4

Mixins2

Contents

SimpleTaskEdit Feature

Keyboard shortcuts

Configs

Properties

Functions

Events

Event handlers

CSS variables

Source path

Inheritance tree4

Mixins2

Contents

SimpleTaskEdit
Feature