Skip to content

Commit

Permalink
[update] default values for form controls' configs
Browse files Browse the repository at this point in the history
  • Loading branch information
mafanya23 committed Sep 8, 2023
1 parent b512dbe commit a2a81c4
Show file tree
Hide file tree
Showing 14 changed files with 199 additions and 199 deletions.
38 changes: 19 additions & 19 deletions docs/form/api/combo/api_combo_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ description: You can explore the Properties of the Combo Box control of Form in
value?: string | number | array,

css?: string,
disabled?: boolean,
disabled?: boolean, // false by default
height?: string | number | "content", // "content" by default
hidden?: boolean,
padding?: string | number,
hidden?: boolean, // false by default
padding?: string | number, // "8px" by default
required?: boolean, // false by default
validation?: (id: (string | number) | (string | number)[], text: string | string[]) => boolean,
width?: string | number | "content", // "content" by default
Expand All @@ -30,7 +30,7 @@ description: You can explore the Properties of the Combo Box control of Form in
itemsCount?: boolean | ((count: number) => string),
listHeight?: number | string, // 224 by default
multiselection?: boolean, // false by default
newOptions?: boolean,
newOptions?: boolean, // false by default
placeholder?: string,
readOnly?: boolean, // false by default
selectAllButton?: boolean, // false by default
Expand Down Expand Up @@ -89,23 +89,23 @@ description: You can explore the Properties of the Combo Box control of Form in
</tr>
<tr>
<td><b>disabled</b></td>
<td>(optional) defines whether a control is enabled (<i>false</i>) or disabled (<i>true</i>)</td>
<td>(optional) defines whether a control is enabled (<i>false</i>) or disabled (<i>true</i>), <i>false</i> by default</td>
</tr>
<tr>
<td><b>height</b></td>
<td>(optional) the height of a control</td>
<td>(optional) the height of a control, <i>"content"</i> by default</td>
</tr>
<tr>
<td><b>hidden</b></td>
<td>(optional) defines whether a control is hidden</td>
<td>(optional) defines whether a control is hidden, <i>false</i> by default</td>
</tr>
<tr>
<td><b>padding</b></td>
<td>(optional) sets padding between a cell and a border of the Combo control</td>
<td>(optional) sets padding between a cell and a border of the Combo control, <i>"8px"</i> by default</td>
</tr>
<tr>
<td><b>required</b></td>
<td>(optional) <a href="../../../work_with_form#validating-form">defines whether the field with Combo is required</a> (for a form)</td>
<td>(optional) <a href="../../../work_with_form#validating-form">defines whether the field with Combo is required</a> (for a form), <i>false</i> by default</td>
</tr>
<tr>
<td><b>validation</b></td>
Expand All @@ -115,63 +115,63 @@ description: You can explore the Properties of the Combo Box control of Form in
</tr>
<tr>
<td><b>width</b></td>
<td>(optional) the width of a control</td>
<td>(optional) the width of a control, <i>"content"</i> by default</td>
</tr>
<tr>
<td><b>filter</b></td>
<td>(optional) sets a custom function for filtering Combo options. <a href="../../../../combobox/customization#custom-filter-for-options">Check the details.</a></td>
</tr>
<tr>
<td><b>itemHeight</b></td>
<td>(optional) sets the height of a cell in the list of options</td>
<td>(optional) sets the height of a cell in the list of options, <i>32</i> by default</td>
</tr>
<tr>
<td><b>itemsCount</b></td>
<td>(optional) shows the total number of selected options</td>
</tr>
<tr>
<td><b>listHeight</b></td>
<td>(optional) sets the height of the list of options</td>
<td>(optional) sets the height of the list of options, <i>224</i> by default</td>
</tr>
<tr>
<td><b>multiselection</b></td>
<td>(optional) enables selection of multiple options in Combo</td>
<td>(optional) enables selection of multiple options in Combo, <i>false</i> by default</td>
</tr>
<tr>
<td><b>newOptions</b></td>
<td>(optional) allows end users to add new values into the list of combobox options. To add a new value, the user needs to type it into the input field and either press "Enter" or click on the appeared <i>Create "newValue"</i> option in the drop-down list.</td>
<td>(optional) allows end users to add new values into the list of combobox options. To add a new value, the user needs to type it into the input field and either press "Enter" or click on the appeared <i>Create "newValue"</i> option in the drop-down list, <i>false</i> by default</td>
</tr>
<tr>
<td><b>placeholder</b></td>
<td>(optional) sets a placeholder in the input of Combo</td>
</tr>
<tr>
<td><b>readOnly</b></td>
<td>(optional) makes Combo readonly (it is only possible to select options from the list, without entering words in the input)</td>
<td>(optional) makes Combo readonly (it is only possible to select options from the list, without entering words in the input), <i>false</i> by default</td>
</tr>
<tr>
<td><b>selectAllButton</b></td>
<td>(optional) defines whether the Select All button should be shown</td>
<td>(optional) defines whether the Select All button should be shown, <i>false</i> by default</td>
</tr>
<tr>
<td><b>template</b></td>
<td>(optional) sets a template of displaying options in the popup list</td>
</tr>
<tr>
<td><b>virtual</b></td>
<td>(optional) enables dynamic loading of data on scrolling the list of options</td>
<td>(optional) enables dynamic loading of data on scrolling the list of options, <i>false</i> by default</td>
</tr>
<tr>
<td><b>hiddenLabel</b></td>
<td>(optional) makes the label invisible</td>
<td>(optional) makes the label invisible, <i>false</i> by default</td>
</tr>
<tr>
<td><b>label</b></td>
<td>(optional) specifies a label for a control</td>
</tr>
<tr>
<td><b>labelPosition</b></td>
<td>(optional) defines the position of a label: "left"|"top"</td>
<td>(optional) defines the position of a label: "left" | "top", <i>"top"</i> by default</td>
</tr>
<tr>
<td><b>labelWidth</b></td>
Expand Down
16 changes: 8 additions & 8 deletions docs/form/api/container/api_container_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ description: You can explore the Properties of the Container control of Form in
html?: HTMLElement | string,

css?: string,
disabled?: boolean,
disabled?: boolean, // false by default
height?: string | number | "content", // "content" by default
hidden?: boolean,
padding?: string | number,
hidden?: boolean, // false by default
padding?: string | number, // "8px" by default
width?: string | number | "content", // "content" by default
}
~~~
Expand All @@ -31,11 +31,11 @@ description: You can explore the Properties of the Container control of Form in
- `id` - (optional) the id of a control, 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)
- `height` - (optional) the height of a control
- `hidden` - (optional) defines whether a control is hidden
- `padding` - (optional) sets padding between a cell and a border of a control
- `width` - (optional) the width of a control
- `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default
- `height` - (optional) the height of a control, *"content"* by default
- `hidden` - (optional) defines whether a control is hidden, *false* by default
- `padding` - (optional) sets padding between a cell and a border of a control, *"8px"* by default
- `width` - (optional) the width of a control, *"content"* by default

### Example

Expand Down
28 changes: 14 additions & 14 deletions docs/form/api/fieldset/api_fieldset_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ description: You can explore the Properties of the Fieldset control of Form in t
name?: string,
id?: string,

hidden?: boolean,
disabled?: boolean,
hidden?: boolean, // false by default
disabled?: boolean, // false by default

css?: string,
width?: string | number | "content",
height?: string | number | "content",
padding?: string | number,
width?: string | number | "content", // "content" by default
height?: string | number | "content", // "content" by default
padding?: string | number, // "8px" by default

label?: string,
labelAlignment?: "left" | "right" | "center",
labelAlignment?: "left" | "right" | "center", // "left" by default
rows?: IBlock,
cols?: IBlock,
align?: "start" | "center" | "end" | "between" | "around" | "evenly"
align?: "start" | "center" | "end" | "between" | "around" | "evenly" // "start" by default
}
~~~

Expand All @@ -35,17 +35,17 @@ 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
- `hidden` - (optional) defines whether a control is hidden
- `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*)
- `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
- `width` - (optional) sets the width of the control group
- `height` - (optional) sets the height of the control group
- `padding` - (optional) sets the padding for the content inside the control group
- `width` - (optional) sets the width of the control group, *"content"* by default
- `height` - (optional) sets the height of the control group, *"content"* by default
- `padding` - (optional) sets the padding for the content inside the control group, *"8px"* by default
- `label` - (optional) specifies a label for a control
- `labelAlignment` - (optional) defines the position of the label: "left"|"right"|"center"
- `labelAlignment` - (optional) defines the position of the label: "left" | "right" | "center", *"left"* by default
- `rows` - (optional) arranges controls inside the control group vertically
- `cols` - (optional) arranges controls inside the control group horizontally
- `align` - (optional) sets the alignment of controls inside the control group
- `align` - (optional) sets the alignment of controls inside the control group, *"start"* by default

### Example

Expand Down
32 changes: 16 additions & 16 deletions docs/form/api/input/api_input_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ description: You can explore the Properties of the Input control of Form in the
value?: string | number,

css?: string,
disabled?: boolean,
height?: string | number | "content", // "content"
hidden?: boolean,
padding?: string | number,
disabled?: boolean, // false by default
height?: string | number | "content", // "content" by default
hidden?: boolean, // false by default
padding?: string | number, // "8px" by default
required?: boolean, // false by default
validation?: string | (input: string | number) => boolean,
width?: string | number | "content", // "content" by default

autocomplete?: boolean,
autocomplete?: boolean, // false by default
icon?: string,
inputType?: "text" | "password" | "number", // "text" by default
max?: number | string,
Expand Down Expand Up @@ -72,23 +72,23 @@ description: You can explore the Properties of the Input control of Form in the
</tr>
<tr>
<td><b>disabled</b></td>
<td>(optional) defines whether a control is enabled (<i>false</i>) or disabled (<i>true</i>)</td>
<td>(optional) defines whether a control is enabled (<i>false</i>) or disabled (<i>true</i>), <i>false</i> by default</td>
</tr>
<tr>
<td><b>height</b></td>
<td>(optional) the height of a control</td>
<td>(optional) the height of a control, <i>"content"</i> by default</td>
</tr>
<tr>
<td><b>hidden</b></td>
<td>(optional) makes an input hidden</td>
<td>(optional) makes an input hidden, <i>false</i> by default</td>
</tr>
<tr>
<td><b>padding</b></td>
<td>(optional) sets padding between a cell and a border of the Input control</td>
<td>(optional) sets padding between a cell and a border of the Input control, <i>"8px"</i> by default</td>
</tr>
<tr>
<td><b>required</b></td>
<td>(optional) <a href="../../../work_with_form#validating-form">defines whether a control is required</a></td>
<td>(optional) <a href="../../../work_with_form#validating-form">defines whether a control is required</a>, <i>false</i> by default</td>
</tr>
<tr>
<td><b>validation</b></td>
Expand All @@ -108,19 +108,19 @@ description: You can explore the Properties of the Input control of Form in the
</tr>
<tr>
<td><b>width</b></td>
<td>(optional) the width of a control</td>
<td>(optional) the width of a control, <i>"content"</i> by default</td>
</tr>
<tr>
<td><b>autocomplete</b></td>
<td>(optional) enables/disables the autocomplete functionality of the input</td>
<td>(optional) enables/disables the autocomplete functionality of the input, <i>false</i> by default</td>
</tr>
<tr>
<td><b>icon</b></td>
<td>(optional) the name of an <a href="../../../../helpers/icon">icon</a> from the used icon font</td>
</tr>
<tr>
<td><b>inputType</b></td>
<td>(optional) sets the type of an input: "text", "password", "number". <br/>Using the "number" type for the input sets the type of the <b>value</b> attribute to "number". <br/>Use the "password" value to specify a field for entering a password.</td>
<td>(optional) sets the type of an input: "text", "password", "number". <br/>Using the "number" type for the input sets the type of the <b>value</b> attribute to "number". <br/>Use the "password" value to specify a field for entering a password. <i>"text"</i> by default</td>
</tr>
<tr>
<td><b>max</b></td>
Expand All @@ -144,19 +144,19 @@ description: You can explore the Properties of the Input control of Form in the
</tr>
<tr>
<td><b>readOnly</b></td>
<td>(optional) defines whether an input is readonly</td>
<td>(optional) defines whether an input is readonly, <i>false</i> by default</td>
</tr>
<tr>
<td><b>hiddenLabel</b></td>
<td>(optional) makes the label invisible</td>
<td>(optional) makes the label invisible, <i>false</i> by default</td>
</tr>
<tr>
<td><b>label</b></td>
<td>(optional) specifies a label for a control</td>
</tr>
<tr>
<td><b>labelPosition</b></td>
<td>(optional) defines the position of a label: "left"|"top"</td>
<td>(optional) defines the position of a label: "left" | "top", <i>"top"</i> by default</td>
</tr>
<tr>
<td><b>labelWidth</b></td>
Expand Down
22 changes: 11 additions & 11 deletions docs/form/api/radiogroup/api_radiogroup_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ description: You can explore the Properties of the RadioGroup and RadioButton co
value?: string,

css?: string,
disabled?: boolean,
disabled?: boolean, // false by default
height?: string | number | "content", // "content" by default
hidden?: boolean,
padding?: string | number,
hidden?: boolean, // false by default
padding?: string | number, // "8px" by default
required?: boolean, // false by default
width?: string | number | "content", // "content" by default

Expand Down Expand Up @@ -111,39 +111,39 @@ description: You can explore the Properties of the RadioGroup and RadioButton co
</tr>
<tr>
<td><b>disabled</b></td>
<td>(optional) defines whether a control is enabled (<i>false</i>) or disabled (<i>true</i>)</td>
<td>(optional) defines whether a control is enabled (<i>false</i>) or disabled (<i>true</i>), <i>false</i> by default</td>
</tr>
<tr>
<td><b>height</b></td>
<td>(optional) the height of a control</td>
<td>(optional) the height of a control, <i>"content"</i> by default</td>
</tr>
<tr>
<td><b>hidden</b></td>
<td>(optional) defines whether a RadioGroup is hidden</td>
<td>(optional) defines whether a RadioGroup is hidden, <i>false</i> by default</td>
</tr>
<tr>
<td><b>padding</b></td>
<td>(optional) sets padding between a cell and a border of a RadioGroup control</td>
<td>(optional) sets padding between a cell and a border of a RadioGroup control, <i>"8px"</i> by default</td>
</tr>
<tr>
<td><b>required</b></td>
<td>(optional) <a href="../../../work_with_form#validating-form">defines whether a control is required</a></td>
<td>(optional) <a href="../../../work_with_form#validating-form">defines whether a control is required</a>, <i>false</i> by default</td>
</tr>
<tr>
<td><b>width</b></td>
<td>(optional) the width of a control</td>
<td>(optional) the width of a control, <i>"content"</i> by default</td>
</tr>
<tr>
<td><b>hiddenLabel</b></td>
<td>(optional) makes the label invisible</td>
<td>(optional) makes the label invisible, <i>false</i> by default</td>
</tr>
<tr>
<td><b>label</b></td>
<td>(optional) specifies a label for a control</td>
</tr>
<tr>
<td><b>labelPosition</b></td>
<td>(optional) defines the position of a label: "left"|"top"</td>
<td>(optional) defines the position of a label: "left" | "top", <i>"top"</i> by default</td>
</tr>
<tr>
<td><b>labelWidth</b></td>
Expand Down
Loading

0 comments on commit a2a81c4

Please sign in to comment.