Skip to content
Merged

Next #52

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/guides/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ const list = new ToDo("#root", {

Subscribe to drag events to track the drag-n-drop lifecycle:

- [`start-drag`](api/events/startdrag_event.md) fires when the user starts dragging tasks; provides the source task id and the mode (`"move"` or `"copy"`)
- [`drag`](api/events/drag_event.md) fires while the user drags tasks
- [`end-drag`](api/events/enddrag_event.md) fires when the drag completes; provides the target id, drop position (`"top"`, `"bottom"`, `"in"`, or `null`), and the mode
- [`start-drag`](api/events/startdrag_event.md) - fires when the user starts dragging tasks; provides the source task id and the mode (`"move"` or `"copy"`)
- [`drag`](api/events/drag_event.md) - fires while the user drags tasks
- [`end-drag`](api/events/enddrag_event.md) - fires when the drag completes; provides the target id, drop position (`"top"`, `"bottom"`, `"in"`, or `null`), and the mode

The snippet below logs the start and end of a drag operation:

Expand Down Expand Up @@ -186,8 +186,8 @@ The To Do List tracks the history of changes by default. Users can revert and re

Use the [`history`](api/configs/history_config.md) property to configure this behavior. The property accepts a boolean (short form) or an object with extended settings:

- `projects` enable branching of history so that each project keeps a separate history; the whole app shares one history when set to `false`
- `limit` maximum number of history operations to keep
- `projects` - enable branching of history so that each project keeps a separate history; the whole app shares one history when set to `false`
- `limit` - maximum number of history operations to keep

The example below limits history to 20 operations and disables per-project branching:

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/inline_editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Use hashtags to categorize tasks and make them more searchable. Follow these rul

- a hashtag combines the `#` symbol with letters and numbers (for example, `#sport`)
- to create a hashtag, enter `#` followed by at least one symbol (for example, `#t`) and press Enter
- the To Do List supports an unlimited number of hashtags — separate them by spaces (for example, `#tag #tag1`)
- the To Do List supports an unlimited number of hashtags, separated by spaces (for example, `#tag #tag1`)
- all hashtags are accessible in all projects
- to view the list of hashtags, enter the `#` symbol
- to add a hashtag to a task, click it in the list
Expand All @@ -38,7 +38,7 @@ Create a default list of tags through the [`tags`](api/configs/tags_config.md) p

### Dates

To enter a date through the inline editor, type the `!` symbol — the built-in date picker appears on the page.
To enter a date through the inline editor, type the `!` symbol. The built-in date picker appears on the page.

You can also wrap text in the special symbols `!()`. For example, type `!(Enter Booking date)` and press Enter to close the editor. Click this text later to reopen the date picker.

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/integration_with_angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Create an Angular component to add the To Do List with the Toolbar into the appl

Open *todo.component.ts* and import the To Do List source files. Choose one of two import paths:

- PRO version installed from a local folder import from `dhx-todolist-package`
- trial version import from `@dhx/trial-todolist`
- PRO version installed from a local folder - import from `dhx-todolist-package`
- trial version - import from `@dhx/trial-todolist`

The following snippet imports from the PRO package:

Expand Down Expand Up @@ -366,7 +366,7 @@ platformBrowserDynamic()
.catch((err) => console.error(err));
~~~

Start the app — the To Do List renders with sample data:
Start the app. The To Do List renders with sample data:

![DHTMLX To Do List rendered in an Angular application with sample data](/img/trial_todolist.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/integration_with_react.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Create a React component to add the To Do List with the Toolbar into the applica

Open *ToDo.jsx* and import the To Do List source files. Choose one of two import paths:

- PRO version installed from a local folder import from `dhx-todolist-package`
- trial version import from `@dhx/trial-todolist`
- PRO version installed from a local folder - import from `dhx-todolist-package`
- trial version - import from `@dhx/trial-todolist`

The example below imports from the PRO package:

Expand Down Expand Up @@ -330,7 +330,7 @@ function App() {
export default App;
~~~

Start the app — the To Do List renders with sample data:
Start the app. The To Do List renders with sample data:

![DHTMLX To Do List rendered in a React application with sample data](/img/trial_todolist.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/integration_with_svelte.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ Create a Svelte component to add the To Do List with the Toolbar into the applic

Open *ToDo.svelte* and import the To Do List source files. Choose one of two import paths:

- PRO version installed from a local folder import from `dhx-todolist-package`
- trial version import from `@dhx/trial-todolist`
- PRO version installed from a local folder - import from `dhx-todolist-package`
- trial version - import from `@dhx/trial-todolist`

The example below imports from the PRO package:

Expand Down Expand Up @@ -320,7 +320,7 @@ const { users, tasks, projects } = getData();
<ToDo {users} {tasks} {projects} />
~~~

Start the app — the To Do List renders with sample data:
Start the app. The To Do List renders with sample data:

![DHTMLX To Do List rendered in a Svelte application with sample data](/img/trial_todolist.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/integration_with_vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ Create a Vue component to add the To Do List with the Toolbar into the applicati

Open *ToDo.vue* and import the To Do List source files. Choose one of two import paths:

- PRO version installed from a local folder import from `dhx-todolist-package`
- trial version import from `@dhx/trial-todolist`
- PRO version installed from a local folder - import from `dhx-todolist-package`
- trial version - import from `@dhx/trial-todolist`

The example below imports from the PRO package:

Expand Down Expand Up @@ -342,7 +342,7 @@ export default {
</template>
~~~

Start the app — the To Do List renders with sample data:
Start the app. The To Do List renders with sample data:

![DHTMLX To Do List rendered in a Vue application with sample data](/img/trial_todolist.png)

Expand Down
12 changes: 6 additions & 6 deletions docs/guides/keyboard_navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The following shortcuts work when the inline editor is **closed**.
| <kbd>ArrowLeft</kbd> | Collapses an expanded parent task. If already collapsed or no children, moves selection to the parent |
| <kbd>Shift</kbd>+<kbd>ArrowUp</kbd> | Extends selection to the task above. If that task is already selected, deselects it |
| <kbd>Shift</kbd>+<kbd>ArrowDown</kbd> | Extends selection to the task below (including its children). If that task is already selected, deselects it |
| <kbd>Ctrl(Cmd)</kbd>+<kbd>Click</kbd> / <kbd>Ctrl(Cmd)</kbd>+<kbd>Shift</kbd>+<kbd>Click</kbd> | Selects or deselects multiple tasks together with their children:<br/>• if the task has selected parentsdeselects the task and its parents<br/>• if the task has selected children deselects only the task itself |
| <kbd>Ctrl(Cmd)</kbd>+<kbd>Click</kbd> / <kbd>Ctrl(Cmd)</kbd>+<kbd>Shift</kbd>+<kbd>Click</kbd> | Selects or deselects multiple tasks together with their children:<br/>• if the task has selected parents, deselects the task and its parents<br/>• if the task has selected children, deselects only the task itself |
| <kbd>Shift</kbd>+<kbd>Click</kbd> | Selects a range of tasks between the currently selected task and the clicked task |

:::info
Expand All @@ -47,8 +47,8 @@ To learn more about working with multiple selected tasks, see the [Multiselectio
| <kbd>Ctrl(Cmd)</kbd>+<kbd>Enter</kbd> | Opens the inline editor for the selected task |
| <kbd>Space</kbd> | Marks the selected task as complete. If already complete, marks it as incomplete |
| <kbd>Delete</kbd> / <kbd>Backspace</kbd> | Removes the selected task. After removal, selection moves down to the next task, or up to the parent task if no next task exists |
| <kbd>Tab</kbd> | Demotes the task — moves it one nesting level deeper |
| <kbd>Shift</kbd>+<kbd>Tab</kbd> | Promotes the task — moves it one nesting level up |
| <kbd>Tab</kbd> | Demotes the task, moving it one nesting level deeper |
| <kbd>Shift</kbd>+<kbd>Tab</kbd> | Promotes the task, moving it one nesting level up |
| <kbd>Ctrl</kbd>+<kbd>ArrowUp</kbd> | Moves the selected task up within the same level |
| <kbd>Ctrl</kbd>+<kbd>ArrowDown</kbd> | Moves the selected task down within the same level |
| <kbd>Ctrl(Cmd)</kbd>+<kbd>D</kbd> | Duplicates the selected task at the same level |
Expand All @@ -72,6 +72,6 @@ The following shortcuts work when the inline editor is **open**.

## Related articles

- [`keypress-on-todo`](api/events/keypressontodo_event.md) event intercept key presses and implement custom behavior
- [Inline editing](guides/inline_editing.md) learn how to manage the editor programmatically
- [Multiselection](guides/multiselection.md) work with multiple selected tasks
- [`keypress-on-todo`](api/events/keypressontodo_event.md) event - intercept key presses and implement custom behavior
- [Inline editing](guides/inline_editing.md) - learn how to manage the editor programmatically
- [Multiselection](guides/multiselection.md) - work with multiple selected tasks
12 changes: 6 additions & 6 deletions docs/guides/loading_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ description: You can learn about loading and storing data in the documentation o

DHTMLX To Do List accepts the following types of data through its configuration properties:

- [`tasks`](api/configs/tasks_config.md) list of tasks
- [`projects`](api/configs/projects_config.md) list of projects
- [`users`](api/configs/users_config.md) list of users
- [`priorities`](api/configs/priorities_config.md) list of priorities
- [`tags`](api/configs/tags_config.md) list of tags
- [`activeProject`](api/configs/activeproject_config.md) id of the active project
- [`tasks`](api/configs/tasks_config.md) - list of tasks
- [`projects`](api/configs/projects_config.md) - list of projects
- [`users`](api/configs/users_config.md) - list of users
- [`priorities`](api/configs/priorities_config.md) - list of priorities
- [`tags`](api/configs/tags_config.md) - list of tags
- [`activeProject`](api/configs/activeproject_config.md) - id of the active project

Prepare data in a separate file. The example below returns a data set with tasks, projects, users, and priorities:

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ const en = {

To initialize the To Do List component in a non-English language:

- define the language settings — provide translations for all text labels
- define the language settings by providing translations for all text labels
- apply the locale to the To Do List component and its Toolbar through the `locale` configuration property

The example below declares a German locale object:
Expand Down Expand Up @@ -150,7 +150,7 @@ To create a custom locale, copy the [default English locale](#default-locale) an
- Russian (`ru`)
- Spanish (`es`)

The files do not include translations for the Calendar labels add them yourself.
The files do not include translations for the Calendar labels, so add them yourself.
:::

The snippet below applies the `de` locale to the To Do List and the Toolbar:
Expand Down
18 changes: 9 additions & 9 deletions docs/guides/multiselection.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ console.log(list.getSelection()); // ["1.1", "1.2", "2.2"]

Use the [`selectTask()`](api/methods/selecttask_method.md) method to select tasks after initialization. The method takes two parameters:

- `id` id of the task to select
- `join` whether to add the task to the existing selection
- `id` - id of the task to select
- `join` - whether to add the task to the existing selection

### Select one task

Expand Down Expand Up @@ -131,7 +131,7 @@ Enable the `sorted` parameter to get IDs of the selected tasks in the order they

After selecting multiple tasks, apply operations to all of them at once.

The library provides the [`eachSelected()`](api/methods/eachselected_method.md) method to iterate over all selected tasks. The method takes additional parameters`sorted` and `reversed` that control sorting and iteration direction.
The library provides the [`eachSelected()`](api/methods/eachselected_method.md) method to iterate over all selected tasks. The method takes additional parameters, `sorted` and `reversed`, that control sorting and iteration direction.

The example below deletes all selected tasks:

Expand All @@ -145,12 +145,12 @@ list.eachSelected(id => {

You can perform the following bulk operations over multiple selected tasks through API methods:

- [`copyTask()`](api/methods/copytask_method.md) copy tasks
- [`pasteTask()`](api/methods/pastetask_method.md) paste tasks
- [`moveTask()`](api/methods/movetask_method.md) move tasks
- [`deleteTask()`](api/methods/deletetask_method.md) delete tasks
- [`checkTask()`](api/methods/checktask_method.md), [`uncheckTask()`](api/methods/unchecktask_method.md) mark tasks complete or incomplete
- [`indentTask()`](api/methods/indenttask_method.md), [`unindentTask()`](api/methods/unindenttask_method.md) demote or promote the nesting level of tasks
- [`copyTask()`](api/methods/copytask_method.md) - copy tasks
- [`pasteTask()`](api/methods/pastetask_method.md) - paste tasks
- [`moveTask()`](api/methods/movetask_method.md) - move tasks
- [`deleteTask()`](api/methods/deletetask_method.md) - delete tasks
- [`checkTask()`](api/methods/checktask_method.md), [`uncheckTask()`](api/methods/unchecktask_method.md) - mark tasks complete or incomplete
- [`indentTask()`](api/methods/indenttask_method.md), [`unindentTask()`](api/methods/unindenttask_method.md) - demote or promote the nesting level of tasks

## Reset selection

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/sorting_filtering_tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: You can learn about sorting and filtering of tasks in the documenta

After initialization, sort tasks in one of two ways:

- through the **Sort by** option of the [Toolbar menu](/#toolbar) sort tasks by *text*, *due date*, *completion date*, *creation date*, or *editing date*
- through the [`setSort()`](api/methods/setsort_method.md) method specify a custom sort function or sort by a [task attribute](api/configs/tasks_config.md#parameters)
- through the **Sort by** option of the [Toolbar menu](/#toolbar) - sort tasks by *text*, *due date*, *completion date*, *creation date*, or *editing date*
- through the [`setSort()`](api/methods/setsort_method.md) method - specify a custom sort function or sort by a [task attribute](api/configs/tasks_config.md#parameters)

The example below sorts tasks by id in ascending order:

Expand All @@ -28,7 +28,7 @@ list.setSort({
Filter tasks in one of two ways:

- through the [search bar](/#toolbar) of the Toolbar
- through the [`setFilter()`](api/methods/setfilter_method.md) method supports the *strict* mode for exact-match filtering
- through the [`setFilter()`](api/methods/setfilter_method.md) method - supports the *strict* mode for exact-match filtering

The snippet below filters tasks by a specific hashtag in strict mode:

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/stylization.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,4 @@ The snippet below applies a custom style to the To Do List:

## Related articles

- [Customization](guides/customization.md) overview of available customization options
- [Customization](guides/customization.md) - overview of available customization options
2 changes: 1 addition & 1 deletion docs/guides/task_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: You can learn about managing tasks in the documentation of the DHTM
To configure tasks, use the [`tasks`](api/configs/tasks_config.md) property of the To Do List.
:::

These guides cover the To Do List API for tasks getting task objects, navigating task hierarchy, running CRUD operations, and managing multiple selected tasks.
These guides cover the To Do List API for tasks: getting task objects, navigating task hierarchy, running CRUD operations, and managing multiple selected tasks.

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
Expand Down
14 changes: 7 additions & 7 deletions docs/guides/task_operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ list.addTask({

The quickest way to copy and paste a task is the [`copyTask()`](api/methods/copytask_method.md) method. Pass the following parameters:

- `id` id of the task to copy and paste
- `project` id of the target project, if it exists
- `targetId` id of the target task where the copied task is pasted
- `id` - id of the task to copy and paste
- `project` - id of the target project, if it exists
- `targetId` - id of the target task where the copied task is pasted
- other parameters are optional

The snippet below copies a task into a new project:
Expand Down Expand Up @@ -140,8 +140,8 @@ list.expandTask({ id: "1.1" });

Each task and user has a context menu. Track its activity with two events:

- [`open-menu`](api/events/openmenu_event.md) fires when the menu opens; provides the item id, the menu type, and optionally an array of task ids (`source`) for batch operations
- [`close-menu`](api/events/closemenu_event.md) fires when the menu closes; provides the item id and the menu type
- [`open-menu`](api/events/openmenu_event.md) - fires when the menu opens; provides the item id, the menu type, and optionally an array of task ids (`source`) for batch operations
- [`close-menu`](api/events/closemenu_event.md) - fires when the menu closes; provides the item id and the menu type

The example below logs menu lifecycle events:

Expand Down Expand Up @@ -193,8 +193,8 @@ list.uncheckTask({

Change the nesting level of a task dynamically through the following methods:

- [`indentTask()`](api/methods/indenttask_method.md) demote the nesting level of a task by one
- [`unindentTask()`](api/methods/unindenttask_method.md) promote the nesting level of a task by one
- [`indentTask()`](api/methods/indenttask_method.md) - demote the nesting level of a task by one
- [`unindentTask()`](api/methods/unindenttask_method.md) - promote the nesting level of a task by one

The snippet below demotes a task one level deeper:

Expand Down
Loading
Loading