From a2a81c48de03ba31f9bdd376849c9b1679eddaa8 Mon Sep 17 00:00:00 2001 From: Masha_Rudenko Date: Fri, 8 Sep 2023 13:46:21 +0300 Subject: [PATCH] [update] default values for form controls' configs --- docs/form/api/combo/api_combo_properties.md | 38 ++++++++-------- .../api/container/api_container_properties.md | 16 +++---- .../api/fieldset/api_fieldset_properties.md | 28 ++++++------ docs/form/api/input/api_input_properties.md | 32 +++++++------- .../radiogroup/api_radiogroup_properties.md | 22 +++++----- docs/form/api/select/api_select_properties.md | 22 +++++----- .../simplevault/api_simplevault_properties.md | 34 +++++++------- docs/form/api/slider/api_slider_properties.md | 34 +++++++------- docs/form/api/spacer/api_spacer_properties.md | 12 ++--- docs/form/api/text/api_text_properties.md | 22 +++++----- .../api/textarea/api_textarea_properties.md | 30 ++++++------- .../timepicker/api_timepicker_properties.md | 30 ++++++------- docs/form/api/toggle/api_toggle_properties.md | 34 +++++++------- .../togglegroup/api_togglegroup_properties.md | 44 +++++++++---------- 14 files changed, 199 insertions(+), 199 deletions(-) diff --git a/docs/form/api/combo/api_combo_properties.md b/docs/form/api/combo/api_combo_properties.md index 13c78093..c56cd1c8 100644 --- a/docs/form/api/combo/api_combo_properties.md +++ b/docs/form/api/combo/api_combo_properties.md @@ -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 @@ -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 @@ -89,23 +89,23 @@ description: You can explore the Properties of the Combo Box control of Form in disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) defines whether a control is hidden + (optional) defines whether a control is hidden, false by default padding - (optional) sets padding between a cell and a border of the Combo control + (optional) sets padding between a cell and a border of the Combo control, "8px" by default required - (optional) defines whether the field with Combo is required (for a form) + (optional) defines whether the field with Combo is required (for a form), false by default validation @@ -115,7 +115,7 @@ description: You can explore the Properties of the Combo Box control of Form in width - (optional) the width of a control + (optional) the width of a control, "content" by default filter @@ -123,7 +123,7 @@ description: You can explore the Properties of the Combo Box control of Form in itemHeight - (optional) sets the height of a cell in the list of options + (optional) sets the height of a cell in the list of options, 32 by default itemsCount @@ -131,15 +131,15 @@ description: You can explore the Properties of the Combo Box control of Form in listHeight - (optional) sets the height of the list of options + (optional) sets the height of the list of options, 224 by default multiselection - (optional) enables selection of multiple options in Combo + (optional) enables selection of multiple options in Combo, false by default newOptions - (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 Create "newValue" option in the drop-down list. + (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 Create "newValue" option in the drop-down list, false by default placeholder @@ -147,11 +147,11 @@ description: You can explore the Properties of the Combo Box control of Form in readOnly - (optional) makes Combo readonly (it is only possible to select options from the list, without entering words in the input) + (optional) makes Combo readonly (it is only possible to select options from the list, without entering words in the input), false by default selectAllButton - (optional) defines whether the Select All button should be shown + (optional) defines whether the Select All button should be shown, false by default template @@ -159,11 +159,11 @@ description: You can explore the Properties of the Combo Box control of Form in virtual - (optional) enables dynamic loading of data on scrolling the list of options + (optional) enables dynamic loading of data on scrolling the list of options, false by default hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -171,7 +171,7 @@ description: You can explore the Properties of the Combo Box control of Form in labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/container/api_container_properties.md b/docs/form/api/container/api_container_properties.md index f91ecb49..0275a405 100644 --- a/docs/form/api/container/api_container_properties.md +++ b/docs/form/api/container/api_container_properties.md @@ -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 } ~~~ @@ -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 diff --git a/docs/form/api/fieldset/api_fieldset_properties.md b/docs/form/api/fieldset/api_fieldset_properties.md index 6a67c31f..e29ff92a 100644 --- a/docs/form/api/fieldset/api_fieldset_properties.md +++ b/docs/form/api/fieldset/api_fieldset_properties.md @@ -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 } ~~~ @@ -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 diff --git a/docs/form/api/input/api_input_properties.md b/docs/form/api/input/api_input_properties.md index 50a76584..4585a546 100644 --- a/docs/form/api/input/api_input_properties.md +++ b/docs/form/api/input/api_input_properties.md @@ -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, @@ -72,23 +72,23 @@ description: You can explore the Properties of the Input control of Form in the disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) makes an input hidden + (optional) makes an input hidden, false by default padding - (optional) sets padding between a cell and a border of the Input control + (optional) sets padding between a cell and a border of the Input control, "8px" by default required - (optional) defines whether a control is required + (optional) defines whether a control is required, false by default validation @@ -108,11 +108,11 @@ description: You can explore the Properties of the Input control of Form in the width - (optional) the width of a control + (optional) the width of a control, "content" by default autocomplete - (optional) enables/disables the autocomplete functionality of the input + (optional) enables/disables the autocomplete functionality of the input, false by default icon @@ -120,7 +120,7 @@ description: You can explore the Properties of the Input control of Form in the inputType - (optional) sets the type of an input: "text", "password", "number".
Using the "number" type for the input sets the type of the value attribute to "number".
Use the "password" value to specify a field for entering a password. + (optional) sets the type of an input: "text", "password", "number".
Using the "number" type for the input sets the type of the value attribute to "number".
Use the "password" value to specify a field for entering a password. "text" by default max @@ -144,11 +144,11 @@ description: You can explore the Properties of the Input control of Form in the readOnly - (optional) defines whether an input is readonly + (optional) defines whether an input is readonly, false by default hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -156,7 +156,7 @@ description: You can explore the Properties of the Input control of Form in the labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/radiogroup/api_radiogroup_properties.md b/docs/form/api/radiogroup/api_radiogroup_properties.md index d41556e8..9b74e448 100644 --- a/docs/form/api/radiogroup/api_radiogroup_properties.md +++ b/docs/form/api/radiogroup/api_radiogroup_properties.md @@ -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 @@ -111,31 +111,31 @@ description: You can explore the Properties of the RadioGroup and RadioButton co disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) defines whether a RadioGroup is hidden + (optional) defines whether a RadioGroup is hidden, false by default padding - (optional) sets padding between a cell and a border of a RadioGroup control + (optional) sets padding between a cell and a border of a RadioGroup control, "8px" by default required - (optional) defines whether a control is required + (optional) defines whether a control is required, false by default width - (optional) the width of a control + (optional) the width of a control, "content" by default hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -143,7 +143,7 @@ description: You can explore the Properties of the RadioGroup and RadioButton co labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/select/api_select_properties.md b/docs/form/api/select/api_select_properties.md index b6255bb7..e829b5c0 100644 --- a/docs/form/api/select/api_select_properties.md +++ b/docs/form/api/select/api_select_properties.md @@ -24,10 +24,10 @@ description: You can explore the Properties of the Select control of Form in the value?: string | number, 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?: (input: string | number | boolean) => boolean, width?: string | number | "content", // "content" by default @@ -82,23 +82,23 @@ description: You can explore the Properties of the Select control of Form in the disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) defines whether a control is hidden + (optional) defines whether a control is hidden, false by default padding - (optional) sets padding between a cell and a border of the Select control + (optional) sets padding between a cell and a border of the Select control, "8px" by default required - (optional) defines whether a control is required + (optional) defines whether a control is required, false by default validation @@ -106,7 +106,7 @@ description: You can explore the Properties of the Select control of Form in the width - (optional) the width of a control + (optional) the width of a control, "content" by default icon @@ -114,7 +114,7 @@ description: You can explore the Properties of the Select control of Form in the hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -122,7 +122,7 @@ description: You can explore the Properties of the Select control of Form in the labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/simplevault/api_simplevault_properties.md b/docs/form/api/simplevault/api_simplevault_properties.md index 1b0aec38..5f9d20a3 100644 --- a/docs/form/api/simplevault/api_simplevault_properties.md +++ b/docs/form/api/simplevault/api_simplevault_properties.md @@ -31,11 +31,11 @@ description: You can explore the Properties of the Simple Vault control of Form css?: string, height?: string | number | "content", // "content" by default width?: string | number | "content", // "content" by default - padding?: string | number, - hidden?: boolean, - disabled?: boolean, + padding?: string | number, // "8px" by default + hidden?: boolean, // false by default + disabled?: boolean, // false by default - fieldName?: string, + fieldName?: string, // "file" by default params?: { [key: string]: any, }, @@ -48,7 +48,7 @@ description: You can explore the Properties of the Simple Vault control of Form accept?: string, // all file types by default validation?: (value: object[]) => boolean; - required?: boolean, + required?: boolean, // false by default hiddenLabel?: boolean, // false by default label?: string, @@ -103,27 +103,27 @@ description: You can explore the Properties of the Simple Vault control of Form height - (optional) the height of a control + (optional) the height of a control, "content" by default width - (optional) the width of a control + (optional) the width of a control, "content" by default padding - (optional) sets padding between a cell and a border of the SimpleVault control + (optional) sets padding between a cell and a border of the SimpleVault control, "8px" by default hidden - (optional) defines whether a control is hidden + (optional) defines whether a control is hidden, false by default disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default fieldName - (optional) sets the name of the file field in the form data that is sent to the server, file by default + (optional) sets the name of the file field in the form data that is sent to the server, "file" by default params @@ -139,15 +139,15 @@ description: You can explore the Properties of the Simple Vault control of Form updateFromResponse - (optional) updates file attributes with the data from the server response + (optional) updates file attributes with the data from the server response, true by default autosend - (optional) enables/disables automatic sending of an added file (files won't be sent if they fail validation) + (optional) enables/disables automatic sending of an added file (files won't be sent if they fail validation), false by default accept - (optional) allows specifying the type/extension that will be displayed in the dialog window during the file selection. Check details + (optional) allows specifying the type/extension that will be displayed in the dialog window during the file selection. Check details, all file types by default validation @@ -155,11 +155,11 @@ description: You can explore the Properties of the Simple Vault control of Form required - (optional) defines whether a control is required + (optional) defines whether a control is required, false by default hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -167,7 +167,7 @@ description: You can explore the Properties of the Simple Vault control of Form labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/slider/api_slider_properties.md b/docs/form/api/slider/api_slider_properties.md index 20482c34..06e71444 100644 --- a/docs/form/api/slider/api_slider_properties.md +++ b/docs/form/api/slider/api_slider_properties.md @@ -16,10 +16,10 @@ description: You can explore the Properties of the Slider control of Form in the value?: number | number[], 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 inverse?: boolean, // false by default @@ -68,27 +68,27 @@ description: You can explore the Properties of the Slider control of Form in the disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) defines whether a control is hidden + (optional) defines whether a control is hidden, false by default padding - (optional) sets padding between a cell and a border of the Slider control + (optional) sets padding between a cell and a border of the Slider control, "8px" by default width - (optional) the width of a control + (optional) the width of a control, "content" by default inverse - (optional) enables/disables the inverse slider mode + (optional) enables/disables the inverse slider mode, false by default majorTick @@ -96,23 +96,23 @@ description: You can explore the Properties of the Slider control of Form in the max - (optional) the maximal value of slider, 100 by default + (optional) the maximal value of slider, 100 by default min - (optional) the minimal value of slider, 0 by default + (optional) the minimal value of slider, 0 by default mode - (optional) the direction of the Slider scale, "horizontal" by default + (optional) the direction of the Slider scale, "horizontal" by default range - (optional) enables/disables the possibility to select a range of values on the slider + (optional) enables/disables the possibility to select a range of values on the slider, false by default step - (optional) the step the slider thumb will be moved with, 1 by default + (optional) the step the slider thumb will be moved with, 1 by default tick @@ -124,11 +124,11 @@ description: You can explore the Properties of the Slider control of Form in the tooltip - (optional) enables prompt messages with ticks values on hovering over the slider thumb, true by default + (optional) enables prompt messages with ticks values on hovering over the slider thumb, true by default hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -136,7 +136,7 @@ description: You can explore the Properties of the Slider control of Form in the labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/spacer/api_spacer_properties.md b/docs/form/api/spacer/api_spacer_properties.md index 682cee7f..936216e1 100644 --- a/docs/form/api/spacer/api_spacer_properties.md +++ b/docs/form/api/spacer/api_spacer_properties.md @@ -16,8 +16,8 @@ description: You can explore the Properties of the Spacer control of Form in the css?: string, 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 } ~~~ @@ -44,19 +44,19 @@ description: You can explore the Properties of the Spacer control of Form in the height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) defines whether a control is hidden + (optional) defines whether a control is hidden, false by default padding - (optional) sets padding between a cell and a border of the Spacer control + (optional) sets padding between a cell and a border of the Spacer control, "8px" by default width - (optional) the width of a control + (optional) the width of a control, "content" by default diff --git a/docs/form/api/text/api_text_properties.md b/docs/form/api/text/api_text_properties.md index 0fcd7bbe..e20ad3ac 100644 --- a/docs/form/api/text/api_text_properties.md +++ b/docs/form/api/text/api_text_properties.md @@ -16,10 +16,10 @@ description: You can explore the Properties of the Text control of Form in the d value?: number | 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 inputType?: "text" | "password" | "number", // "text" by default @@ -62,31 +62,31 @@ description: You can explore the Properties of the Text control of Form in the d disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) defines whether a control is hidden + (optional) defines whether a control is hidden, false by default padding - (optional) sets padding between a cell and a border of the Text control + (optional) sets padding between a cell and a border of the Text control, "8px" by default width - (optional) the width of a control + (optional) the width of a control, "content" by default inputType - (optional) sets the type of an input: "text", "password", "number".
Using the "number" type for the input sets the type of the value attribute to "number".
Use the "password" value to specify a field for entering a password. + (optional) sets the type of an input: "text", "password", "number".
Using the "number" type for the input sets the type of the value attribute to "number".
Use the "password" value to specify a field for entering a password. "text" by default hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -94,7 +94,7 @@ description: You can explore the Properties of the Text control of Form in the d labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/textarea/api_textarea_properties.md b/docs/form/api/textarea/api_textarea_properties.md index 53fc6bdf..db20cb21 100644 --- a/docs/form/api/textarea/api_textarea_properties.md +++ b/docs/form/api/textarea/api_textarea_properties.md @@ -16,19 +16,19 @@ description: You can explore the Properties of the Textarea control of Form in t 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 validation?: string | (input: string | number) => boolean, width?: string | number | "content", // "content" by default maxlength?: number | string, minlength?: number | string, - placeholder?: string, + placeholder?: string, readOnly?: boolean, // false by default - resizable?: boolean, + resizable?: boolean, // false by default hiddenLabel?: boolean, // false by default label?: string, @@ -68,23 +68,23 @@ description: You can explore the Properties of the Textarea control of Form in t disabled - (optional) defines whether a control is enabled (false) or disabled (true) + (optional) defines whether a control is enabled (false) or disabled (true), false by default height - (optional) the height of a control + (optional) the height of a control, "content" by default hidden - (optional) defines whether a control is hidden + (optional) defines whether a control is hidden, false by default padding - (optional) sets padding between a cell and a border of the Textarea control + (optional) sets padding between a cell and a border of the Textarea control, "8px" by default required - (optional) defines whether a control is required + (optional) defines whether a control is required, false by default validation @@ -103,7 +103,7 @@ description: You can explore the Properties of the Textarea control of Form in t width - (optional) the width of a control + (optional) the width of a control, "content" by default maxlength @@ -119,15 +119,15 @@ description: You can explore the Properties of the Textarea control of Form in t readOnly - (optional) defines whether a textarea is readonly + (optional) defines whether a textarea is readonly, false by default resizable - (optional) adds a resizer icon into a textarea, if set to true + (optional) adds a resizer icon into a textarea, if set to true, false by default hiddenLabel - (optional) makes the label invisible + (optional) makes the label invisible, false by default label @@ -135,7 +135,7 @@ description: You can explore the Properties of the Textarea control of Form in t labelPosition - (optional) defines the position of a label: "left"|"top" + (optional) defines the position of a label: "left" | "top", "top" by default labelWidth diff --git a/docs/form/api/timepicker/api_timepicker_properties.md b/docs/form/api/timepicker/api_timepicker_properties.md index e9464d6c..87b0e5a9 100644 --- a/docs/form/api/timepicker/api_timepicker_properties.md +++ b/docs/form/api/timepicker/api_timepicker_properties.md @@ -16,11 +16,11 @@ description: You can explore the Properties of the Timepicker control of Form in value?: Date | number | string | array | object, 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?: (input: string) => boolean, width?: string | number | "content", // "content" by default @@ -58,22 +58,22 @@ description: You can explore the Properties of the Timepicker control of Form in - for the `24-hour` format contains key:value pairs for hours, minutes and their values:
`{hour: 0, minute: 39}` - for the `12-hour` format contains key:value pairs for hours, minutes, am/pm identifiers and their values:
`{hour: 6, minute: 0, AM: true}` - `css` - (optional) adds style classes to a control -- `disabled` - (optional) defines whether a control is enabled (false) or disabled (true) -- `editable` - (optional) allows a user to enter the value of the control manually -- `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 the TimePicker control -- `required` - (optional) defines whether a control is required +- `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default +- `editable` - (optional) allows a user to enter the value of the control manually, *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 the TimePicker control, *"8px"* by default +- `required` - (optional) defines whether a control is required, *false* by default - `validation` - (optional) [the validation function](form/work_with_form.md#validation-rules), takes as a parameter the value to validate and returns true/false to indicate the result of validation -- `width` - (optional) the width of a control -- `controls` - (optional) defines whether a timepicker is equipped with the Close and Save buttons +- `width` - (optional) the width of a control, *"content"* by default +- `controls` - (optional) defines whether a timepicker is equipped with the Close and Save buttons, *false* by default - `icon` - (optional) the name of an icon from the used icon font - `placeholder` - (optional) a tip for the input -- `timeFormat` - (optional) defines what clock format is activated: the 12-hour or 24-hour one. Set the property to 12 or 24 (default) value, correspondingly -- `valueFormat` - (optional) defines the format of the value to be applied when working with the events of the timepicker control: "string", "timeObject" -- `hiddenLabel` - (optional) makes the label invisible +- `timeFormat` - (optional) defines what clock format is activated: the 12-hour or 24-hour one. Set the property to 12 or 24 (default) value, correspondingly, *24* by default +- `valueFormat` - (optional) defines the format of the value to be applied when working with the events of the timepicker control: "string" (default), "timeObject" +- `hiddenLabel` - (optional) makes the label invisible, *false* by default - `label` - (optional) specifies a label for a control -- `labelPosition` - (optional) defines the position of a label: "left"|"top" +- `labelPosition` - (optional) defines the position of a label: "left" | "top" (default) - `labelWidth` - (optional) sets the width of the label of a control - `helpMessage` - (optional) adds a help message to a control - `preMessage` - (optional) a message that contains instructions for interacting with the control diff --git a/docs/form/api/toggle/api_toggle_properties.md b/docs/form/api/toggle/api_toggle_properties.md index 8c83fb03..c4ea6746 100644 --- a/docs/form/api/toggle/api_toggle_properties.md +++ b/docs/form/api/toggle/api_toggle_properties.md @@ -14,11 +14,11 @@ description: You can explore the Properties of the Toggle control of Form in the name?: string, id?: string, - hidden?: boolean, - disabled?: boolean, - selected?: boolean, + hidden?: boolean, // false by default + disabled?: boolean, // false by default + selected?: boolean, // false by default - full?: boolean, + full?: boolean, // false by default text?: string, icon?: string, offText?: string, @@ -26,9 +26,9 @@ description: You can explore the Properties of the Toggle control of Form in the value?: string | number, 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 } ~~~ @@ -37,19 +37,19 @@ description: You can explore the Properties of the Toggle control of Form in the - `type` - (required) the type of a control, set it to "toggle" - `name` - (optional) the name of a control - `id` - (optional) the id of a control, auto-generated if not set -- `hidden`- (optional) defines whether a toggle is hidden -- `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*) +- `hidden`- (optional) defines whether a toggle is hidden, *false* by default +- `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default - `selected` - (optional) defines the initial state of the toggle as selected (pressed), *false* by default - `full` - (optional) defines whether the toggle will be extended to the width specified by the **width** property, *false* by default -- `text` - (optional) sets a text inside the toggle. When initialized together with the **offText** property, the specified text will be rendered in the selected (pressed) state, "" (empty string) by default -- `offText` - (optional) sets the text that will be rendered in the unselected (unpressed) state of the toggle, "" (empty string) by default -- `icon` - (optional) sets the class of an icon displayed inside the toggle. When initialized together with the **offIcon** property, the specified classes of icons will be rendered in the selected (pressed) state of the toggle,"" (empty string) by default -- `offIcon` - (optional) sets the class of an icon that will be rendered in the unselected (unpressed) state of the toggle, "" (empty string) by default -- `value` - (optional) specifies the value in the selected (pressed) state. If not defined, the **selected** property with the boolean value is used instead, *undefined* by default +- `text` - (optional) sets a text inside the toggle. When initialized together with the **offText** property, the specified text will be rendered in the selected (pressed) state +- `offText` - (optional) sets the text that will be rendered in the unselected (unpressed) state of the toggle +- `icon` - (optional) sets the class of an icon displayed inside the toggle. When initialized together with the **offIcon** property, the specified classes of icons will be rendered in the selected (pressed) state of the toggle +- `offIcon` - (optional) sets the class of an icon that will be rendered in the unselected (unpressed) state of the toggle +- `value` - (optional) specifies the value in the selected (pressed) state. If not defined, the **selected** property with the boolean value is used instead - `css` - (optional) adds style classes to a control -- `height` - (optional) the height of a control -- `width` - (optional) the width of a control -- `padding` - (optional) sets padding between a cell and a border of a Toggle control +- `height` - (optional) the height of a control, *"content"* by default +- `width` - (optional) the width of a control, *"content"* by default +- `padding` - (optional) sets padding between a cell and a border of a Toggle control, *"8px"* by default ### Example diff --git a/docs/form/api/togglegroup/api_togglegroup_properties.md b/docs/form/api/togglegroup/api_togglegroup_properties.md index 529db5d6..af653f54 100644 --- a/docs/form/api/togglegroup/api_togglegroup_properties.md +++ b/docs/form/api/togglegroup/api_togglegroup_properties.md @@ -14,12 +14,12 @@ description: You can explore the Properties of the Toggle Group control of Form name?: string, id?: string, - hidden?: boolean, - disabled?: boolean, + hidden?: boolean, // false by default + disabled?: boolean, // false by default - full?: boolean, - gap?: number, - multiselect?: boolean, + full?: boolean, // false by default + gap?: number, // 0 by default + multiselect?: boolean, // false by default options: [ { @@ -40,9 +40,9 @@ description: You can explore the Properties of the Toggle Group control of Form }; 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 } ~~~ @@ -56,7 +56,7 @@ description: You can explore the Properties of the Toggle Group control of Form - `hidden`- (optional) defines whether a ToggleGroup is hidden, *false* by default - `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default - `full` - (optional) defines whether the ToggleGroup will be extended to the width specified by the **width** property, *false* by default -- `gap` - (optional) sets an offset between the elements (buttons) of an option +- `gap` - (optional) sets an offset between the elements (buttons) of an option, *0* by default - `multiselection` - (optional) defines the behavior that allows a multiple choice, *false* by default - `options` - (required) an array of ToggleGroup elements. An object of an element can contain the following attributes: - `id` - (optional) the id of a control, auto-generated if not set @@ -64,17 +64,17 @@ description: You can explore the Properties of the Toggle Group control of Form - `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default - `selected` - (optional) defines the initial state of the toggle as selected (pressed), *false* by default - `full` - (optional) defines whether the toggle will be extended to the width specified by the **width** property, *false* by default - - `text` - (optional) sets a text inside the toggle. When initialized together with the **offText** property, the specified text will be rendered in the selected (pressed) state, "" (empty string) by default - - `offText` - (optional) sets the text that will be rendered in the unselected (unpressed) state of the toggle, "" (empty string) by default - - `icon` - (optional) sets the class of an icon displayed inside the toggle. When initialized together with the **offIcon** property, the specified classes of icons will be rendered in the selected (pressed) state of the toggle,"" (empty string) by default - - `offIcon` - (optional) sets the class of an icon that will be rendered in the unselected (unpressed) state of the toggle, "" (empty string) by default - - `value` - (optional) specifies the value in the selected (pressed) state. If not defined, the **selected** property with the boolean value is used instead, *undefined* by default + - `text` - (optional) sets a text inside the toggle. When initialized together with the **offText** property, the specified text will be rendered in the selected (pressed) state + - `offText` - (optional) sets the text that will be rendered in the unselected (unpressed) state of the toggle + - `icon` - (optional) sets the class of an icon displayed inside the toggle. When initialized together with the **offIcon** property, the specified classes of icons will be rendered in the selected (pressed) state of the toggle + - `offIcon` - (optional) sets the class of an icon that will be rendered in the unselected (unpressed) state of the toggle + - `value` - (optional) specifies the value in the selected (pressed) state. If not defined, the **selected** property with the boolean value is used instead - `value` - (optional) defines the state of elements on initialization. As a value it takes an object presented as a *key:value* pair, where the key is the id of an element and the value is the initial state of the element. It takes priority over the state of an element set in its configuration object - `[id: string]: boolean` - sets the state of an element - `css` - (optional) adds style classes to a control -- `height` - (optional) the height of a control -- `width` - (optional) the width of a control -- `padding` - (optional) sets padding between a cell and a border of a ToggleGroup control +- `height` - (optional) the height of a control, *"content"* by default +- `width` - (optional) the width of a control, *"content"* by default +- `padding` - (optional) sets padding between a cell and a border of a ToggleGroup control, *"8px"* by default ### Properties of a Toggle of ToggleGroup @@ -83,11 +83,11 @@ description: You can explore the Properties of the Toggle Group control of Form - `disabled` - (optional) defines whether a control is enabled (*false*) or disabled (*true*), *false* by default - `selected` - (optional) defines the initial state of the toggle as selected (pressed), *false* by default - `full` - (optional) defines whether the toggle will be extended to the width specified by the **width** property, *false* by default -- `text` - (optional) sets a text inside the toggle. When initialized together with the **offText** property, the specified text will be rendered in the selected (pressed) state, "" (empty string) by default -- `offText` - (optional) sets the text that will be rendered in the unselected (unpressed) state of the toggle, "" (empty string) by default -- `icon` - (optional) sets the class of an icon displayed inside the toggle. When initialized together with the **offIcon** property, the specified classes of icons will be rendered in the selected (pressed) state of the toggle,"" (empty string) by default -- `offIcon` - (optional) sets the class of an icon that will be rendered in the unselected (unpressed) state of the toggle, "" (empty string) by default -- `value` - (optional) specifies the value in the selected (pressed) state. If not defined, the **selected** property with the boolean value is used instead, *undefined* by default +- `text` - (optional) sets a text inside the toggle. When initialized together with the **offText** property, the specified text will be rendered in the selected (pressed) state +- `offText` - (optional) sets the text that will be rendered in the unselected (unpressed) state of the toggle +- `icon` - (optional) sets the class of an icon displayed inside the toggle. When initialized together with the **offIcon** property, the specified classes of icons will be rendered in the selected (pressed) state of the toggle +- `offIcon` - (optional) sets the class of an icon that will be rendered in the unselected (unpressed) state of the toggle +- `value` - (optional) specifies the value in the selected (pressed) state. If not defined, the **selected** property with the boolean value is used instead ### Example