From c0f6f7da3c44fb7f74be058d0be2c1e5261cecdf Mon Sep 17 00:00:00 2001 From: Masha_Rudenko Date: Mon, 28 Aug 2023 15:02:32 +0300 Subject: [PATCH] [fix] descriptions of form controls events --- docs/form/api/calendar/calendar_beforechange_event.md | 2 +- docs/form/api/checkbox/checkbox_beforechange_event.md | 2 +- .../api/checkbox_group/checkboxgroup_beforechange_event.md | 2 +- docs/form/api/colorpicker/colorpicker_beforechange_event.md | 2 +- docs/form/api/form_beforechange_event.md | 2 +- docs/form/api/form_blur_event.md | 2 +- docs/form/api/form_focus_event.md | 2 +- docs/form/api/input/input_beforechange_event.md | 2 +- docs/form/api/radiogroup/radiogroup_beforechange_event.md | 2 +- docs/form/api/select/select_beforechange_event.md | 2 +- docs/form/api/slider/slider_beforechange_event.md | 2 +- docs/form/api/textarea/textarea_beforechange_event.md | 2 +- docs/form/api/timepicker/timepicker_beforechange_event.md | 2 +- docs/form/api/toggle/toggle_beforechange_event.md | 2 +- docs/form/api/togglegroup/togglegroup_beforechange_event.md | 2 +- docs/whatsnew.md | 4 ++-- 16 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/form/api/calendar/calendar_beforechange_event.md b/docs/form/api/calendar/calendar_beforechange_event.md index dada87a5..cd61647b 100644 --- a/docs/form/api/calendar/calendar_beforechange_event.md +++ b/docs/form/api/calendar/calendar_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Datepicker control of @signature: {'beforeChange: (value: string | Date) => boolean | void;'} @params: -- `value: string | Date` - the current value of the control +- `value: string | Date` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/checkbox/checkbox_beforechange_event.md b/docs/form/api/checkbox/checkbox_beforechange_event.md index 48fa0628..d4675342 100644 --- a/docs/form/api/checkbox/checkbox_beforechange_event.md +++ b/docs/form/api/checkbox/checkbox_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Checkbox control of F @signature: {'beforeChange: (value: string | boolean) => boolean | void;'} @params: -- `value: string | boolean` - the current value of the control +- `value: string | boolean` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/checkbox_group/checkboxgroup_beforechange_event.md b/docs/form/api/checkbox_group/checkboxgroup_beforechange_event.md index 7bcdf976..23a457cc 100644 --- a/docs/form/api/checkbox_group/checkboxgroup_beforechange_event.md +++ b/docs/form/api/checkbox_group/checkboxgroup_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Checkbox Group contro @signature: {'beforeChange: (value: {[id: string]: boolean | string}) => boolean | void;'} @params: -- `value: object` - the current value of the control. The object contains a set of key:value pairs where key is the id of a checkbox and value is the value/state of the checkbox. +- `value: object` - the value to be set for the control. The object contains a set of the key:value pairs where the key is the id of a checkbox and the value is the value/state of the checkbox @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/colorpicker/colorpicker_beforechange_event.md b/docs/form/api/colorpicker/colorpicker_beforechange_event.md index a6d80816..14269fe2 100644 --- a/docs/form/api/colorpicker/colorpicker_beforechange_event.md +++ b/docs/form/api/colorpicker/colorpicker_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Colorpicker control o @signature: {'beforeChange: (value: string) => boolean | void;'} @params: -- `value: string` - the current value of the control +- `value: string` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/form_beforechange_event.md b/docs/form/api/form_beforechange_event.md index 25669cef..376e1a41 100644 --- a/docs/form/api/form_beforechange_event.md +++ b/docs/form/api/form_beforechange_event.md @@ -12,7 +12,7 @@ description: You can explore the beforeChange event of Form in the documentation @params: - `name | id: string` - the name (or id, if the name is not specified) of the Form control -- `value: any` - the value set for the control +- `value: any` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/form_blur_event.md b/docs/form/api/form_blur_event.md index add9900b..b9efef08 100644 --- a/docs/form/api/form_blur_event.md +++ b/docs/form/api/form_blur_event.md @@ -16,7 +16,7 @@ description: You can explore the blur event of Form in the documentation of the - `id: string` - optional, the id of the element of the control of Form (for RadioGroup, CheckboxGroup) @example: -form.event.on("blur", function(name, value, id) { +form.events.on("blur", function(name, value, id) { console.log(name, value, id); }); @examplestop: diff --git a/docs/form/api/form_focus_event.md b/docs/form/api/form_focus_event.md index 93c42cf9..8967320c 100644 --- a/docs/form/api/form_focus_event.md +++ b/docs/form/api/form_focus_event.md @@ -16,7 +16,7 @@ description: You can explore the focus event of Form in the documentation of the - `id: string` - optional, the id of the element of the control of Form (for RadioGroup, CheckboxGroup) @example: -form.event.on("focus", function(name, value, id) { +form.events.on("focus", function(name, value, id) { console.log(name, value); }); @examplestop: diff --git a/docs/form/api/input/input_beforechange_event.md b/docs/form/api/input/input_beforechange_event.md index fb36d3ab..736582c2 100644 --- a/docs/form/api/input/input_beforechange_event.md +++ b/docs/form/api/input/input_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Input control of Form @signature: {'beforeChange: (value: string | number) => boolean | void;'} @params: -- `value: string | number` - the current value of the control +- `value: string | number` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/radiogroup/radiogroup_beforechange_event.md b/docs/form/api/radiogroup/radiogroup_beforechange_event.md index a9dc1bf2..4291dc87 100644 --- a/docs/form/api/radiogroup/radiogroup_beforechange_event.md +++ b/docs/form/api/radiogroup/radiogroup_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Radiogroup control of @signature: {'beforeChange: (value: string) => boolean | void;'} @params: -- `value: string` - the current value of the control +- `value: string` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/select/select_beforechange_event.md b/docs/form/api/select/select_beforechange_event.md index b0445034..0f6f2f7c 100644 --- a/docs/form/api/select/select_beforechange_event.md +++ b/docs/form/api/select/select_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Select control of For @signature: {'beforeChange: (value: string | number) => boolean | void;'} @params: -- `value: string | number` - the current value of the control +- `value: string | number` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/slider/slider_beforechange_event.md b/docs/form/api/slider/slider_beforechange_event.md index d07dd2b2..7e063971 100644 --- a/docs/form/api/slider/slider_beforechange_event.md +++ b/docs/form/api/slider/slider_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Slider control of For @signature: {'beforeChange: (value: number[]) => boolean | void;'} @params: -- `value: number[]` - the current value of the control +- `value: number[]` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/textarea/textarea_beforechange_event.md b/docs/form/api/textarea/textarea_beforechange_event.md index 9724ca30..8e3e815c 100644 --- a/docs/form/api/textarea/textarea_beforechange_event.md +++ b/docs/form/api/textarea/textarea_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Textarea control of F @signature: {'beforeChange: (value: string) => boolean | void;'} @params: -- `value: string` - the current value of the control +- `value: string` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/timepicker/timepicker_beforechange_event.md b/docs/form/api/timepicker/timepicker_beforechange_event.md index d5e1c602..7c9739c8 100644 --- a/docs/form/api/timepicker/timepicker_beforechange_event.md +++ b/docs/form/api/timepicker/timepicker_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Timepicker control of @signature: {'beforeChange: (value: string | object) => boolean | void;'} @params: -- `value: string | object` - the current value of the control +- `value: string | object` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/toggle/toggle_beforechange_event.md b/docs/form/api/toggle/toggle_beforechange_event.md index 6ec712cd..1ba81869 100644 --- a/docs/form/api/toggle/toggle_beforechange_event.md +++ b/docs/form/api/toggle/toggle_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Toggle control of For @signature: {'beforeChange: (value: string | number | boolean) => boolean | void;'} @params: -- `value: string | number | boolean` - the current value of the control +- `value: string | number | boolean` - the value to be set for the control @returns: Return `false` to prevent changing the value of the control; otherwise, `true`. diff --git a/docs/form/api/togglegroup/togglegroup_beforechange_event.md b/docs/form/api/togglegroup/togglegroup_beforechange_event.md index 85830512..ea57fb03 100644 --- a/docs/form/api/togglegroup/togglegroup_beforechange_event.md +++ b/docs/form/api/togglegroup/togglegroup_beforechange_event.md @@ -11,7 +11,7 @@ description: You can explore the beforeChange event of the Toggle Group control @signature: {'beforeChange: (value: {[id: string]: string | number |boolean}) => boolean | void;'} @params: -- `value: object` - the current value of the control. The object contains a set of key:value pairs where key is the id of a toggle and value is the value/state of the toggle +- `value: object` - the value to be set for the control. The object contains a set of the key:value pairs where the key is the id of a toggle and the value is the value/state of the toggle @returns: Return `false` to prevent changing the value of the control; otherwise, `true` diff --git a/docs/whatsnew.md b/docs/whatsnew.md index 50093d11..6c475958 100644 --- a/docs/whatsnew.md +++ b/docs/whatsnew.md @@ -19,7 +19,7 @@ Released on August 28, 2023 #### DataCollection/TreeCollection -- New [filter](data_collection/api/datacollection_filter_event.md) event and [resetFilter()](data_collection/api/datacollection_resetfilter_method.md), [getFilter()](data_collection/api/datacollection_getfilters_method.md) methods +- New [filter](data_collection/api/datacollection_filter_event.md) event and [resetFilter()](data_collection/api/datacollection_resetfilter_method.md), [getFilters()](data_collection/api/datacollection_getfilters_method.md) methods #### Grid/TreeGrid @@ -35,7 +35,7 @@ Released on August 28, 2023 #### Chart -- The [series](chart/api/chart_series_config.md) configuration property is extended with the **label** option for setting the text of the legend for a series (for "line", "spline", "bar", "x-bar", "area", "splineArea", "radar", "scatter" chart types) +- The [series](chart/api/chart_series_config.md) configuration property is extended with the **label** option for setting the text of the legend for a series (for the "line", "spline", "bar", "x-bar", "area", "splineArea", "radar", "scatter" chart types) #### DataCollection/TreeCollection