Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding notes on unique ids for Layout, Tabbar and Form, minor updates #13

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Adding notes on unique ids for Layout, Tabbar and Form, minor updates #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9f6193
[update] add info notes on cells id usage, minor corrections
mafanya23 Jul 29, 2024
1d32462
[update] add info notes on tabs id usage, update related docs
mafanya23 Jul 30, 2024
c17b9aa
[update] add info notes on form controls id prop, complete the id des…
mafanya23 Jul 30, 2024
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
4 changes: 2 additions & 2 deletions docs/form/api/avatar/api_avatar_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Avatar control of Form in the
{
type: "avatar",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set

target?: string,
value?: object,
Expand Down Expand Up @@ -70,7 +70,7 @@ description: You can explore the Properties of the Avatar control of Form in the
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr id="target">
<td><b>target</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/button/api_button_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Button control of Form in the
{
type: "button",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set

text?: string,
submit?: boolean, // false by default
Expand Down Expand Up @@ -50,7 +50,7 @@ description: You can explore the Properties of the Button control of Form in the
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set </td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>text</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/calendar/api_calendar_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Datepicker control of Form in
{
type: "datepicker",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: Date | string,

css?: string,
Expand Down Expand Up @@ -65,7 +65,7 @@ description: You can explore the Properties of the Datepicker control of Form in
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/checkbox/api_checkbox_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Checkbox control of Form in t
{
type: "checkbox",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: string,
checked?: boolean, // false by default
text?: string,
Expand Down Expand Up @@ -51,7 +51,7 @@ description: You can explore the Properties of the Checkbox control of Form in t
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
10 changes: 5 additions & 5 deletions docs/form/api/checkbox_group/api_checkboxgroup_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ description: You can explore the Properties of the Checkbox Group control of For
{
type: "checkboxGroup",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
options: {
rows?: [
{
type: "checkbox",
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: string,
checked?: boolean,
css?: string,
Expand All @@ -32,7 +32,7 @@ description: You can explore the Properties of the Checkbox Group control of For
cols?: [
{
type: "checkbox",
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: string,
checked?: boolean,
css?: string,
Expand Down Expand Up @@ -90,7 +90,7 @@ description: You can explore the Properties of the Checkbox Group control of For
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>options</b></td>
Expand Down Expand Up @@ -173,7 +173,7 @@ description: You can explore the Properties of the Checkbox Group control of For
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/colorpicker/api_colorpicker_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Colorpicker control of Form i
{
type: "colorpicker",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: string,

css?: string,
Expand Down Expand Up @@ -60,7 +60,7 @@ description: You can explore the Properties of the Colorpicker control of Form i
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/combo/api_combo_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Combo Box control of Form in
{
type: "combo",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
data?: object[],
value?: string | number | array,

Expand Down Expand Up @@ -68,7 +68,7 @@ description: You can explore the Properties of the Combo Box control of Form in
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>data</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/container/api_container_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Container control of Form in
{
type: "container",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
html?: HTMLElement | string,

css?: string,
Expand All @@ -34,7 +34,7 @@ description: You can explore the Properties of the Container control of Form in

- `type` - (required) the type of a control, set it to "container"
- `name` - (optional) the name of a control
- `id` - (optional) the id of a control, auto-generated if not set
- `id` - (optional) the id of a control, must be **unique** if set, auto-generated if not set
- `html` - (optional) the HTML content of a control
- `css` - (optional) adds style classes to a control string
- `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/fieldset/api_fieldset_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Fieldset control of Form in t
{
type: "fieldset",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set

hidden?: boolean, // false by default
disabled?: boolean, // false by default
Expand All @@ -34,7 +34,7 @@ description: You can explore the Properties of the Fieldset control of Form in t

- `type` - (required) the type of a control, set it to "fieldset"
- `name` - (optional) the name of a control
- `id` - (optional) the id of a control, auto-generated if not set
- `id` - (optional) the id of a control, must be **unique** if set, auto-generated if not set
- `hidden` - (optional) defines whether a control is hidden, *false* by default
- `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default
- `css` - (optional) the name of a CSS class(es) applied to the control group
Expand Down
5 changes: 4 additions & 1 deletion docs/form/api/form_cols_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: You can explore the cols Config of Form in the documentation of the

# cols

@short: Optional. Arranges controls inside the control group horizontally
@short: Optional. Arranges [controls](/suite/category/list-of-form-controls/) inside the control group horizontally

@signature: {'cols?: object[];'}

Expand Down Expand Up @@ -35,6 +35,9 @@ const form = new dhx.Form("form_container", {
});

@descr:
:::info
Please note that if you specify the `id` fields for controls, their values should be **unique**. You can also omit the `id` fields in the configuration of controls. In this case they will be generated automatically.
:::

@changelog: added in v6.4

Expand Down
5 changes: 4 additions & 1 deletion docs/form/api/form_rows_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: You can explore the rows Config of Form in the documentation of the

# rows

@short: Optional. Arranges controls inside the control group vertically
@short: Optional. Arranges [controls](/suite/category/list-of-form-controls/) inside the control group vertically

@signature: {'rows?: object[];'}

Expand Down Expand Up @@ -41,6 +41,9 @@ const form = new dhx.Form("form_container", {
});

@descr:
:::info
Please note that if you specify the `id` fields for controls, their values should be **unique**. You can also omit the `id` fields in the configuration of controls. In this case they will be generated automatically.
:::

@changelog: added in v6.4

Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/input/api_input_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Input control of Form in the
{
type: "input",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: string | number,

css?: string,
Expand Down Expand Up @@ -60,7 +60,7 @@ description: You can explore the Properties of the Input control of Form in the
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
10 changes: 5 additions & 5 deletions docs/form/api/radiogroup/api_radiogroup_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ description: You can explore the Properties of the RadioGroup and RadioButton co
{
type: "radiogroup",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
options: {
rows?: [
{
type: "radiobutton",
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value: string,
checked?: boolean, // false by default
css?: string,
Expand All @@ -33,7 +33,7 @@ description: You can explore the Properties of the RadioGroup and RadioButton co
cols?: [
{
type: "radiobutton",
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value: string,
checked?: boolean,
css?: string,
Expand Down Expand Up @@ -89,7 +89,7 @@ description: You can explore the Properties of the RadioGroup and RadioButton co
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>options</b></td>
Expand Down Expand Up @@ -172,7 +172,7 @@ description: You can explore the Properties of the RadioGroup and RadioButton co
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/select/api_select_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Select control of Form in the
{
type: "select",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
options: [
{
value: string | number,
Expand Down Expand Up @@ -60,7 +60,7 @@ description: You can explore the Properties of the Select control of Form in the
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set </td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>options</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/simplevault/api_simplevault_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Simple Vault control of Form
{
type: "simplevault",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
target?: string,
value?: [
{
Expand Down Expand Up @@ -76,7 +76,7 @@ description: You can explore the Properties of the Simple Vault control of Form
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>target</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/slider/api_slider_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Slider control of Form in the
{
type: "slider",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: number | number[],

css?: string,
Expand Down Expand Up @@ -56,7 +56,7 @@ description: You can explore the Properties of the Slider control of Form in the
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/spacer/api_spacer_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Spacer control of Form in the
{
type: "spacer",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set

css?: string,
height?: string | number | "content", // "content" by default
Expand All @@ -36,7 +36,7 @@ description: You can explore the Properties of the Spacer control of Form in the
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>css</b></td>
Expand Down
6 changes: 3 additions & 3 deletions docs/form/api/text/api_text_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ description: You can explore the Properties of the Text control of Form in the d
{
type: "text",
name?: string,
id?: string,
value?: number | string,
id?: string, // must be unique if set, auto-generated if not set
value?: number | string,

css?: string,
disabled?: boolean, // false by default
Expand Down Expand Up @@ -50,7 +50,7 @@ description: You can explore the Properties of the Text control of Form in the d
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
4 changes: 2 additions & 2 deletions docs/form/api/textarea/api_textarea_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: You can explore the Properties of the Textarea control of Form in t
{
type: "textarea",
name?: string,
id?: string,
id?: string, // must be unique if set, auto-generated if not set
value?: string,

css?: string,
Expand Down Expand Up @@ -56,7 +56,7 @@ description: You can explore the Properties of the Textarea control of Form in t
</tr>
<tr>
<td><b>id</b></td>
<td>(optional) the id of a control, auto-generated if not set</td>
<td>(optional) the id of a control, must be <b>unique</b> if set, auto-generated if not set</td>
</tr>
<tr>
<td><b>value</b></td>
Expand Down
Loading