Bryntum TaskBoard Documentation

website·Indexed 35 days ago

https://www.bryntum.com/products/taskboard/docs/

Documentation for Bryntum TaskBoard, featuring integration guides for Angular, React, Next.js, Remix, Vue 3, and Salesforce Lightning Web Components. Includes instructions for npm installation, data binding, event handling, and combining multiple Bryntum products using thin packages.

Tokens: 337.1K
Snippets: 1.5K
Records: 2.6K
Agent score: 72%

What's inside Bryntum TaskBoard

Overview of TaskMenu feature
The TaskMenu feature displays a context menu for tasks in the TaskBoard. It is enabled by default. The menu can be triggered via mouse/touch gestures or keyboard shortcuts (Space or Ctrl+Space for the focused task). You can also use a TaskMenuItem button to trigger the menu.
https://bryntum.com/products/taskboard/docs-llm/api/TaskBoard/feature/TaskMenu.mdwebsitellms
Overview of EventModel
The EventModel class represents a single event in a schedule and is typically added to an EventStore. It is a subclass of TimeSpan, which in turn inherits from Model. It includes the RecurringTimeSpan mixin to support complex recurrence patterns using recurrenceRule and exceptionDates.
```
{
  "id"             : 1,
  "name"           : "Daily standup",
  "startDate"      : "2024-01-03 10:00",
  "duration"       : 1,
  "durationUnit"   : "hour",
  "recurrenceRule" : "FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR"
}
```
https://bryntum.com/products/taskboard/docs-llm/api/Scheduler/model/EventModel.mdwebsitellms
Overview of StoreSearch Mixin
The StoreSearch mixin extends a Store to provide capabilities for searching multiple records (returning all hits) and finding single records based on specific criteria.
https://bryntum.com/products/taskboard/docs-llm/api/Core/data/mixin/StoreSearch.mdwebsitellms
Overview of the Field base class
The Field class is the base class for all input fields in the Bryntum framework. It is not intended to be used directly. Instead, developers should use its subclasses, which are commonly used as editors for Column components. Popular subclasses include TextField, NumberField, DateField, TimeField, and Combo.
https://bryntum.com/products/taskboard/docs-llm/api/Core/widget/Field.mdwebsitellms
Overview of StoreTree Mixin
The StoreTree mixin adds tree-related functionality to a store. It allows the store to handle hierarchical data, manage parent-child relationships, and perform tree operations like indenting and outdenting nodes. For node-level operations, use the TreeNode class.
https://bryntum.com/products/taskboard/docs-llm/api/Core/data/mixin/StoreTree.mdwebsitellms
Overview of MentionTextField
MentionTextField is a contenteditable div with built-in mention/tagging support. When a user types a trigger character (default @) followed by at least one character, the component performs a search via a configured searchFn. Matching results are displayed in a dropdown, and selecting a result inserts an inline mention element into the field. This class is primarily used internally by AIChatPanelMixin.
https://bryntum.com/products/taskboard/docs-llm/api/Core/widget/chat/MentionTextField.mdwebsitellms
Overview of RecurringTimeSpansMixin
The RecurringTimeSpansMixin is a mixin that adds recurrence functionality to a store containing TimeSpan models. It manages the generation and tracking of recurring event occurrences based on recurrence rules.
https://bryntum.com/products/taskboard/docs-llm/api/Scheduler/data/mixin/RecurringTimeSpansMixin.mdwebsitellms
Overview of PickerField
PickerField is a base class used for creating input fields that display an anchored picker (such as a List or DatePicker). It is the foundation for specialized fields like Combo, DateField, and TimeField. Subclasses of PickerField can be used as editors for Grid Columns.
On tablet devices, tapping the trigger element (e.g., the down arrow) will not show the keyboard by default to facilitate interaction with the dropdown; a second tap on the input area is required to show the keyboard.
https://bryntum.com/products/taskboard/docs-llm/api/Core/widget/PickerField.mdwebsitellms
Overview of DayIndexMixin
DayIndexMixin is a mixin used to handle calendar day indices, allowing for the efficient retrieval of events by date. It is consumed by the EventStore in Scheduler and Scheduler Pro, as well as the TaskStore in Gantt.
https://bryntum.com/products/taskboard/docs-llm/api/Scheduler/data/mixin/DayIndexMixin.mdwebsitellms
Overview of AjaxHelper utility class
AjaxHelper is a static utility class that simplifies making Ajax requests using the browser's Fetch API. It provides convenience methods for common HTTP verbs and returns standard Response promises extended with Bryntum-specific properties.
https://bryntum.com/products/taskboard/docs-llm/api/Core/helper/AjaxHelper.mdwebsitellms
Overview of the DatePicker widget
The DatePicker is a Panel widget that displays a month of date cells. It allows users to navigate between months/years, select dates, and optionally view additional information per date cell. It is the default picker used by the DateField class.
https://bryntum.com/products/taskboard/docs-llm/api/Core/widget/DatePicker.mdwebsitellms
Overview of StringHelper utility class
StringHelper is a static utility class that provides common string manipulation methods such as HTML encoding, camelCase conversion, regular expression escaping, and markdown-to-HTML processing.
```
StringHelper.encodeHtml('<script>alert("xss")</script>'); // '<script>alert("xss")</script>'
StringHelper.capitalize('hello'); // 'Hello'
StringHelper.hyphenate('fontSize'); // 'font-size'
```
https://bryntum.com/products/taskboard/docs-llm/api/Core/helper/StringHelper.mdwebsitellms