@syncfusion/ej2-inputs 20.4.40 → 20.4.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/CHANGELOG.md +7 -1
  2. package/README.md +1 -1
  3. package/dist/ej2-inputs.min.js +2 -2
  4. package/dist/ej2-inputs.umd.min.js +2 -2
  5. package/dist/ej2-inputs.umd.min.js.map +1 -1
  6. package/dist/es6/ej2-inputs.es2015.js +60 -39
  7. package/dist/es6/ej2-inputs.es2015.js.map +1 -1
  8. package/dist/es6/ej2-inputs.es5.js +61 -39
  9. package/dist/es6/ej2-inputs.es5.js.map +1 -1
  10. package/dist/global/ej2-inputs.min.js +2 -2
  11. package/dist/global/ej2-inputs.min.js.map +1 -1
  12. package/dist/global/index.d.ts +1 -1
  13. package/package.json +9 -9
  14. package/src/common/signature-base.js +2 -0
  15. package/src/rating/rating-model.d.ts +57 -41
  16. package/src/rating/rating.d.ts +88 -56
  17. package/src/rating/rating.js +52 -32
  18. package/src/uploader/uploader.js +8 -8
  19. package/styles/bootstrap-dark.css +5 -0
  20. package/styles/bootstrap.css +5 -0
  21. package/styles/bootstrap4.css +5 -0
  22. package/styles/bootstrap5-dark.css +5 -0
  23. package/styles/bootstrap5.css +5 -0
  24. package/styles/color-picker/_layout.scss +14 -0
  25. package/styles/color-picker/fluent-dark.css +6 -0
  26. package/styles/color-picker/fluent.css +6 -0
  27. package/styles/fabric-dark.css +5 -0
  28. package/styles/fabric.css +5 -0
  29. package/styles/fluent-dark.css +12 -1
  30. package/styles/fluent.css +12 -1
  31. package/styles/highcontrast-light.css +5 -0
  32. package/styles/highcontrast.css +5 -0
  33. package/styles/input/_layout.scss +1 -0
  34. package/styles/input/bootstrap-dark.css +1 -0
  35. package/styles/input/bootstrap.css +1 -0
  36. package/styles/input/bootstrap4.css +1 -0
  37. package/styles/input/bootstrap5-dark.css +1 -0
  38. package/styles/input/bootstrap5.css +1 -0
  39. package/styles/input/fabric-dark.css +1 -0
  40. package/styles/input/fabric.css +1 -0
  41. package/styles/input/fluent-dark.css +1 -0
  42. package/styles/input/fluent.css +1 -0
  43. package/styles/input/highcontrast-light.css +1 -0
  44. package/styles/input/highcontrast.css +1 -0
  45. package/styles/input/material-dark.css +1 -0
  46. package/styles/input/material.css +1 -0
  47. package/styles/input/tailwind-dark.css +1 -0
  48. package/styles/input/tailwind.css +1 -0
  49. package/styles/material-dark.css +5 -0
  50. package/styles/material.css +5 -0
  51. package/styles/rating/_bootstrap-dark-definition.scss +1 -0
  52. package/styles/rating/_bootstrap-definition.scss +1 -0
  53. package/styles/rating/_bootstrap4-definition.scss +1 -0
  54. package/styles/rating/_bootstrap5-definition.scss +1 -0
  55. package/styles/rating/_fabric-dark-definition.scss +1 -0
  56. package/styles/rating/_fabric-definition.scss +1 -0
  57. package/styles/rating/_fluent-definition.scss +1 -0
  58. package/styles/rating/_fusionnew-definition.scss +1 -0
  59. package/styles/rating/_highcontrast-definition.scss +1 -0
  60. package/styles/rating/_highcontrast-light-definition.scss +1 -0
  61. package/styles/rating/_layout.scss +6 -1
  62. package/styles/rating/_material-dark-definition.scss +1 -0
  63. package/styles/rating/_material-definition.scss +1 -0
  64. package/styles/rating/_material3-definition.scss +1 -0
  65. package/styles/rating/_tailwind-definition.scss +1 -0
  66. package/styles/rating/bootstrap-dark.css +4 -0
  67. package/styles/rating/bootstrap.css +4 -0
  68. package/styles/rating/bootstrap4.css +4 -0
  69. package/styles/rating/bootstrap5-dark.css +4 -0
  70. package/styles/rating/bootstrap5.css +4 -0
  71. package/styles/rating/fabric-dark.css +4 -0
  72. package/styles/rating/fabric.css +4 -0
  73. package/styles/rating/fluent-dark.css +5 -1
  74. package/styles/rating/fluent.css +5 -1
  75. package/styles/rating/highcontrast-light.css +4 -0
  76. package/styles/rating/highcontrast.css +4 -0
  77. package/styles/rating/material-dark.css +4 -0
  78. package/styles/rating/material.css +4 -0
  79. package/styles/rating/tailwind-dark.css +4 -0
  80. package/styles/rating/tailwind.css +4 -0
  81. package/styles/tailwind-dark.css +5 -0
  82. package/styles/tailwind.css +5 -0
@@ -1,6 +1,6 @@
1
1
  /*!
2
2
  * filename: index.d.ts
3
- * version : 20.4.40
3
+ * version : 20.4.48
4
4
  * Copyright Syncfusion Inc. 2001 - 2020. All rights reserved.
5
5
  * Use of this code is subject to the terms of our license.
6
6
  * A copy of the current license can be obtained at any time by e-mailing
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "_from": "@syncfusion/ej2-inputs@*",
3
- "_id": "@syncfusion/ej2-inputs@20.4.38",
3
+ "_id": "@syncfusion/ej2-inputs@20.4.42",
4
4
  "_inBundle": false,
5
- "_integrity": "sha512-1BObDYS1OiYXHlM3ofwW3AJcOjefONr4guSezY9GGkIeYTd9u+Hp6wXXIDPJySebgTxM3vBPld6r3d3KsoOnrw==",
5
+ "_integrity": "sha512-cjzaMmmmfNG3GwYbZw1nMEqn2i4S+KZpDTM37zRWdIvcEkBTyMF/d1XU+sqEK24/HclUdaMAJu7yZfmzxfCAxg==",
6
6
  "_location": "/@syncfusion/ej2-inputs",
7
7
  "_phantomChildren": {},
8
8
  "_requested": {
@@ -39,8 +39,8 @@
39
39
  "/@syncfusion/ej2-schedule",
40
40
  "/@syncfusion/ej2-vue-inputs"
41
41
  ],
42
- "_resolved": "https://nexus.syncfusion.com/repository/ej2-hotfix-new/@syncfusion/ej2-inputs/-/ej2-inputs-20.4.38.tgz",
43
- "_shasum": "63b3cd6b432a40223cd32e60ddfd4f4f5c61e430",
42
+ "_resolved": "https://nexus.syncfusion.com/repository/ej2-hotfix-new/@syncfusion/ej2-inputs/-/ej2-inputs-20.4.42.tgz",
43
+ "_shasum": "c75a231b3cd6ebaa687dc98d96318ef77b79b97d",
44
44
  "_spec": "@syncfusion/ej2-inputs@*",
45
45
  "_where": "/jenkins/workspace/ease-automation_release_19.1.0.1/packages/included",
46
46
  "author": {
@@ -48,10 +48,10 @@
48
48
  },
49
49
  "bundleDependencies": false,
50
50
  "dependencies": {
51
- "@syncfusion/ej2-base": "~20.4.40",
52
- "@syncfusion/ej2-buttons": "~20.4.40",
53
- "@syncfusion/ej2-popups": "~20.4.40",
54
- "@syncfusion/ej2-splitbuttons": "~20.4.40"
51
+ "@syncfusion/ej2-base": "~20.4.48",
52
+ "@syncfusion/ej2-buttons": "~20.4.48",
53
+ "@syncfusion/ej2-popups": "~20.4.48",
54
+ "@syncfusion/ej2-splitbuttons": "~20.4.48"
55
55
  },
56
56
  "deprecated": false,
57
57
  "description": "A package of Essential JS 2 input components such as Textbox, Color-picker, Masked-textbox, Numeric-textbox, Slider, Upload, and Form-validator that is used to get input from the users.",
@@ -119,7 +119,7 @@
119
119
  "url": "https://github.com/syncfusion/ej2-javascript-ui-controls/tree/master/controls/inputs"
120
120
  },
121
121
  "typings": "index.d.ts",
122
- "version": "20.4.40",
122
+ "version": "20.4.48",
123
123
  "sideEffects": false,
124
124
  "homepage": "https://www.syncfusion.com/javascript-ui-controls"
125
125
  }
@@ -663,6 +663,7 @@ var SignatureBase = /** @class */ (function (_super) {
663
663
  * @returns {void}.
664
664
  */
665
665
  SignatureBase.prototype.draw = function (text, fontFamily, fontSize) {
666
+ var args = { actionName: 'draw-text' };
666
667
  this.canvasContext.clearRect(0, 0, this.canvasContext.canvas.width, this.canvasContext.canvas.height);
667
668
  fontFamily = fontFamily || 'Arial';
668
669
  fontSize = fontSize || 30;
@@ -672,6 +673,7 @@ var SignatureBase = /** @class */ (function (_super) {
672
673
  this.canvasContext.fillText(text, this.element.width / 2, this.element.height / 2);
673
674
  this.updateSnapCollection();
674
675
  this.isSignatureEmpty = false;
676
+ this.trigger('change', args);
675
677
  };
676
678
  /**
677
679
  * To load the signature with the given base 64 string, height and width.
@@ -1,4 +1,4 @@
1
- import { addClass, Event, attributes, BaseEventArgs, compile, Component, EmitType, EventHandler, getUniqueID, INotifyPropertyChanged, select } from '@syncfusion/ej2-base';import { isNullOrUndefined, KeyboardEventArgs, KeyboardEvents, MouseEventArgs, NotifyPropertyChanges, Property, remove, removeClass } from '@syncfusion/ej2-base';import { Tooltip } from '@syncfusion/ej2-popups';
1
+ import { addClass, Event, attributes, BaseEventArgs, compile, Component, EmitType, EventHandler, getUniqueID, INotifyPropertyChanged, select, Browser } from '@syncfusion/ej2-base';import { isNullOrUndefined, KeyboardEventArgs, KeyboardEvents, MouseEventArgs, NotifyPropertyChanges, Property, remove, removeClass } from '@syncfusion/ej2-base';import { Tooltip } from '@syncfusion/ej2-popups';
2
2
  import {LabelPosition,PrecisionType,RatingItemEventArgs,RatingHoverEventArgs,RatingChangedEventArgs} from "./rating";
3
3
  import {ComponentModel} from '@syncfusion/ej2-base';
4
4
 
@@ -8,60 +8,64 @@ import {ComponentModel} from '@syncfusion/ej2-base';
8
8
  export interface RatingModel extends ComponentModel{
9
9
 
10
10
  /**
11
- * Defines whether to show or hide the reset button.
12
- * If min is not zero, then reset button won’t be displayed regardless of allowReset value.
11
+ * Defines whether to show or hide the reset button in a rating component.
12
+ * When set to "true", the reset button will be visible to the user, and they will be able to click it to reset the rating value to its default value.
13
13
  *
14
14
  * @default false
15
15
  */
16
16
  allowReset?: boolean;
17
17
 
18
18
  /**
19
- * Defines the CSS class to customize the rating appearance.
19
+ * Defines one or more CSS classes that can be used to customize the appearance of a rating component.
20
+ * One or more CSS classes to customize the appearance of the rating component, such as by changing its colors, fonts, sizes, or other visual aspects.
20
21
  *
21
22
  * @default ''
22
23
  */
23
24
  cssClass?: string;
24
25
 
25
26
  /**
26
- * Defines whether the rating is enabled or disabled.
27
+ * Defines whether a rating component is enabled or disabled.
28
+ * A disabled rating component may have a different visual appearance than an enabled one.
29
+ * When set to "true", the rating component will be disabled, and the user will not be able to interact with it.
27
30
  *
28
31
  * @default false
29
32
  */
30
33
  disabled?: boolean;
31
34
 
32
35
  /**
33
- * Defines whether to add animation when an item is hovered.
36
+ * Defines the template that defines the appearance of each un-rated item in a rating component.
34
37
  *
35
- * @default true
38
+ * @default ''
36
39
  */
37
- enableAnimation?: boolean;
40
+ emptyTemplate?: string;
38
41
 
39
42
  /**
40
- * Defines the template content for each item when it is not selected.
41
- * The template context will contain the current item value for customization.
43
+ * Defines whether to add animation (to provide visual feedback to the user) when an item in a rating component is hovered.
44
+ * When set to "true", an animation will be added when the user hovers their cursor over an item in the rating component.
42
45
  *
43
- * @default ''
46
+ * @default true
44
47
  */
45
- emptyTemplate?: string;
48
+ enableAnimation?: boolean;
46
49
 
47
50
  /**
48
- * Defines whether to enable single selection like radio button or not.
49
- * If not enabled all the items before the selected item will also be in the selected state.
51
+ * Defines whether to select all the items before the selected item should be in selected state in a rating component.
52
+ * When set to "true", only the selected item will be in the selected state, and all other items will be un-selected.
53
+ * When set to "false", all items before the selected one will be in the selected state.
50
54
  *
51
55
  * @default false
52
56
  */
53
57
  enableSingleSelection?: boolean;
54
58
 
55
59
  /**
56
- * Defines the template content for each item when it is selected.
57
- * The template context will contain the current item value for customization.
60
+ * Defines the template that defines the appearance of each rated item in a rating component.
58
61
  *
59
62
  * @default ''
60
63
  */
61
64
  fullTemplate?: string;
62
65
 
63
66
  /**
64
- * Defines the number of rating items.
67
+ * Defines the specific number of items (symbols) in rating component.
68
+ * The rating component typically consists of a number of items, such as stars or other symbols, that represent the rating value.
65
69
  *
66
70
  * @default 5
67
71
  * @aspType int
@@ -69,11 +73,13 @@ export interface RatingModel extends ComponentModel{
69
73
  itemsCount?: number;
70
74
 
71
75
  /**
72
- * Defines the position of the label in the rating.
73
- * *Top
74
- * *Bottom
75
- * *Left
76
- * *Right
76
+ * Defines the position of the label in rating component.
77
+ *
78
+ * The possible values are:
79
+ * * Top
80
+ * * Bottom
81
+ * * Left
82
+ * * Right
77
83
  *
78
84
  * @isenumeration true
79
85
  * @default LabelPosition.Right
@@ -82,15 +88,15 @@ export interface RatingModel extends ComponentModel{
82
88
  labelPosition?: string | LabelPosition;
83
89
 
84
90
  /**
85
- * Defines the template content for the label.
86
- * The template context will contain the current value and maximum value for customization.
91
+ * Defines the template that used as label over default label of the rating. The current value of rating passed as context to build the content.
87
92
  *
88
93
  * @default ''
89
94
  */
90
95
  labelTemplate?: string;
91
96
 
92
97
  /**
93
- * Defines the minimum value of the rating.
98
+ * Defines the value that specifies minimum rating that a user can select.
99
+ * The value is set to 0, which means that the minimum possible rating is 0.
94
100
  *
95
101
  * @default 0.0
96
102
  * @aspType double
@@ -98,11 +104,14 @@ export interface RatingModel extends ComponentModel{
98
104
  min?: number;
99
105
 
100
106
  /**
101
- * Defines the minimum increase in the value.
102
- * *Full
103
- * *Half
104
- * *Quarter
105
- * *Exact
107
+ * Defines the precision type of the rating which used to component the granularity of the rating,
108
+ * allowing users to provide ratings with varying levels of precision.
109
+ *
110
+ * The possible values are:
111
+ * * Full
112
+ * * Half
113
+ * * Quarter
114
+ * * Exact
106
115
  *
107
116
  * @isenumeration true
108
117
  * @default PrecisionType.Full
@@ -111,36 +120,42 @@ export interface RatingModel extends ComponentModel{
111
120
  precision?: string | PrecisionType;
112
121
 
113
122
  /**
114
- * Defines whether the read only mode is enabled or not where interaction is disabled without any UI change.
123
+ * Defines a boolean value that specifies whether the read-only mode is enabled for a rating component,
124
+ * which prevents the user from modifying or interacting with the rating value but allows them to read it.
115
125
  *
116
126
  * @default false
117
127
  */
118
128
  readOnly?: boolean;
119
129
 
120
130
  /**
121
- * Defines whether to show a label which display the current value.
131
+ * Defines a value that specifies whether to display a label that shows the current value of a rating.
132
+ * When set to "true", a label will be displayed that shows the current value of the rating; otherwise false.
122
133
  *
123
134
  * @default false
124
135
  */
125
136
  showLabel?: boolean;
126
137
 
127
138
  /**
128
- * Defines whether to show tooltip for the items.
139
+ * Defines a value that defines whether to show tooltip for the items.
140
+ * When set to "true", show tooltip for the items.
129
141
  *
130
142
  * @default true
131
143
  */
132
144
  showTooltip?: boolean;
133
145
 
134
146
  /**
135
- * Defines the template content for the tooltip.
136
- * The template context will contain the current value for customization.
147
+ * Defines the template that used as tooltip content over default tooltip content of the rating.
148
+ * The current value of rating passed as context to build the content.
137
149
  *
138
150
  * @default ''
139
151
  */
140
152
  tooltipTemplate?: string;
141
153
 
142
154
  /**
143
- * Defines the rating value.
155
+ * Defines the current rating value which used to display and update the rating selected by the user.
156
+ * Based on "PrecisionType", users can select ratings with varying levels of precision.
157
+ * The "value" is a decimal value that ranges from the minimum value to the items count,
158
+ * as specified by the "min" and "itemsCount" properties of the rating.
144
159
  *
145
160
  * @default 0.0
146
161
  * @aspType double
@@ -148,35 +163,36 @@ export interface RatingModel extends ComponentModel{
148
163
  value?: number;
149
164
 
150
165
  /**
151
- * Defines whether the rating is visible or hidden.
166
+ * Defines a value that indicates whether the rating component is visible or hidden.
167
+ * When set to "true", if the rating component is visible.
152
168
  *
153
169
  * @default true
154
170
  */
155
171
  visible?: boolean;
156
172
 
157
173
  /**
158
- * Event triggers before rendering each item.
174
+ * Event callback that is raised before rendering each item.
159
175
  *
160
176
  * @event beforeItemRender
161
177
  */
162
178
  beforeItemRender?: EmitType<RatingItemEventArgs>;
163
179
 
164
180
  /**
165
- * Event triggers after the creation of Rating.
181
+ * Event callback that is raised after rendering the rating.
166
182
  *
167
183
  * @event created
168
184
  */
169
185
  created?: EmitType<Event>;
170
186
 
171
187
  /**
172
- * Event triggers whenever a new item is hovered.
188
+ * Event callback that is raised when a user hovers over an item.
173
189
  *
174
190
  * @event onItemHover
175
191
  */
176
192
  onItemHover?: EmitType<RatingHoverEventArgs>;
177
193
 
178
194
  /**
179
- * Event triggers whenever the value changes.
195
+ * Event callback that is raised when the value is changed.
180
196
  *
181
197
  * @event valueChanged
182
198
  */
@@ -1,49 +1,50 @@
1
1
  import { BaseEventArgs, Component, EmitType, INotifyPropertyChanged } from '@syncfusion/ej2-base';
2
2
  import { RatingModel } from './rating-model';
3
3
  /**
4
- * Defines the position of the label in the rating.
4
+ * Defines where to position the label in rating
5
5
  */
6
6
  export declare enum LabelPosition {
7
7
  /**
8
- * Shows the label above the rating.
8
+ * The label is positioned at the top center of the rating component.
9
9
  */
10
10
  Top = "Top",
11
11
  /**
12
- * Shows the label below the rating.
12
+ * The label is positioned at the bottom center of the rating component.
13
13
  */
14
14
  Bottom = "Bottom",
15
15
  /**
16
- * Shows the label to the left of rating.
16
+ * The label is positioned at the left side of the rating component.
17
17
  */
18
18
  Left = "Left",
19
19
  /**
20
- * Shows the label to the right of rating.
20
+ * The label is positioned at the right side of the rating component.
21
21
  */
22
22
  Right = "Right"
23
23
  }
24
24
  /**
25
- * Defines the minimum increase in the value in Rating Control.
25
+ * Defines the precision type of the rating.
26
+ * It is used to component the granularity of the rating, allowing users to provide ratings with varying levels of precision.
26
27
  */
27
28
  export declare enum PrecisionType {
28
29
  /**
29
- * Process the value as whole numbers.
30
+ * The rating is increased in whole number increments.
30
31
  */
31
32
  Full = "Full",
32
33
  /**
33
- * Process the value in terms of 0.5 (half).
34
+ * The rating is increased in increments of 0.5 (half).
34
35
  */
35
36
  Half = "Half",
36
37
  /**
37
- * Process the value in terms of 0.25 (quarter).
38
+ * The rating is increased in increments of 0.25 (quarter).
38
39
  */
39
40
  Quarter = "Quarter",
40
41
  /**
41
- * Process the value in terms of 0.1.
42
+ * The rating is increased in increments of 0.1.
42
43
  */
43
44
  Exact = "Exact"
44
45
  }
45
46
  /**
46
- * Event triggers whenever the value changes.
47
+ * Provides information about valueChanged event callback
47
48
  */
48
49
  export interface RatingChangedEventArgs extends BaseEventArgs {
49
50
  /**
@@ -64,11 +65,11 @@ export interface RatingChangedEventArgs extends BaseEventArgs {
64
65
  value: number;
65
66
  }
66
67
  /**
67
- * Event triggers whenever a new item is hovered.
68
+ * Provides information about onItemHover event callback.
68
69
  */
69
70
  export interface RatingHoverEventArgs extends BaseEventArgs {
70
71
  /**
71
- * Provides the hovered item element.
72
+ * Provides the rating item element reference.
72
73
  */
73
74
  element: HTMLElement;
74
75
  /**
@@ -76,16 +77,16 @@ export interface RatingHoverEventArgs extends BaseEventArgs {
76
77
  */
77
78
  event: Event;
78
79
  /**
79
- * Provides the current value of the hovered item.
80
+ * Provides the hover value at hovered point of rating.
80
81
  */
81
82
  value: number;
82
83
  }
83
84
  /**
84
- * Event triggers before rendering each item.
85
+ * Provides information about beforeItemRender event callback.
85
86
  */
86
87
  export interface RatingItemEventArgs extends BaseEventArgs {
87
88
  /**
88
- * Html element of the current item to be rendered.
89
+ * Provides the rating item element reference.
89
90
  */
90
91
  element: HTMLElement;
91
92
  /**
@@ -93,66 +94,86 @@ export interface RatingItemEventArgs extends BaseEventArgs {
93
94
  */
94
95
  value: number;
95
96
  }
97
+ /**
98
+ * The Rating component allows the user to rate something by clicking on a set of symbols on a numeric scale.
99
+ * This allows users to provide feedback or ratings for products, services, or content.
100
+ *
101
+ * ```html
102
+ * <input id="rating">
103
+ * ```
104
+ * ```typescript
105
+ * <script>
106
+ * let ratingObj: Rating = new Rating();
107
+ * ratingObj.appendTo('#rating');
108
+ * </script>
109
+ * ```
110
+ */
96
111
  export declare class Rating extends Component<HTMLElement> implements INotifyPropertyChanged {
97
112
  /**
98
- * Defines whether to show or hide the reset button.
99
- * If min is not zero, then reset button won’t be displayed regardless of allowReset value.
113
+ * Defines whether to show or hide the reset button in a rating component.
114
+ * When set to "true", the reset button will be visible to the user, and they will be able to click it to reset the rating value to its default value.
100
115
  *
101
116
  * @default false
102
117
  */
103
118
  allowReset: boolean;
104
119
  /**
105
- * Defines the CSS class to customize the rating appearance.
120
+ * Defines one or more CSS classes that can be used to customize the appearance of a rating component.
121
+ * One or more CSS classes to customize the appearance of the rating component, such as by changing its colors, fonts, sizes, or other visual aspects.
106
122
  *
107
123
  * @default ''
108
124
  */
109
125
  cssClass: string;
110
126
  /**
111
- * Defines whether the rating is enabled or disabled.
127
+ * Defines whether a rating component is enabled or disabled.
128
+ * A disabled rating component may have a different visual appearance than an enabled one.
129
+ * When set to "true", the rating component will be disabled, and the user will not be able to interact with it.
112
130
  *
113
131
  * @default false
114
132
  */
115
133
  disabled: boolean;
116
134
  /**
117
- * Defines whether to add animation when an item is hovered.
135
+ * Defines the template that defines the appearance of each un-rated item in a rating component.
118
136
  *
119
- * @default true
137
+ * @default ''
120
138
  */
121
- enableAnimation: boolean;
139
+ emptyTemplate: string;
122
140
  /**
123
- * Defines the template content for each item when it is not selected.
124
- * The template context will contain the current item value for customization.
141
+ * Defines whether to add animation (to provide visual feedback to the user) when an item in a rating component is hovered.
142
+ * When set to "true", an animation will be added when the user hovers their cursor over an item in the rating component.
125
143
  *
126
- * @default ''
144
+ * @default true
127
145
  */
128
- emptyTemplate: string;
146
+ enableAnimation: boolean;
129
147
  /**
130
- * Defines whether to enable single selection like radio button or not.
131
- * If not enabled all the items before the selected item will also be in the selected state.
148
+ * Defines whether to select all the items before the selected item should be in selected state in a rating component.
149
+ * When set to "true", only the selected item will be in the selected state, and all other items will be un-selected.
150
+ * When set to "false", all items before the selected one will be in the selected state.
132
151
  *
133
152
  * @default false
134
153
  */
135
154
  enableSingleSelection: boolean;
136
155
  /**
137
- * Defines the template content for each item when it is selected.
138
- * The template context will contain the current item value for customization.
156
+ * Defines the template that defines the appearance of each rated item in a rating component.
139
157
  *
140
158
  * @default ''
141
159
  */
142
160
  fullTemplate: string;
143
161
  /**
144
- * Defines the number of rating items.
162
+ * Defines the specific number of items (symbols) in rating component.
163
+ * The rating component typically consists of a number of items, such as stars or other symbols, that represent the rating value.
145
164
  *
146
165
  * @default 5
147
166
  * @aspType int
148
167
  */
149
168
  itemsCount: number;
150
169
  /**
151
- * Defines the position of the label in the rating.
152
- * *Top
153
- * *Bottom
154
- * *Left
155
- * *Right
170
+ * Defines the position of the label in rating component.
171
+ *
172
+ * The possible values are:
173
+ * * Top
174
+ * * Bottom
175
+ * * Left
176
+ * * Right
156
177
  *
157
178
  * @isenumeration true
158
179
  * @default LabelPosition.Right
@@ -160,25 +181,28 @@ export declare class Rating extends Component<HTMLElement> implements INotifyPro
160
181
  */
161
182
  labelPosition: string | LabelPosition;
162
183
  /**
163
- * Defines the template content for the label.
164
- * The template context will contain the current value and maximum value for customization.
184
+ * Defines the template that used as label over default label of the rating. The current value of rating passed as context to build the content.
165
185
  *
166
186
  * @default ''
167
187
  */
168
188
  labelTemplate: string;
169
189
  /**
170
- * Defines the minimum value of the rating.
190
+ * Defines the value that specifies minimum rating that a user can select.
191
+ * The value is set to 0, which means that the minimum possible rating is 0.
171
192
  *
172
193
  * @default 0.0
173
194
  * @aspType double
174
195
  */
175
196
  min: number;
176
197
  /**
177
- * Defines the minimum increase in the value.
178
- * *Full
179
- * *Half
180
- * *Quarter
181
- * *Exact
198
+ * Defines the precision type of the rating which used to component the granularity of the rating,
199
+ * allowing users to provide ratings with varying levels of precision.
200
+ *
201
+ * The possible values are:
202
+ * * Full
203
+ * * Half
204
+ * * Quarter
205
+ * * Exact
182
206
  *
183
207
  * @isenumeration true
184
208
  * @default PrecisionType.Full
@@ -186,63 +210,70 @@ export declare class Rating extends Component<HTMLElement> implements INotifyPro
186
210
  */
187
211
  precision: string | PrecisionType;
188
212
  /**
189
- * Defines whether the read only mode is enabled or not where interaction is disabled without any UI change.
213
+ * Defines a boolean value that specifies whether the read-only mode is enabled for a rating component,
214
+ * which prevents the user from modifying or interacting with the rating value but allows them to read it.
190
215
  *
191
216
  * @default false
192
217
  */
193
218
  readOnly: boolean;
194
219
  /**
195
- * Defines whether to show a label which display the current value.
220
+ * Defines a value that specifies whether to display a label that shows the current value of a rating.
221
+ * When set to "true", a label will be displayed that shows the current value of the rating; otherwise false.
196
222
  *
197
223
  * @default false
198
224
  */
199
225
  showLabel: boolean;
200
226
  /**
201
- * Defines whether to show tooltip for the items.
227
+ * Defines a value that defines whether to show tooltip for the items.
228
+ * When set to "true", show tooltip for the items.
202
229
  *
203
230
  * @default true
204
231
  */
205
232
  showTooltip: boolean;
206
233
  /**
207
- * Defines the template content for the tooltip.
208
- * The template context will contain the current value for customization.
234
+ * Defines the template that used as tooltip content over default tooltip content of the rating.
235
+ * The current value of rating passed as context to build the content.
209
236
  *
210
237
  * @default ''
211
238
  */
212
239
  tooltipTemplate: string;
213
240
  /**
214
- * Defines the rating value.
241
+ * Defines the current rating value which used to display and update the rating selected by the user.
242
+ * Based on "PrecisionType", users can select ratings with varying levels of precision.
243
+ * The "value" is a decimal value that ranges from the minimum value to the items count,
244
+ * as specified by the "min" and "itemsCount" properties of the rating.
215
245
  *
216
246
  * @default 0.0
217
247
  * @aspType double
218
248
  */
219
249
  value: number;
220
250
  /**
221
- * Defines whether the rating is visible or hidden.
251
+ * Defines a value that indicates whether the rating component is visible or hidden.
252
+ * When set to "true", if the rating component is visible.
222
253
  *
223
254
  * @default true
224
255
  */
225
256
  visible: boolean;
226
257
  /**
227
- * Event triggers before rendering each item.
258
+ * Event callback that is raised before rendering each item.
228
259
  *
229
260
  * @event beforeItemRender
230
261
  */
231
262
  beforeItemRender: EmitType<RatingItemEventArgs>;
232
263
  /**
233
- * Event triggers after the creation of Rating.
264
+ * Event callback that is raised after rendering the rating.
234
265
  *
235
266
  * @event created
236
267
  */
237
268
  created: EmitType<Event>;
238
269
  /**
239
- * Event triggers whenever a new item is hovered.
270
+ * Event callback that is raised when a user hovers over an item.
240
271
  *
241
272
  * @event onItemHover
242
273
  */
243
274
  onItemHover: EmitType<RatingHoverEventArgs>;
244
275
  /**
245
- * Event triggers whenever the value changes.
276
+ * Event callback that is raised when the value is changed.
246
277
  *
247
278
  * @event valueChanged
248
279
  */
@@ -294,6 +325,7 @@ export declare class Rating extends Component<HTMLElement> implements INotifyPro
294
325
  private clearLabelPosition;
295
326
  private wireItemsEvents;
296
327
  private clickHandler;
328
+ private updateValueChange;
297
329
  private triggerChange;
298
330
  private mouseMoveHandler;
299
331
  private openRatingTooltip;