Skip to content

[update] Edit the configuration guide manually#89

Open
serhiipylypchuk1991 wants to merge 1 commit intomasterfrom
sp-master-improve-guide
Open

[update] Edit the configuration guide manually#89
serhiipylypchuk1991 wants to merge 1 commit intomasterfrom
sp-master-improve-guide

Conversation

@serhiipylypchuk1991
Copy link
Copy Markdown
Contributor

Нужно поревювить эту версию изменений, сделанную вручную. Главный вопрос, устрит ли такой конечный результат?

- 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
You can configure the *Kanban* appearance and functionality via the following properties:
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.

Вроде решили, что лучше такой подход, который использовался здесь

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.

Там вроде решили про сам список. А не про первые два предложения

Copy link
Copy Markdown
Contributor

@mafanya23 mafanya23 Apr 3, 2026

Choose a reason for hiding this comment

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

Да, я про список. Не совсем понятно написала


:::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 the `label` parameter to show the corresponding input in the editor. Configure the editor field with the [`text` or `textarea`](#text-and-textarea-types) type.
Copy link
Copy Markdown
Contributor

@mafanya23 mafanya23 Apr 3, 2026

Choose a reason for hiding this comment

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

Мне кажется, чтобы избежать однотипности, можно во втором предложения использовать you can.. или to configure.. use.. (здесь и ниже). См. строку 72 для примера

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.

Мне кажется норм, т.к. это tip
Но можно и во втором You can configure
НО не to configure.. use.. (полeчится тогда точь-в-точь как в первом, только перевернуто activate.. to show)


:::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.
Activate the `users` parameter to show the assignment control in the editor. To assign a single user, configure the editor with the [`combo` or `select`](#combo-select-and-multiselect-types) type. For multiple users, use [`multiselect`](#combo-select-and-multiselect-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.

For multiple users, use -> For multiple users, apply/set/specify

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.

Согласна


- `headerFields: [ { key: string, label: string, css: string } ]` — *custom fields*

The code snippet below configures the `cardShape` object with users, priority, and custom header fields:
Copy link
Copy Markdown
Contributor

@mafanya23 mafanya23 Apr 3, 2026

Choose a reason for hiding this comment

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

Хорошее описание сниппета. В оригинале вроде его нет, поэтому в принципе хорошо, что появилось)


:::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 do not specify card settings via the [`cardShape`](api/config/js_kanban_cardshape_config.md) property, the widget applies a [`defaultCardShape`](api/config/js_kanban_cardshape_config.md#default-config) set of parameters.
Copy link
Copy Markdown
Contributor

@mafanya23 mafanya23 Apr 3, 2026

Choose a reason for hiding this comment

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

(+)


:::info
You can display the Editor as the **sidebar** or **modal window** using the [`editor.placement`](api/config/js_kanban_editor_config.md) property!
You can display the editor as the *sidebar* or *modal window* through 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.

Я бы оставила заглавную букву для Editor. Так лучше воспринимается, что за editor, мне кажется

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 types

The editor fields of **combo**, **select**, and **multiselect** types can be set in the following way:
The following code snippet uses the `combo` type to configure the editor field for selecting a value from a predefined list:
Copy link
Copy Markdown
Contributor

@mafanya23 mafanya23 Apr 3, 2026

Choose a reason for hiding this comment

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

мне кажется, здесь немного потерялось, что для типов select и multiselect поля задаются аналогично (именно в описании)

Такой вариант (для описаний ниже тоже):

To configure the editor field for selecting a value from a predefined list, use the combo, select, or multiselect type. See the following snippet
(акцент больше на описание типов, а не примеров)

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.

(+)


:::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` types you can specify a path to the preview image via the `avatar` 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.

(+)

});
~~~

#### Configuring Upload Url as Function
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.

Выше исправлено на Configure, здесь герундий. Мне кажется, герундий здесь уместен, так как это описательные разделы, а не пошаговый how-to

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.

Если это не степ, то можно и герундий. Главное,чтобы везде в доке был один подход.
Но в последнее время все уже отказались от подхода с герундиями и перешли на императив (если глянуть доки и гугла и apple например). В принципе, это верно, т.к. герундий он более громоздкий для восприятия , и даже в целях экономии места в сайдбаре том же.
Я за Configure

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.

Понятно, спасибо за пояснение

~~~

### Binding editor fields to card fields
### Bind editor fields to card 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.

оставила бы здесь герундий - описательный раздел, не часть how to


:::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 the editor field to the corresponding card field, provide special `key` in the [`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 initial data of any field via this key as well.
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 value of this key needs to be set to true

Вариант:
Set the value of this key to true:

  • for built-in card fields - in the cardShape property
  • for custom card fields - in the headerFields array

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.

(+)

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 the editor field to the corresponding card field, provide special `key` in the [`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 initial data of any field via this key as well.

The following code snippet binds editor fields to both built-in and custom card 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.

(+)

### Configuring the editor
### Configure the editor

Use the [`editor`](api/config/js_kanban_editor_config.md) property to configure the editor appearance and behavior:
Copy link
Copy Markdown
Contributor

@mafanya23 mafanya23 Apr 3, 2026

Choose a reason for hiding this comment

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

Use the editor object to configure the editor appearance and behavior via the following properties:

(дальше, я бы сделала, как здесь)

  • editor.autoSave — enable autosave mode
  • editor.debounce — delay (ms) before saving after a change (only applies when autoSave: true)


- 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)
The following code snippet enables autosave with a 2-second debounce delay:
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.

(+)

## 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.
**Toolbar** of Kanban includes the searchbar for *searching cards* and controls for *sorting cards* and *adding new columns and rows*. Initialize Toolbar 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.

(+)

~~~

You can manage (*hide/show/customize*) the Toolbar controls using the **items** property:
You can manage (*hide/show/customize*) the Toolbar controls through the `items` 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.

Мне понравилось, как получилось здесь:
Use the items property to hide, show, or customize Toolbar controls:

- 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
You can configure the *Kanban* appearance and functionality via the following properties:
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.

Там вроде решили про сам список. А не про первые два предложения


:::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 the `label` parameter to show the corresponding input in the editor. Configure the editor field with the [`text` or `textarea`](#text-and-textarea-types) 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.

Мне кажется норм, т.к. это tip
Но можно и во втором You can configure
НО не to configure.. use.. (полeчится тогда точь-в-точь как в первом, только перевернуто activate.. to show)


:::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.
Activate the `users` parameter to show the assignment control in the editor. To assign a single user, configure the editor with the [`combo` or `select`](#combo-select-and-multiselect-types) type. For multiple users, use [`multiselect`](#combo-select-and-multiselect-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.

Согласна


:::info
You can display the Editor as the **sidebar** or **modal window** using the [`editor.placement`](api/config/js_kanban_editor_config.md) property!
You can display the editor as the *sidebar* or *modal window* through 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.

Согласна

### Combo, Select and Multiselect types

The editor fields of **combo**, **select**, and **multiselect** types can be set in the following way:
The following code snippet uses the `combo` type to configure the editor field for selecting a value from a predefined list:
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.

(+)

});
~~~

#### Configuring Upload Url as Function
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.

Если это не степ, то можно и герундий. Главное,чтобы везде в доке был один подход.
Но в последнее время все уже отказались от подхода с герундиями и перешли на императив (если глянуть доки и гугла и apple например). В принципе, это верно, т.к. герундий он более громоздкий для восприятия , и даже в целях экономии места в сайдбаре том же.
Я за Configure


:::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 the editor field to the corresponding card field, provide special `key` in the [`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 initial data of any field via this key as well.
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.

(+)

Use the [`editor`](api/config/js_kanban_editor_config.md) property to configure the editor appearance and behavior:

Using the [`editor`](api/config/js_kanban_editor_config.md) property, you can configure the editor in the following way:
- enables/disables an autosave mode of the editor via the `editor.autoSave` 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.

Use the editor property to configure the editor appearance and behavior: +!
Только в списке тогда

  • enable/disable ... без (s)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants