Skip to content

Commit e3a206f

Browse files
committed
Merge branch 'next'
2 parents bb307ab + 2730bb1 commit e3a206f

18 files changed

+69
-22
lines changed

docs/calendar/api/calendar_dateformat_config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ const calendar = new dhx.Calendar("calendar_container", {
2121
@descr:
2222
**Related sample**: [Calendar. Date format](https://snippet.dhtmlx.com/2co9z3bi)
2323

24+
:::info
25+
The date format must include delimiters (space or symbol), otherwise an error will be thrown.
26+
:::
27+
2428
DHTMLX Calendar uses the following characters for setting a date format:
2529

2630
| Character | Definition |

docs/combobox/adding_options.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,11 @@ const dataset = [
3838
]
3939
~~~
4040

41-
Each object in the data set contains a number of *key:value* pairs that represent attributes of Combo options.
41+
Each object in the data set contains a number of *key:value* pairs that represent attributes of Combo options. [Check the details](combobox/api/combobox_data_config.md).
42+
4243
You can specify your own template of rendering Combo options with the help of the [template](combobox/api/combobox_template_config.md) configuration option.
4344

44-
{{note Note, that **value** is a mandatory property for a dataset item and **src** is a reserved one.}}
45+
{{note Note, until you use the [template](combobox/api/combobox_template_config.md) option, the **value** is a mandatory property for a dataset item and **src** is a reserved one.}}
4546

4647
## Loading data on initialization
4748

docs/combobox/api/combobox_data_config.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,24 @@ const combo = new dhx.Combobox("combo_container",{
2929
"value": "Cyprus",
3030
"src": "../common/flags/cy.png"
3131
}
32+
]
3233
});
3334

3435
@descr:
3536

3637
**Related sample**: [Combobox. Initialization with config.data](https://snippet.dhtmlx.com/8bsb9dji)
3738

39+
Each object in the data set contains a number of key:value pairs that represent attributes of Combo options. The available attributes are:
40+
41+
- `id?: string | number` - optional, the id of the data option
42+
- `value?: string`- optional, the text value of the option
43+
- `src?: string`- optional, the path to the image
44+
- `icon?: string` - optional, the CSS class of the displayed icon (for example, "dxi dxi-check")
45+
46+
:::info
47+
It is not possible to use the `src` and `icon` attributes together.
48+
:::
49+
3850
@changelog: added in v6.4
3951

4052
[comment]: # (@related: combobox/how_to_start.md#initialize-combobox)

docs/combobox/api/combobox_filter_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A custom function takes two parameters:
2727
<table>
2828
<tbody>
2929
<tr>
30-
<td><b>item</b></td>
30+
<td><b><a href="https://docs.dhtmlx.com/suite/combobox/api/combobox_data_config/">item</a></b></td>
3131
<td>(<i>object</i>) an item of data collection</td>
3232
</tr>
3333
<tr>

docs/combobox/api/combobox_setvalue_method.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,13 @@ description: You can explore the setValue method of Combo Box in the documentati
88

99
@short: selects option(s) in ComboBox
1010

11-
@signature: {'setValue(value: Id | Id[]): void;'}
11+
@signature: {'setValue(ids: Id | Id[]): void;'}
1212

1313
@params:
14-
- `value: (string | number) | (string | number)[]` - the ID(s) of items from data collection that should be selected in Combo Box
14+
- `ids: (string | number) | (string | number)[]` - the ID(s) of items from data collection that should be selected in Combo Box
1515

1616
@descr:
1717

18-
:::info
19-
Note, that you need to pass the **ID(s)** of Combo options as a value of the **value** parameter.
20-
:::
21-
2218
@example:
2319
// selects one option
2420
combo.setValue(combo.data.getId(1));

docs/combobox/api/combobox_value_config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: You can explore the value config of Combo Box in the documentation
88

99
@short: Optional. Specifies the values that will appear in the input on initialization of the combobox
1010

11-
@signature: {'value?: string | string[];'}
11+
@signature: {'value?: Id | Id[];'}
1212

1313
@example:
1414
const combobox = new dhx.Combobox("combo_container", {
@@ -25,7 +25,7 @@ const combobox = new dhx.Combobox("combo_container", {
2525

2626
**Related sample**: [Combobox. Initial value](https://snippet.dhtmlx.com/spnausim)
2727

28-
- If *multiselection:true* is set for a combo, the property takes an array of string values as:<br/> *value: ["1","2","3"]*;
28+
- If *multiselection:true* is set for a combo, the property takes an array of options' ids as:<br/> *value: ["1","2","3"]*;
2929
- If *multiselection:false* is set or the *multiselection* config is not defined, the property gets either of the two values: *value:"1"* or *value: ["1"]*.
3030

3131
@changelog: added in v7.0

docs/combobox/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ const combobox = new dhx.Combobox("combo_container", {
8888

8989
**Related sample**: [Combobox. Initial value](https://snippet.dhtmlx.com/spnausim)
9090

91-
- If *multiselection:true* is set for a combo, the property takes an array of string values as: *value: ["1","2","3"]*,
92-
- If *multiselection:false* is set or the *multiselection* config is not defined, the property gets either of the two values: *value:"1"* or *value: ["1"]*.
91+
- If *multiselection:true* is set for a combo, the property takes an array with options' ids: for example, *value: ["id_1","id_2","id_3"]* or *value: [1, 2, 3]*,
92+
- If *multiselection:false* is set or the *multiselection* config is not defined, the property gets either of the two values: *value:"id_1"*, *value: 1*, or *value: ["id_1"]*.
9393

9494
## Label
9595

docs/form/api/calendar/api_calendar_properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ description: You can explore the Properties of the Datepicker control of Form in
113113
</tr>
114114
<tr>
115115
<td><b>dateFormat</b></td>
116-
<td>(optional) defines the format of dates in the calendar, "%d/%m/%y" by default</td>
116+
<td>(optional) defines the format of dates in the calendar, "%d/%m/%y" by default. The date format must include delimiters (space or symbol), otherwise an error will be thrown</td>
117117
</tr>
118118
<tr>
119119
<td><b>disabledDates</b></td>

docs/form/api/combo/combo_setvalue_method.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,13 @@ description: You can explore the setValue method of the Combo Box control of For
88

99
@short: sets the value for a Combo control
1010

11-
@signature: {'setValue(value: Id | Id[]): void;'}
11+
@signature: {'setValue(ids: Id | Id[]): void;'}
1212

1313
@params:
1414
- `value: (string | number) | (string | number)[]` - the ID(s) of options from data collection that should be selected in the control
1515

1616
@descr:
1717

18-
:::info
19-
Note, that you need to pass the **ID(s)** of Combo options as a value of the **value** parameter.
20-
:::
21-
2218
#### Example
2319

2420
When the `multiselection` property of Combo control isn't specified or is set to *false*, you can set the value of ID as a string, number or array:

docs/grid/api/api_gridcolumn_properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ columns:[
180180
</tr>
181181
<tr>
182182
<td><a href="../../configuration#formatting-columns"><b>format</b></a></td>
183-
<td>(optional) defines the format for the content of the column's cells</td>
183+
<td>(optional) defines the format for the content of the column's cells. The date format must include delimiters (space or symbol), otherwise an error will be thrown</td>
184184
</tr>
185185
<tr>
186186
<td><b>options</b></td>

0 commit comments

Comments
 (0)