[update] Edit the configuration guide manually#89
[update] Edit the configuration guide manually#89serhiipylypchuk1991 wants to merge 1 commit intomasterfrom
Conversation
| - 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: |
There was a problem hiding this comment.
Вроде решили, что лучше такой подход, который использовался здесь
There was a problem hiding this comment.
Там вроде решили про сам список. А не про первые два предложения
There was a problem hiding this comment.
Да, я про список. Не совсем понятно написала
|
|
||
| :::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. |
There was a problem hiding this comment.
Мне кажется, чтобы избежать однотипности, можно во втором предложения использовать you can.. или to configure.. use.. (здесь и ниже). См. строку 72 для примера
There was a problem hiding this comment.
Мне кажется норм, т.к. это 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). |
There was a problem hiding this comment.
For multiple users, use -> For multiple users, apply/set/specify
|
|
||
| - `headerFields: [ { key: string, label: string, css: string } ]` — *custom fields* | ||
|
|
||
| The code snippet below configures the `cardShape` object with users, priority, and custom header fields: |
There was a problem hiding this comment.
Хорошее описание сниппета. В оригинале вроде его нет, поэтому в принципе хорошо, что появилось)
|
|
||
| :::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. |
|
|
||
| :::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. |
There was a problem hiding this comment.
Я бы оставила заглавную букву для Editor. Так лучше воспринимается, что за editor, мне кажется
| ### 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: |
There was a problem hiding this comment.
мне кажется, здесь немного потерялось, что для типов 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
(акцент больше на описание типов, а не примеров)
|
|
||
| :::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: |
| }); | ||
| ~~~ | ||
|
|
||
| #### Configuring Upload Url as Function |
There was a problem hiding this comment.
Выше исправлено на Configure, здесь герундий. Мне кажется, герундий здесь уместен, так как это описательные разделы, а не пошаговый how-to
There was a problem hiding this comment.
Если это не степ, то можно и герундий. Главное,чтобы везде в доке был один подход.
Но в последнее время все уже отказались от подхода с герундиями и перешли на императив (если глянуть доки и гугла и apple например). В принципе, это верно, т.к. герундий он более громоздкий для восприятия , и даже в целях экономии места в сайдбаре том же.
Я за Configure
There was a problem hiding this comment.
Понятно, спасибо за пояснение
| ~~~ | ||
|
|
||
| ### Binding editor fields to card fields | ||
| ### Bind editor fields to card fields |
There was a problem hiding this comment.
оставила бы здесь герундий - описательный раздел, не часть 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. |
There was a problem hiding this comment.
Здесь остался пассив: 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
cardShapeproperty - for custom card fields - in the
headerFieldsarray
| 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: |
| ### Configuring the editor | ||
| ### Configure the editor | ||
|
|
||
| Use the [`editor`](api/config/js_kanban_editor_config.md) property to configure the editor appearance and behavior: |
There was a problem hiding this comment.
|
|
||
| - 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: |
| ## 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: |
| ~~~ | ||
|
|
||
| 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: |
There was a problem hiding this comment.
Мне понравилось, как получилось здесь:
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: |
There was a problem hiding this comment.
Там вроде решили про сам список. А не про первые два предложения
|
|
||
| :::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. |
There was a problem hiding this comment.
Мне кажется норм, т.к. это 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). |
|
|
||
| :::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. |
| ### 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: |
| }); | ||
| ~~~ | ||
|
|
||
| #### Configuring Upload Url as Function |
There was a problem hiding this comment.
Если это не степ, то можно и герундий. Главное,чтобы везде в доке был один подход.
Но в последнее время все уже отказались от подхода с герундиями и перешли на императив (если глянуть доки и гугла и 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. |
| 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 |
There was a problem hiding this comment.
Use the editor property to configure the editor appearance and behavior: +!
Только в списке тогда
- enable/disable ... без (s)
Нужно поревювить эту версию изменений, сделанную вручную. Главный вопрос, устрит ли такой конечный результат?