Skip to content
Closed

Next #35

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
198 changes: 99 additions & 99 deletions docs/api/api_overview.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/configs/activeproject_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ const toolbar = new Toolbar("#toolbar", {
});
~~~

**Related article:** [Managing projects](guides/project_index.md)
**Related article:** [Managing projects](/guides/project_index/)
2 changes: 1 addition & 1 deletion docs/api/configs/drag_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ const toolbar = new Toolbar("#toolbar", {

**Change log:** Added in v1.1

**Related article:** [Configuration](guides/configuration.md#drag-n-drop)
**Related article:** [Configuration](/guides/configuration/#drag-n-drop)
6 changes: 3 additions & 3 deletions docs/api/configs/history_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: You can learn about the history config in the documentation of the
@short: Optional. Enables/disables managing the history of changes

:::info
Using the `history` property you can enable/disable managing the history of changes in To Do List. If you set the `history` property to `false`, you will not be able to manage the history of changes using [`undo()`](api/methods/undo_method.md)/[`redo()`](api/methods/redo_method.md) methods and controls on Toolbar.
Using the `history` property you can enable/disable managing the history of changes in To Do List. If you set the `history` property to `false`, you will not be able to manage the history of changes using [`undo()`](/api/methods/undo_method/)/[`redo()`](/api/methods/redo_method/) methods and controls on Toolbar.
:::

### Usage
Expand Down Expand Up @@ -67,5 +67,5 @@ new ToDo("#root", {
**Change log:** The `history` config was added in v1.3

**Related API:**
- [`redo`](api/methods/redo_method.md)
- [`undo`](api/methods/undo_method.md)
- [`redo`](/api/methods/redo_method/)
- [`undo`](/api/methods/undo_method/)
8 changes: 4 additions & 4 deletions docs/api/configs/locale_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ locale?: object;

### Default config

By default, DHTMLX To Do List uses [English locale](guides/localization.md#default-locale).
By default, DHTMLX To Do List uses [English locale](/guides/localization/#default-locale).

~~~js
locale: en
Expand All @@ -45,13 +45,13 @@ const toolbar = new Toolbar("#toolbar", {


:::info
The Toolbar is a separate component of To Do List . Thus, you also need to apply the necessary locale to the **Toolbar** via the related [`locale`](api/toolbar_api/configs/locale_config.md) property
The Toolbar is a separate component of To Do List . Thus, you also need to apply the necessary locale to the **Toolbar** via the related [`locale`](/api/toolbar_api/configs/locale_config/) property
:::

:::tip
To change the locale dynamically, use the [`setLocale()`](api/methods/setlocale_method.md) method
To change the locale dynamically, use the [`setLocale()`](/api/methods/setlocale_method/) method
:::

**Related article:** [Localization](guides/localization.md)
**Related article:** [Localization](/guides/localization/)

**Related sample:** [To do list. Localization](https://snippet.dhtmlx.com/kzjwvuq5)
8 changes: 4 additions & 4 deletions docs/api/configs/menu_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The callback should return one of the following values:
]
}
~~~
![Context menu item](../../assets/menu_item.png)
![Context menu item](/assets/menu_item.png)
</details>

- `"separator"` - the line for separating menu items
Expand Down Expand Up @@ -147,7 +147,7 @@ The callback should return one of the following values:
}
~~~

![Context menu item](../../assets/menu_priorities.png)
![Context menu item](/assets/menu_priorities.png)
</details>

- `"datepicker"` - the menu item intended for setting dates
Expand All @@ -166,7 +166,7 @@ The callback should return one of the following values:
}
~~~

![Context menu item](../../assets/menu_datepicker.png)
![Context menu item](/assets/menu_datepicker.png)
</details>

- `"user"` - the menu item intended for assigning users to tasks
Expand All @@ -187,7 +187,7 @@ The callback should return one of the following values:
}
~~~

![Context menu item](../../assets/menu_users.png)
![Context menu item](/assets/menu_users.png)
</details>

### Example
Expand Down
2 changes: 1 addition & 1 deletion docs/api/configs/priorities_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,6 @@ document.addEventListener("keydown", event => {
~~~

**Related articles:**
- [Loading and storing data](guides/loading_data.md)
- [Loading and storing data](/guides/loading_data/)

**Related sample:** [To do list. Custom hotkeys for setting priorities](https://snippet.dhtmlx.com/5cymicwt?tag=todolist)
6 changes: 3 additions & 3 deletions docs/api/configs/projects_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ const toolbar = new Toolbar("#toolbar", {
~~~

:::tip
By default, the first project from the list of project objects will be loaded as an active project. To specify any other project as an active one, use the [`activeProject`](api/configs/activeproject_config.md) property
By default, the first project from the list of project objects will be loaded as an active project. To specify any other project as an active one, use the [`activeProject`](/api/configs/activeproject_config/) property
:::

**Related articles:**
- [Loading and storing data](guides/loading_data.md)
- [Managing projects](guides/project_index.md)
- [Loading and storing data](/guides/loading_data/)
- [Managing projects](/guides/project_index/)
2 changes: 1 addition & 1 deletion docs/api/configs/readonly_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ const toolbar = new Toolbar("#toolbar", {
});
~~~

**Related article:** [Read-only mode](guides/readonly_mode.md)
**Related article:** [Read-only mode](/guides/readonly_mode/)
2 changes: 1 addition & 1 deletion docs/api/configs/selected_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ const toolbar = new Toolbar("#toolbar", {

**Change log:** Added in v1.1

**Related article:** [Multiple select and bulk operations](guides/multiselection.md)
**Related article:** [Multiple select and bulk operations](/guides/multiselection/)
4 changes: 2 additions & 2 deletions docs/api/configs/tags_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ const toolbar = new Toolbar("#toolbar", {
~~~

**Related articles:**
- [Loading and storing data](guides/loading_data.md)
- [Inline editing](guides/inline_editing.md)
- [Loading and storing data](/guides/loading_data/)
- [Inline editing](/guides/inline_editing/)
10 changes: 5 additions & 5 deletions docs/api/configs/tasks_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The **tasks** property presents an array of task objects. Each object includes t

- `id` - (optional) the id of a task
- `parent` - (optional) the id of the parent task. The value of the parameter is **null | undefined** for root tasks
- `project` - (optional) the id of the project where the task should be rendered. To initialize the projects, use the [projects](api/configs/projects_config.md) property.
- `project` - (optional) the id of the project where the task should be rendered. To initialize the projects, use the [projects](/api/configs/projects_config/) property.

:::info
If there are projects initialized, specify the ID of the necessary project for the root task to display it in this project.
Expand All @@ -50,12 +50,12 @@ If you don't specify the project ID for the root task or set it to *null* or *un
- `text` - (optional) the text of the task
- `checked` - (optional) marks the task as completed
- `collapsed` - (optional) defines whether the task is collapsed initially (in case the task has subtasks)
- `assigned` - (optional) an array with ID(s) of the people assigned to the task. To initialize the list of assignees, use the [users](api/configs/users_config.md) property.
- `assigned` - (optional) an array with ID(s) of the people assigned to the task. To initialize the list of assignees, use the [users](/api/configs/users_config/) property.
- `due_date` - (optional) the date when the task must be completed
- `creation_date` - (optional) the date of the task creation (auto-generated)
- `completion_date` - (optional) the date of the task completion (auto-generated when you mark a task as complete; auto-removed when you mark a task as incomplete)
- `edited_date` - (optional) the date of the task editing (auto-generated when you change the text of the task)
- `priority` - (optional) the priority of the task. To set the priorities, use the [priorities](api/configs/priorities_config.md) property
- `priority` - (optional) the priority of the task. To set the priorities, use the [priorities](/api/configs/priorities_config/) property
- `[key: string]`- (optional) a set of custom properties

### Example
Expand Down Expand Up @@ -115,5 +115,5 @@ const toolbar = new Toolbar("#toolbar", {
**Change log:** The `priority` parameter was added in v1.2

**Related articles:**
- [Loading and storing data](guides/loading_data.md)
- [Managing tasks](guides/task_index.md)
- [Loading and storing data](/guides/loading_data/)
- [Managing tasks](/guides/task_index/)
8 changes: 4 additions & 4 deletions docs/api/configs/taskshape_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ To configure the task's appearance, you can specify the following parameters in
- *"percentage"* - the value of the counter is displayed as a percentage
- `date` - (optional) an object with date settings:
- `format` - (required) defines the format of displaying dates. By default, "%d %M %Y". The full list of available characters is given [below](#list-of-characters)
- `validate` - (required) defines whether the **due_date** property of the [task object](api/configs/tasks_config.md) should be validated
- `validate` - (required) defines whether the **due_date** property of the [task object](/api/configs/tasks_config/) should be validated
- `completed` - (optional) an object with settings for managing the marking and display of completed tasks. It takes one parameter:
- `behavior` - (required) sets behavior for the parent and child tasks when marking them as completed/uncompleted. There are two options:
- *"auto"* - enables the **"auto"** mode:
Expand Down Expand Up @@ -131,7 +131,7 @@ DHTMLX To Do List uses the following characters for setting a date format:
| **%Y** | year as a number, 4 digits |

:::tip
Check the [**Localization**](guides/localization.md) article to learn how to present the date labels in the necessary language
Check the [**Localization**](/guides/localization/) article to learn how to present the date labels in the necessary language
:::

**Change log:**
Expand All @@ -140,8 +140,8 @@ Check the [**Localization**](guides/localization.md) article to learn how to pre

**Related articles:**

- [Configuration](guides/configuration.md#tasks)
- [Show/hide completed tasks](guides/hide_completed_tasks.md)
- [Configuration](/guides/configuration/#tasks)
- [Show/hide completed tasks](/guides/hide_completed_tasks/)

**Related samples:**
- [To do list. Subtask counter and date format](https://snippet.dhtmlx.com/magidhw8?tag=todolist)
Expand Down
4 changes: 2 additions & 2 deletions docs/api/configs/users_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,5 @@ const toolbar = new Toolbar("#toolbar", {
~~~

**Related articles:**
- [Loading and storing data](guides/loading_data.md)
- [Task users](guides/task_users.md)
- [Loading and storing data](/guides/loading_data/)
- [Task users](/guides/task_users/)
4 changes: 2 additions & 2 deletions docs/api/events/addproject_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The callback of the **add-project** event can take an object with the following
- `label` - (optional) the name of the project

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -53,4 +53,4 @@ list.api.on("add-project", ({id, project}) => {
});
~~~

**Related article:** [Operations with projects](guides/project_operations.md#adding-a-new-project)
**Related article:** [Operations with projects](/guides/project_operations/#adding-a-new-project)
4 changes: 2 additions & 2 deletions docs/api/events/addtask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The callback of the **add-task** event can take an object with the following par
- `task` - (required) the object of the added task

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -60,4 +60,4 @@ list.api.on("add-task", (obj) => {
});
~~~

**Related article:** [Operations with tasks](guides/task_operations.md#adding-a-new-task)
**Related article:** [Operations with tasks](/guides/task_operations/#adding-a-new-task)
4 changes: 2 additions & 2 deletions docs/api/events/assignuser_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The callback of the **assign-user** event can take an object with the following
- `userId` - (required) the id of the user assigned to the task

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -52,4 +52,4 @@ list.api.on("assign-user", ({id, userId}) => {
});
~~~

**Related article:** [Task users](guides/task_users.md)
**Related article:** [Task users](/guides/task_users/)
4 changes: 2 additions & 2 deletions docs/api/events/checktask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The callback of the **check-task** event can take an object with the following p
- `manual` - (optional) **true** if the task is marked as completed in the "manual" mode

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -52,4 +52,4 @@ list.api.on("check-task", ({id}) => {
});
~~~

**Related article:** [Operations with tasks](guides/task_operations.md#marking-a-task-completeincomplete)
**Related article:** [Operations with tasks](/guides/task_operations/#marking-a-task-completeincomplete)
6 changes: 3 additions & 3 deletions docs/api/events/clonetask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: You can learn about the clone-task event in the documentation of th

@short: Fires when a task is pasted from the clipboard into the specified position

The event fires after the [paste-task](api/events/pastetask_event.md) event
The event fires after the [paste-task](/api/events/pastetask_event/) event

### Usage

Expand All @@ -33,7 +33,7 @@ The callback of the **clone-task** event can take an object with the following p
- `batch` - (required) an array of objects that were created on copying and then pasted

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -58,4 +58,4 @@ list.api.on("clone-task", (obj) => {
});
~~~

**Related article:** [Operations with tasks](guides/task_operations.md#copyingpasting-a-task)
**Related article:** [Operations with tasks](/guides/task_operations/#copyingpasting-a-task)
4 changes: 2 additions & 2 deletions docs/api/events/closeinlineeditor_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The callback of the **close-inline-editor** event can take an object with the fo
- `save` - (required) **true** if the made changes have been saved after closing the editor; otherwise, **false**

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -52,4 +52,4 @@ list.api.on("close-inline-editor", ({id, save}) => {
});
~~~

**Related article:** [Inline editing](guides/inline_editing.md#working-with-editor)
**Related article:** [Inline editing](/guides/inline_editing/#working-with-editor)
4 changes: 2 additions & 2 deletions docs/api/events/collapsetask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The callback of the **collapse-task** event can take an object with the followin
- `id` - (required) the id of a task

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -50,4 +50,4 @@ list.api.on("collapse-task", ({id}) => {
});
~~~

**Related article:** [Operations with tasks](guides/task_operations.md#expandingcollapsing-a-task)
**Related article:** [Operations with tasks](/guides/task_operations/#expandingcollapsing-a-task)
4 changes: 2 additions & 2 deletions docs/api/events/copytask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ In case the copied task is also pasted from the clipboard into another position,
- `reverse` - (optional) **true**, if the copied task is pasted before the target task; otherwise, **false**

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -67,4 +67,4 @@ list.api.on("copy-task", ({id}) => {

**Change log:** The `join` parameter was added in v1.1

**Related article:** [Operations with tasks](guides/task_operations.md#copyingpasting-a-task)
**Related article:** [Operations with tasks](/guides/task_operations/#copyingpasting-a-task)
4 changes: 2 additions & 2 deletions docs/api/events/deleteproject_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The callback of the **delete-project** event can take an object with the followi
- `id` - (required) the ID of a project

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -50,4 +50,4 @@ list.api.on("delete-project", ({id}) => {
});
~~~

**Related article:** [Operations with projects](guides/project_operations.md#deleting-a-project)
**Related article:** [Operations with projects](/guides/project_operations/#deleting-a-project)
4 changes: 2 additions & 2 deletions docs/api/events/deletetask_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The callback of the **delete-task** event can take an object with the following
- `id` - (required) the ID of a removed task

:::info
To handle the inner events, you can use the [**Event Bus methods**](category/event-bus-methods.md)
To handle the inner events, you can use the [**Event Bus methods**](/category/event-bus-methods/)
:::

### Example
Expand All @@ -50,4 +50,4 @@ list.api.on("delete-task", ({id}) => {
});
~~~

**Related article:** [Operations with tasks](guides/task_operations.md#deleting-a-task)
**Related article:** [Operations with tasks](/guides/task_operations/#deleting-a-task)
Loading
Loading