Skip to content

Commit

Permalink
[update] add missing default values for properties
Browse files Browse the repository at this point in the history
  • Loading branch information
@mafanya23
mafanya23 committed Sep 6, 2023
1 parent 50363cc commit b512dbe
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 42 deletions.
26 changes: 13 additions & 13 deletions docs/form/api/checkbox/api_checkbox_properties.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ description: You can explore the Properties of the Checkbox control of Form in t
name?: string,
id?: string,
value?: string,
checked?: boolean,
checked?: boolean, // false by default
text?: 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 @@ -59,7 +59,7 @@ description: You can explore the Properties of the Checkbox control of Form in t
</tr>
<tr>
<td><b>checked</b></td>
<td>(optional) defines the initial state of a checkbox</td>
<td>(optional) defines the initial state of a checkbox, <i>false</i> (unchecked) by default</td>
</tr>
<tr>
<td><b>text</b></td>
Expand All @@ -71,39 +71,39 @@ description: You can explore the Properties of the Checkbox control of Form in t
</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 checkbox is hidden</td>
<td>(optional) defines whether a checkbox 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 Checkbox control</td>
<td>(optional) sets padding between a cell and a border of a Checkbox 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, <i>false</i> by default</a></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
24 changes: 12 additions & 12 deletions docs/form/api/checkbox_group/api_checkboxgroup_properties.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ description: You can explore the Properties of the Checkbox Group control of For
type: "checkbox",
id?: string,
value?: string,
checked?: boolean,
checked?: boolean,
css?: string,
height?: string | number | "content",
hidden?: boolean,
Expand All @@ -46,7 +46,7 @@ description: You can explore the Properties of the Checkbox Group control of For
],
css?: string,
height?: string | number | "content", // "content" by default
padding?: string | number,
padding?: string | number, // "8px" by default
width?: string | number | "content", // "content" by default
},
value?: {
Expand All @@ -55,10 +55,10 @@ description: You can explore the Properties of the Checkbox Group control of For
},

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 @@ -122,35 +122,35 @@ description: You can explore the Properties of the Checkbox Group control of For
</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>(<i>boolean</i>) defines whether a CheckboxGroup is hidden</td>
<td>(<i>boolean</i>) defines whether a CheckboxGroup 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 CheckboxGroup control</td>
<td>(optional) sets padding between a cell and a border of a CheckboxGroup 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
34 changes: 17 additions & 17 deletions docs/form/api/colorpicker/api_colorpicker_properties.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ description: You can explore the Properties of the Colorpicker control of Form i
value?: string,

css?: string,
disabled?: boolean,
disabled?: boolean, // false by default
editable?: 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?: (value: string) => boolean,
width?: string | number | "content", // "content" by default
Expand All @@ -30,8 +30,8 @@ description: You can explore the Properties of the Colorpicker control of Form i
icon?: string,
mode?: "palette" | "picker", // "palette" by default
palette?: string[][],
paletteOnly?: boolean,
pickerOnly?: boolean,
paletteOnly?: boolean, // false by default
pickerOnly?: boolean, // false by default
placeholder?: string,

hiddenLabel?: boolean, // false by default
Expand Down Expand Up @@ -72,43 +72,43 @@ description: You can explore the Properties of the Colorpicker control of Form i
</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>editable</b></td>
<td>(optional) allows a user to enter the value of the control manually</td>
<td>(optional) allows a user to enter the value of the control manually, <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 ColorPicker control</td>
<td>(optional) sets padding between a cell and a border of the ColorPicker 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>
<td>(optional) <a href="../../../work_with_form#validation-rules">the validation function</a>, takes as a parameter the value to validate and returns <i>true/false</i> to indicate the result of validation</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>customColors</b></td>
<td>(optional) shows a section with custom colors in the bottom part of the ColorPicker</td>
</tr>
<tr>
<td><b>grayShades</b></td>
<td>(optional) defines whether the section with gray shades is displayed in the palette</td>
<td>(optional) defines whether the section with gray shades is displayed in the palette, <i>true</i> by default</td>
</tr>
<tr>
<td><b>icon</b></td>
Expand All @@ -124,27 +124,27 @@ description: You can explore the Properties of the Colorpicker control of Form i
</tr>
<tr>
<td><b>paletteOnly</b></td>
<td>(optional) defines whether ColorPicker is shown only the palette mode</td>
<td>(optional) defines whether ColorPicker is shown only the palette mode, <i>false</i> by default</td>
</tr>
<tr>
<td><b>pickerOnly</b></td>
<td>(optional) defines whether ColorPicker is shown only the picker mode</td>
<td>(optional) defines whether ColorPicker is shown only the picker mode, <i>false</i> by default</td>
</tr>
<tr>
<td><b>placeholder</b></td>
<td>(optional) a tip for the input</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

0 comments on commit b512dbe

Please sign in to comment.