Skip to content
Open
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
132 changes: 62 additions & 70 deletions docs/guides/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,75 +6,77 @@ description: You can learn about the configuration in the documentation of the D

# Configuration

You can configure the *Kanban* appearance and functionality via the corresponding API. The available parameters will allow you to:

- configure the cards appearance via the [`cardShape`](api/config/js_kanban_cardshape_config.md) property
- configure the editor fields via the [`editorShape`](api/config/js_kanban_editorshape_config.md) property
- configure the editor behaviour via the [`editor`](api/config/js_kanban_editor_config.md) property
- configure rendering and scrolling via the [`renderType`](api/config/js_kanban_rendertype_config.md) and [`scrollType`](api/config/js_kanban_scrolltype_config.md) properties
- configure the Kanban history via the [`history`](api/config/js_kanban_history_config.md) property
- customize the card appearance via the [`cardTemplate`](api/config/js_kanban_cardtemplate_config.md) property
Configure *Kanban* appearance and behavior through its API:

- configure card appearance via [`cardShape`](api/config/js_kanban_cardshape_config.md)
- configure editor fields via [`editorShape`](api/config/js_kanban_editorshape_config.md)
- configure editor behavior via [`editor`](api/config/js_kanban_editor_config.md)
- configure rendering and scrolling via [`renderType`](api/config/js_kanban_rendertype_config.md) and [`scrollType`](api/config/js_kanban_scrolltype_config.md)
- configure Kanban history via [`history`](api/config/js_kanban_history_config.md)
- customize card appearance via [`cardTemplate`](api/config/js_kanban_cardtemplate_config.md)
- *Refer to the [**Customization**](guides/customization.md) section for details!*
- apply the desired locale via the [`locale`](api/config/js_kanban_locale_config.md) property
- apply the desired locale via [`locale`](api/config/js_kanban_locale_config.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Странно, что убирает слово property. Хотя оно не несет никакой смысловой нагрузки здесь по сути.

- *Refer to the [**Localization**](guides/localization.md) section for details!*
- load data for cards, columns, rows and links via the corresponding [`cards`](api/config/js_kanban_cards_config.md), [`columns`](api/config/js_kanban_columns_config.md), [`rows`](api/config/js_kanban_rows_config.md) and [`links`](api/config/js_kanban_links_config.md) properties
- load data for cards, columns, rows, and links via [`cards`](api/config/js_kanban_cards_config.md), [`columns`](api/config/js_kanban_columns_config.md), [`rows`](api/config/js_kanban_rows_config.md), and [`links`](api/config/js_kanban_links_config.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Запятую исправил верно

- *Refer to the [**Working with data**](guides/working_with_data.md) section for details!*

## Cards

The board of Kanban consists of the *cards* distributed into *columns* and *rows*. You can configure the cards appearance using the [`cardShape`](api/config/js_kanban_cardshape_config.md) configuration property. There are several predefined fields you can include (or exclude) into the card template, namely:
The Kanban board distributes *cards* across *columns* and *rows*. Use [`cardShape`](api/config/js_kanban_cardshape_config.md) to control which predefined fields appear on each card:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Мне кажется неплохо испраивил - смысл сохранил при менее громоздком тексте


- a card label via the `label: boolean` config
- a card description via the `description: boolean` config

:::tip
You can manage the **label** and **description** fields of any card via the corresponding inputs of the Kanban editor. If you activate these fields, the corresponding inputs will be displayed in the editor automatically. To configure these inputs, you can use the [**text** and **textarea**](#text-and-textarea-types) types.
Activate **label** and **description** to show matching inputs in the editor. Configure these inputs with the [**text** and **textarea**](#using-text-and-textarea-fields) types.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Здесь мне не оч нравится. Оригинал понятнее. Надо подумать, что добавить в скилл

:::

- a card progress via the `progress: boolean` config

:::tip
You can manage the **progress** field of any card via the corresponding control of the Kanban editor. If you activate this field, the corresponding control will be displayed in the editor automatically. To configure this control, you can use the [**progress**](#progress-type) type.
Activating **progress** adds a progress control to the editor automatically. Configure it with the [**progress**](#using-the-progress-field) type.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Совсем неудачно

:::

- a start date via the `start_date: boolean` config
- an end date via the `end_date: boolean` config

:::tip
You can manage the **start date** and **end date** fields of any card via the corresponding controls of the Kanban editor. If you activate these fields, the corresponding controls will be displayed in the editor automatically. To configure these controls, you can use the [**date**](#date-and-daterange-types) type.
The editor shows date controls for **start date** and **end date** when you activate these fields. Configure the controls with the [**date**](#using-date-and-daterange-fields) type.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Лучше, но не совсем то

:::

- a card context menu via the `menu: boolean` config
- a card attachment via the `attached: boolean` config

:::tip
You can **attache files** to any card via the corresponding field of the Kanban editor. To configure this field, you can use the [**files**](#files-type) type.
To configure the file attachment field in the editor, use the [**files**](#using-the-file-upload-field) type.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

file attachment - такое себе

:::

- a card color via the `color: boolean` config

:::tip
You can manage the **top color line** of any card via the corresponding control of the Kanban editor. If you activate **color**, the corresponding control (*colorpicker*) will be displayed in the editor automatically. To configure this control, you can use the [**color**](#color-type) type.
Activating **color** adds a colorpicker to the editor automatically. Configure it with the [**color**](#using-the-color-field) type.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Герундиц здесь плох

:::

- a card cover (*preview image*) via the `cover: boolean` config
- a card comment(s) via the `comments: boolean` config
- a confirmation dialog to confirm or decline the card deletion via the `confirmDeletion: boolean` config
- a card vote(s) via the `votes: boolean | { show: boolean, clicable: true }` config
- a card assignment (users) via the `users: boolean | { show: boolean, values: object, maxCount: number | false }` config
- card comments via the `comments: boolean` config
- a confirmation dialog for card deletion via the `confirmDeletion: boolean` config
- card votes via the `votes: boolean | { show: boolean, clicable: true }` config
- card assignment (users) via the `users: boolean | { show: boolean, values: object, maxCount: number | false }` config

:::tip
You can assign one or several users to any card via the corresponding control of the Kanban editor. To configure the control for assigning a single user, use the [**combo** or **select**](#combo-select-and-multiselect-types) types of editor. To assign multiple users, use the [**multiselect**](#combo-select-and-multiselect-types) type.
To assign a single user, configure the editor control with [**combo** or **select**](#using-combo-select-and-multiselect-fields). For multiple users, use [**multiselect**](#using-combo-select-and-multiselect-fields).
Copy link
Copy Markdown
Contributor

@tbshag2 tbshag2 Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Здесь неплохо кроме For multiple users, use

:::

- a card priority via the `priority: boolean | { show: boolean, values: object }` config

:::tip
You can manage the **priority** of any card via the corresponding control of the Kanban editor. If you activate **priority**, the corresponding control will be displayed in the editor automatically. To configure this control, you can use the [**combo** or **select**](#combo-select-and-multiselect-types) types only.
Activating **priority** adds a select control to the editor automatically. Configure it with [**combo** or **select**](#using-combo-select-and-multiselect-fields) only.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ТОже герундий заюзал (плохо) и оригинал лучше по смыслу

:::

- *a custom field* via the `headerFields: [ { key: string, label: string, css: string } ]` config

Pass `cardShape` to the constructor along with your card and column data:

~~~jsx {12-35,42}
const users = [ // users data
{ id: 1, label: "John Smith", avatar: "../assets/user.jpg" },
Expand Down Expand Up @@ -113,38 +115,36 @@ const cardShape = { // cards settings
};

new kanban.Kanban("#root", {
// cards data
columns,
cards,
// cards settings
cardShape
});
~~~

:::note
Unless you specify the card settings via the [`cardShape`](api/config/js_kanban_cardshape_config.md) property, the widget will apply a [**defaultCardShape**](api/config/js_kanban_cardshape_config.md#default-config) set of parameters!
If you don't specify card settings via [`cardShape`](api/config/js_kanban_cardshape_config.md), the widget applies [**defaultCardShape**](api/config/js_kanban_cardshape_config.md#default-config).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Исправил unless +

:::

## Editor

:::info
You can display the Editor as the **sidebar** or **modal window** using the [`editor.placement`](api/config/js_kanban_editor_config.md) property!
Display the Editor as a **sidebar** or **modal window** using the [`editor.placement`](api/config/js_kanban_editor_config.md) property!
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Надо все же добавить ему четко, как interaction with user должно выражаться

:::

The *Editor* of Kanban consists of the fields for managing the cards data. To configure the editor fields (controls), you can use the [`editorShape`](api/config/js_kanban_editorshape_config.md) property. You can use the following types of editor fields:
The editor consists of fields for managing card data. Configure editor fields with [`editorShape`](api/config/js_kanban_editorshape_config.md). The supported field types are:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Плохо


- [**combo**, **select**, and **multiselect**](#combo-select-and-multiselect-types)
- [**color**](#color-type)
- [**text** and **textarea**](#text-and-textarea-types)
- [**progress**](#progress-type)
- [**files**](#files-type)
- [**date** and **dataRange**](#date-and-daterange-types)
- [**comments**](#comments-type)
- [**links**](#links-type)
- [**combo**, **select**, and **multiselect**](#using-combo-select-and-multiselect-fields)
- [**color**](#using-the-color-field)
- [**text** and **textarea**](#using-text-and-textarea-fields)
- [**progress**](#using-the-progress-field)
- [**files**](#using-the-file-upload-field)
- [**date** and **dateRange**](#using-date-and-daterange-fields)
- [**comments**](#using-the-comments-field)
- [**links**](#using-the-links-field)

### Combo, Select and Multiselect types
### Using combo, select, and multiselect fields
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Надо добавить ему, чтоб различал, где надо а где не надо добавлять действие к заголовкам


The editor fields of **combo**, **select**, and **multiselect** types can be set in the following way:
Pass the field type and options array to each `editorShape` entry:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Здесь вроде по делу


~~~jsx {3-12}
new kanban.Kanban("#root", {
Expand All @@ -165,7 +165,7 @@ new kanban.Kanban("#root", {
~~~

:::info
For the editor field of **"multiselect"** and **"combo"** types you can also specify a path to the preview image via the **avatar** property:
For **multiselect** and **combo** fields, specify a path to the preview image via the **avatar** property:

~~~jsx {3,9,13}
editorShape: [
Expand All @@ -191,9 +191,9 @@ editorShape: [
[**Kanban. Limiting assignments to one user only**](https://snippet.dhtmlx.com/2rlg4qvk?tag=kanban)
:::

### Color type
### Using the color field

The editor field of **color** type can be set in the following way:
Specify the allowed color values and optional picker config:

~~~jsx {3-12}
new kanban.Kanban("#root", {
Expand All @@ -213,9 +213,9 @@ new kanban.Kanban("#root", {
});
~~~

### Text and Textarea types
### Using text and textarea fields

The editor fields of **text** and **textarea** types can be set in the following way:
Configure text inputs with placeholder, focus, and style options:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Здесь лучше чем в оригинале


~~~jsx {3-14}
new kanban.Kanban("#root", {
Expand All @@ -237,9 +237,9 @@ new kanban.Kanban("#root", {
});
~~~

### Progress type
### Using the progress field

The editor field of **progress** type can be set in the following way:
Set `min`, `max`, and `step` to control the progress slider range:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

В общем комменты к коду вроде неплохо


~~~jsx {3-12}
new kanban.Kanban("#root", {
Expand All @@ -259,9 +259,7 @@ new kanban.Kanban("#root", {
});
~~~

### Files type

The editor field of **files** type can be set in the following way:
### Using the file upload field

#### Configuring Upload Url as String

Expand Down Expand Up @@ -324,9 +322,9 @@ new kanban.Kanban("#root", {
});
~~~

### Date and DateRange types
### Using date and dateRange fields

The editor field of **date** type can be set in the following way:
Specify a date format for the field:

~~~jsx {3-8}
new kanban.Kanban("#root", {
Expand All @@ -342,7 +340,7 @@ new kanban.Kanban("#root", {
});
~~~

The editor field of **dateRange** type can be set in the following way:
Use `dateRange` to bind start and end dates to a single control:

~~~jsx {3-11}
new kanban.Kanban("#root", {
Expand All @@ -361,9 +359,9 @@ new kanban.Kanban("#root", {
});
~~~

### Comments type
### Using the comments field

The editor field of **comments** type can be set in the following way:
Configure comment display, date format, and placement:

~~~jsx {3-13}
new kanban.Kanban("#root", {
Expand All @@ -384,9 +382,9 @@ new kanban.Kanban("#root", {
});
~~~

### Links type
### Using the links field

The editor field of **links** type can be set in the following way:
Add a links field to let users create card dependencies:

~~~jsx {3-10}
new kanban.Kanban("#root", {
Expand All @@ -407,7 +405,7 @@ new kanban.Kanban("#root", {
### Binding editor fields to card fields

:::info
To link the editor field to the corresponding card field, you need to provide special **key** in the object of [`editorShape`](api/config/js_kanban_editorshape_config.md) property (`key: "editor_field_key"`). The value of this key needs to be set to *true* in the [`cardShape`](api/config/js_kanban_cardshape_config.md) property (for built-in card fields) or specified in the **headerFields** array (for custom card fields). You can provide the initial data of any field via this key as well.
To link an editor field to the corresponding card field, add a **key** to the field object in [`editorShape`](api/config/js_kanban_editorshape_config.md). For built-in card fields, set the matching key to *true* in [`cardShape`](api/config/js_kanban_cardshape_config.md). For custom fields, add the key to the **headerFields** array. The key also sets the field's initial data value.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Инструкции вроде неплохо исправляет


~~~jsx {5,13,22,25,33-34,38-39,45-47}
// editor settings
Expand Down Expand Up @@ -464,18 +462,17 @@ new kanban.Kanban("#root", {
:::

:::note
Unless you specify the editor settings via the [`editorShape`](api/config/js_kanban_editorshape_config.md) property, the widget will apply a [**defaultEditorShape**](api/config/js_kanban_editorshape_config.md#default-config) set of parameters. In this case, the default controls and inputs will be displayed in editor only after activating the corresponding fields of cards via the [`cardShape`](api/config/js_kanban_cardshape_config.md) property.
If you don't specify editor settings via [`editorShape`](api/config/js_kanban_editorshape_config.md), the widget applies [**defaultEditorShape**](api/config/js_kanban_editorshape_config.md#default-config). Default controls appear in the editor only after you activate the corresponding card fields via [`cardShape`](api/config/js_kanban_cardshape_config.md).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Здесь тоже хорошо справился. unless заменил и will тоже. activation - на you activate +

:::

### Configuring the editor
### Configuring editor behavior

Using the [`editor`](api/config/js_kanban_editor_config.md) property, you can configure the editor in the following way:
Use the [`editor`](api/config/js_kanban_editor_config.md) property to control editor behavior:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • В инстуркции хорошо правит


- enables/disables an autosave mode of the editor via the *`editor.autoSave`* property
- specify a delay time of autosaving data via the *`editor.debounce`* property (works with the ***autoSave: true*** parameter only)
- enable autosave via `editor.autoSave`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

тоже емко поменял на нужное

- set the autosave delay via `editor.debounce` (requires `autoSave: true`)

~~~jsx {6-9}
// create Kanban
new kanban.Kanban("#root", {
columns,
cards,
Expand All @@ -490,28 +487,23 @@ new kanban.Kanban("#root", {

## Toolbar

**Toolbar** of Kanban consists of the searchbar for *searching cards* and controls for *sorting cards* and *adding new columns and rows*. To display Toolbar, you need to initialize it in a separate container using the **kanban.Toolbar()** constructor.
The **Toolbar** contains a search bar, sort controls, and buttons to add columns and rows. Initialize it in a separate container using the **kanban.Toolbar()** constructor:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Почему решил, что это именно buttons. Это buttons?


~~~jsx {13}
// create Kanban
const board = new kanban.Kanban("#root", {
// data
columns,
cards,
rows,
// card settings
cardShape,
// editor settings
editorShape
});

new kanban.Toolbar("#toolbar", { api: board.api });
~~~

You can manage (*hide/show/customize*) the Toolbar controls using the **items** property:
Use the **items** property to hide, show, or customize Toolbar controls:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


~~~jsx {6-51}
// create Kanban
const board = new kanban.Kanban("#root", {...});

new kanban.Toolbar("#toolbar", {
Expand Down Expand Up @@ -566,11 +558,11 @@ new kanban.Toolbar("#toolbar", {
~~~

:::tip
To hide some of the Toolbar controls, remove the corresponding string(s) from the **items** array.
To hide a Toolbar control, remove its string from the **items** array.
:::

## Example

In this snippet you can see how to configure the **Cards**, **Editor** and **Toolbar** of Kanban:
This snippet shows Cards, Editor, and Toolbar configured together:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Оригинал лучше


<iframe src="https://snippet.dhtmlx.com/5hcx01h4?mode=js&tag=kanban" frameborder="0" class="snippet_iframe" width="100%" height="600"></iframe>
12 changes: 7 additions & 5 deletions docs/guides/initialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: You can learn about the initialization in the documentation of the

# Initialization

This guide will give you detailed instructions on how to create Kanban on a page to enrich your application with features of the Kanban board. Take the following steps to get a ready-to-use component:
This guide covers how to add Kanban to a page. Take the following steps to get a ready-to-use component:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Это getting_started поэтому не сработал


1. [Include the Kanban source files on a page](#including-source-files).
2. [Create a container for Kanban](#creating-container).
Expand All @@ -21,7 +21,7 @@ To create Kanban, you need to include 2 source files on your page:
- *kanban.js*
- *kanban.css*

Make sure that you set correct relative paths to the source files:
Set correct relative paths to the source files:

~~~html title="index.html"
<script type="text/javascript" src="./dist/kanban.js"></script>
Expand Down Expand Up @@ -62,14 +62,16 @@ If you want to create the widget along with its *Toolbar*, you need to initializ
- an HTML container (the ID of the HTML container)
- an object with configuration properties

Pass a reference to the board's API when initializing the Toolbar:

~~~jsx {6-8} title="index.html"
// create Kanban
const board = new kanban.Kanban("#root", {
// configuration properties
});

new kanban.Toolbar("#toolbar", {
// configuration properties
api: board.api
});
~~~

Expand All @@ -80,12 +82,12 @@ To learn more about configuring the Toolbar of Kanban, read the [**Configuration
### Configuration properties

:::note
The full list of properties to configure **Kanban** can be found [**here**](api/overview/properties_overview.md). <br/>
The full list of properties to configure **Kanban** can be found [**here**](api/overview/properties_overview.md). <br/>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Плохо. Должен был заменить на что-то типа You can find the full list of properties for Kanban configuration here

The full list of properties to configure **Toolbar of Kanban** can be found [**here**](api/overview/toolbar_properties_overview.md).
:::

## Example

In this snippet you can see how to initialize **Kanban** with the initial data:
This snippet shows how to initialize **Kanban** with initial data:

<iframe src="https://snippet.dhtmlx.com/gb50vyip?mode=js&tag=kanban" frameborder="0" class="snippet_iframe" width="100%" height="500"></iframe>
Loading