@progress/kendo-react-common 12.0.2-develop.1 → 12.0.2-develop.2

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 (3) hide show
  1. package/index.d.mts +93 -1
  2. package/index.d.ts +93 -1
  3. package/package.json +1 -1
package/index.d.mts CHANGED
@@ -74,7 +74,7 @@ export declare interface AdaptiveModeContextType {
74
74
  export declare function addItem(item: any, operation: 'before' | 'after' | 'child', childrenField: string, targetItemId: string, items: any[]): any[];
75
75
 
76
76
  /**
77
- * All classes
77
+ * All classes - Comprehensive structure containing all component styling configurations
78
78
  */
79
79
  export declare interface AllClassStructure extends AnimationsClassStructure, ButtonsClassStructure, DropDownsClassStructure, GridClassStructure, IconsClassStructure, LabelsClassStructure, FormClassStructure, PopupClassStructure, ButtonsClassStructure, PopupClassStructure, GridClassStructure, InputsClassStructure, DropDownsClassStructure, DateInputsClassStructure {
80
80
  }
@@ -117,6 +117,7 @@ export declare interface AnimationClasses {
117
117
  * Animation classes
118
118
  */
119
119
  export declare interface AnimationsClassStructure {
120
+ /** Animation styles and transition configuration */
120
121
  uAnimation?: AnimationClasses;
121
122
  }
122
123
 
@@ -429,8 +430,11 @@ export declare const buttonPrefix: string;
429
430
  * Buttons classes
430
431
  */
431
432
  export declare interface ButtonsClassStructure {
433
+ /** Button component styling configuration */
432
434
  uButton?: ButtonClasses;
435
+ /** Button group styling configuration */
433
436
  uButtonGroup?: ButtonGroupClasses;
437
+ /** Drop-down button styling configuration */
434
438
  uDropDownButton?: DropDownButtonClasses;
435
439
  }
436
440
 
@@ -962,10 +966,15 @@ export declare const dateInputs: {
962
966
  * DateInputs classes
963
967
  */
964
968
  export declare interface DateInputsClassStructure {
969
+ /** Calendar styling configuration */
965
970
  uCalendar?: CalendarClasses;
971
+ /** Date input styling configuration */
966
972
  uDateInput?: DateInputClasses;
973
+ /** Date time picker styling configuration */
967
974
  uDateTimePicker?: DateTimePickerClasses;
975
+ /** Time component styling configuration */
968
976
  uTime?: TimeClasses;
977
+ /** Time picker styling configuration */
969
978
  uTimePicker?: TimePickerClasses;
970
979
  }
971
980
 
@@ -1547,9 +1556,13 @@ export declare interface DropDownsActionSheetClasses {
1547
1556
  * DropDowns classes
1548
1557
  */
1549
1558
  export declare interface DropDownsClassStructure {
1559
+ /** DropDown action sheet styling configuration */
1550
1560
  uDropDownsActionSheet?: DropDownsActionSheetClasses;
1561
+ /** Base DropDown styling configuration */
1551
1562
  uDropDownsBase?: DropDownBaseClasses;
1563
+ /** DropDown list styling configuration */
1552
1564
  uDropDownList?: DropDownListClasses;
1565
+ /** ComboBox styling configuration */
1553
1566
  uComboBox?: ComboBoxClasses;
1554
1567
  }
1555
1568
 
@@ -1937,6 +1950,7 @@ export declare interface FormClasses {
1937
1950
  * Form classes
1938
1951
  */
1939
1952
  export declare interface FormClassStructure {
1953
+ /** Form component styling configuration */
1940
1954
  uForm?: FormClasses;
1941
1955
  }
1942
1956
 
@@ -2028,16 +2042,49 @@ export declare interface FormComponentProps {
2028
2042
  * * [Switch]({% slug forms_support_switch %})
2029
2043
  */
2030
2044
  export declare interface FormComponentValidity {
2045
+ /**
2046
+ * Indicates whether the user has provided input in the user interface element that the user agent is unable to convert.
2047
+ */
2031
2048
  readonly badInput?: boolean;
2049
+ /**
2050
+ * Indicates whether the element has a custom error.
2051
+ */
2032
2052
  readonly customError: boolean;
2053
+ /**
2054
+ * Indicates whether the value does not match the specified pattern.
2055
+ */
2033
2056
  readonly patternMismatch?: boolean;
2057
+ /**
2058
+ * Indicates whether the value is greater than the maximum specified by the max attribute.
2059
+ */
2034
2060
  readonly rangeOverflow?: boolean;
2061
+ /**
2062
+ * Indicates whether the value is less than the minimum specified by the min attribute.
2063
+ */
2035
2064
  readonly rangeUnderflow?: boolean;
2065
+ /**
2066
+ * Indicates whether the value does not fit the rules determined by the step attribute.
2067
+ */
2036
2068
  readonly stepMismatch?: boolean;
2069
+ /**
2070
+ * Indicates whether the value exceeds the specified maxlength.
2071
+ */
2037
2072
  readonly tooLong?: boolean;
2073
+ /**
2074
+ * Indicates whether the value fails to meet the specified minlength.
2075
+ */
2038
2076
  readonly tooShort?: boolean;
2077
+ /**
2078
+ * Indicates whether the value is not in the correct syntax when type is email or url.
2079
+ */
2039
2080
  readonly typeMismatch?: boolean;
2081
+ /**
2082
+ * Indicates whether the element meets all constraint validations and is therefore considered valid.
2083
+ */
2040
2084
  readonly valid: boolean;
2085
+ /**
2086
+ * Indicates whether the element has no value but is a required field.
2087
+ */
2041
2088
  readonly valueMissing: boolean;
2042
2089
  }
2043
2090
 
@@ -2187,6 +2234,7 @@ export declare const grid: {
2187
2234
  * @hidden
2188
2235
  */
2189
2236
  export declare interface GridClassStructure {
2237
+ /** Grid component styling configuration */
2190
2238
  uGrid?: WidgetClassStructure;
2191
2239
  }
2192
2240
 
@@ -2308,6 +2356,7 @@ export declare interface IconProps extends BaseIconProps, KendoMouse<IconHandle,
2308
2356
  * Icons classes
2309
2357
  */
2310
2358
  export declare interface IconsClassStructure {
2359
+ /** SVG icon styling configuration */
2311
2360
  uSvgIcon?: SVGIconClasses;
2312
2361
  }
2313
2362
 
@@ -2417,10 +2466,15 @@ export declare const inputs: {
2417
2466
  * Inputs classes
2418
2467
  */
2419
2468
  export declare interface InputsClassStructure {
2469
+ /** Masked text box styling configuration */
2420
2470
  uMaskedTextBox?: MaskedTextBoxClasses;
2471
+ /** Radio group styling configuration */
2421
2472
  uRadioGroup?: RadioGroupClasses;
2473
+ /** Radio button styling configuration */
2422
2474
  uRadioButton?: RadioButtonClasses;
2475
+ /** Text box styling configuration */
2423
2476
  uTextBox?: TextBoxClasses;
2477
+ /** Input component styling configuration */
2424
2478
  uInput?: InputClasses;
2425
2479
  }
2426
2480
 
@@ -2471,19 +2525,52 @@ export declare const jsonTheme: KendoTheme;
2471
2525
  export declare const keepFocusInContainer: (e: React.KeyboardEvent, containerElement?: HTMLElement | null, elementsSelectors?: string[]) => void;
2472
2526
 
2473
2527
  export declare interface KendoMouse<T, E extends HTMLElement> {
2528
+ /**
2529
+ * Fired when the mouse button is pressed down on the element.
2530
+ */
2474
2531
  onMouseDown?: (args: KendoMouseEvent<T, E>) => void;
2532
+ /**
2533
+ * Fired when the mouse button is released over the element.
2534
+ */
2475
2535
  onMouseUp?: (args: KendoMouseEvent<T, E>) => void;
2536
+ /**
2537
+ * Fired when the element is clicked.
2538
+ */
2476
2539
  onClick?: (args: KendoMouseEvent<T, E>) => void;
2540
+ /**
2541
+ * Fired when the element is double-clicked.
2542
+ */
2477
2543
  onDoubleClick?: (args: KendoMouseEvent<T, E>) => void;
2544
+ /**
2545
+ * Fired when the mouse pointer enters the element.
2546
+ */
2478
2547
  onMouseEnter?: (args: KendoMouseEvent<T, E>) => void;
2548
+ /**
2549
+ * Fired when the mouse pointer leaves the element.
2550
+ */
2479
2551
  onMouseLeave?: (args: KendoMouseEvent<T, E>) => void;
2552
+ /**
2553
+ * Fired when the mouse pointer moves over the element.
2554
+ */
2480
2555
  onMouseMove?: (args: KendoMouseEvent<T, E>) => void;
2556
+ /**
2557
+ * Fired when the mouse pointer leaves the element or any of its child elements.
2558
+ */
2481
2559
  onMouseOut?: (args: KendoMouseEvent<T, E>) => void;
2560
+ /**
2561
+ * Fired when the mouse pointer moves over the element or any of its child elements.
2562
+ */
2482
2563
  onMouseOver?: (args: KendoMouseEvent<T, E>) => void;
2483
2564
  }
2484
2565
 
2485
2566
  export declare interface KendoMouseEvent<T, E extends HTMLElement = HTMLElement> {
2567
+ /**
2568
+ * The React synthetic mouse event that triggered the action.
2569
+ */
2486
2570
  syntheticEvent: React_2.MouseEvent<E>;
2571
+ /**
2572
+ * The target object that is associated with the event.
2573
+ */
2487
2574
  target: T;
2488
2575
  }
2489
2576
 
@@ -2664,9 +2751,13 @@ export declare const labels: {
2664
2751
  * Labels classes
2665
2752
  */
2666
2753
  export declare interface LabelsClassStructure {
2754
+ /** Error message styling configuration */
2667
2755
  uError?: ErrorClasses;
2756
+ /** Hint text styling configuration */
2668
2757
  uHint?: HintClasses;
2758
+ /** Label styling configuration */
2669
2759
  uLabel?: LabelClasses;
2760
+ /** Floating label styling configuration */
2670
2761
  uFloatingLabel?: FloatingLabelClasses;
2671
2762
  }
2672
2763
 
@@ -2986,6 +3077,7 @@ export declare interface PopupClasses {
2986
3077
  * Popup classes
2987
3078
  */
2988
3079
  export declare interface PopupClassStructure {
3080
+ /** Popup component styling configuration */
2989
3081
  uPopup?: PopupClasses;
2990
3082
  }
2991
3083
 
package/index.d.ts CHANGED
@@ -74,7 +74,7 @@ export declare interface AdaptiveModeContextType {
74
74
  export declare function addItem(item: any, operation: 'before' | 'after' | 'child', childrenField: string, targetItemId: string, items: any[]): any[];
75
75
 
76
76
  /**
77
- * All classes
77
+ * All classes - Comprehensive structure containing all component styling configurations
78
78
  */
79
79
  export declare interface AllClassStructure extends AnimationsClassStructure, ButtonsClassStructure, DropDownsClassStructure, GridClassStructure, IconsClassStructure, LabelsClassStructure, FormClassStructure, PopupClassStructure, ButtonsClassStructure, PopupClassStructure, GridClassStructure, InputsClassStructure, DropDownsClassStructure, DateInputsClassStructure {
80
80
  }
@@ -117,6 +117,7 @@ export declare interface AnimationClasses {
117
117
  * Animation classes
118
118
  */
119
119
  export declare interface AnimationsClassStructure {
120
+ /** Animation styles and transition configuration */
120
121
  uAnimation?: AnimationClasses;
121
122
  }
122
123
 
@@ -429,8 +430,11 @@ export declare const buttonPrefix: string;
429
430
  * Buttons classes
430
431
  */
431
432
  export declare interface ButtonsClassStructure {
433
+ /** Button component styling configuration */
432
434
  uButton?: ButtonClasses;
435
+ /** Button group styling configuration */
433
436
  uButtonGroup?: ButtonGroupClasses;
437
+ /** Drop-down button styling configuration */
434
438
  uDropDownButton?: DropDownButtonClasses;
435
439
  }
436
440
 
@@ -962,10 +966,15 @@ export declare const dateInputs: {
962
966
  * DateInputs classes
963
967
  */
964
968
  export declare interface DateInputsClassStructure {
969
+ /** Calendar styling configuration */
965
970
  uCalendar?: CalendarClasses;
971
+ /** Date input styling configuration */
966
972
  uDateInput?: DateInputClasses;
973
+ /** Date time picker styling configuration */
967
974
  uDateTimePicker?: DateTimePickerClasses;
975
+ /** Time component styling configuration */
968
976
  uTime?: TimeClasses;
977
+ /** Time picker styling configuration */
969
978
  uTimePicker?: TimePickerClasses;
970
979
  }
971
980
 
@@ -1547,9 +1556,13 @@ export declare interface DropDownsActionSheetClasses {
1547
1556
  * DropDowns classes
1548
1557
  */
1549
1558
  export declare interface DropDownsClassStructure {
1559
+ /** DropDown action sheet styling configuration */
1550
1560
  uDropDownsActionSheet?: DropDownsActionSheetClasses;
1561
+ /** Base DropDown styling configuration */
1551
1562
  uDropDownsBase?: DropDownBaseClasses;
1563
+ /** DropDown list styling configuration */
1552
1564
  uDropDownList?: DropDownListClasses;
1565
+ /** ComboBox styling configuration */
1553
1566
  uComboBox?: ComboBoxClasses;
1554
1567
  }
1555
1568
 
@@ -1937,6 +1950,7 @@ export declare interface FormClasses {
1937
1950
  * Form classes
1938
1951
  */
1939
1952
  export declare interface FormClassStructure {
1953
+ /** Form component styling configuration */
1940
1954
  uForm?: FormClasses;
1941
1955
  }
1942
1956
 
@@ -2028,16 +2042,49 @@ export declare interface FormComponentProps {
2028
2042
  * * [Switch]({% slug forms_support_switch %})
2029
2043
  */
2030
2044
  export declare interface FormComponentValidity {
2045
+ /**
2046
+ * Indicates whether the user has provided input in the user interface element that the user agent is unable to convert.
2047
+ */
2031
2048
  readonly badInput?: boolean;
2049
+ /**
2050
+ * Indicates whether the element has a custom error.
2051
+ */
2032
2052
  readonly customError: boolean;
2053
+ /**
2054
+ * Indicates whether the value does not match the specified pattern.
2055
+ */
2033
2056
  readonly patternMismatch?: boolean;
2057
+ /**
2058
+ * Indicates whether the value is greater than the maximum specified by the max attribute.
2059
+ */
2034
2060
  readonly rangeOverflow?: boolean;
2061
+ /**
2062
+ * Indicates whether the value is less than the minimum specified by the min attribute.
2063
+ */
2035
2064
  readonly rangeUnderflow?: boolean;
2065
+ /**
2066
+ * Indicates whether the value does not fit the rules determined by the step attribute.
2067
+ */
2036
2068
  readonly stepMismatch?: boolean;
2069
+ /**
2070
+ * Indicates whether the value exceeds the specified maxlength.
2071
+ */
2037
2072
  readonly tooLong?: boolean;
2073
+ /**
2074
+ * Indicates whether the value fails to meet the specified minlength.
2075
+ */
2038
2076
  readonly tooShort?: boolean;
2077
+ /**
2078
+ * Indicates whether the value is not in the correct syntax when type is email or url.
2079
+ */
2039
2080
  readonly typeMismatch?: boolean;
2081
+ /**
2082
+ * Indicates whether the element meets all constraint validations and is therefore considered valid.
2083
+ */
2040
2084
  readonly valid: boolean;
2085
+ /**
2086
+ * Indicates whether the element has no value but is a required field.
2087
+ */
2041
2088
  readonly valueMissing: boolean;
2042
2089
  }
2043
2090
 
@@ -2187,6 +2234,7 @@ export declare const grid: {
2187
2234
  * @hidden
2188
2235
  */
2189
2236
  export declare interface GridClassStructure {
2237
+ /** Grid component styling configuration */
2190
2238
  uGrid?: WidgetClassStructure;
2191
2239
  }
2192
2240
 
@@ -2308,6 +2356,7 @@ export declare interface IconProps extends BaseIconProps, KendoMouse<IconHandle,
2308
2356
  * Icons classes
2309
2357
  */
2310
2358
  export declare interface IconsClassStructure {
2359
+ /** SVG icon styling configuration */
2311
2360
  uSvgIcon?: SVGIconClasses;
2312
2361
  }
2313
2362
 
@@ -2417,10 +2466,15 @@ export declare const inputs: {
2417
2466
  * Inputs classes
2418
2467
  */
2419
2468
  export declare interface InputsClassStructure {
2469
+ /** Masked text box styling configuration */
2420
2470
  uMaskedTextBox?: MaskedTextBoxClasses;
2471
+ /** Radio group styling configuration */
2421
2472
  uRadioGroup?: RadioGroupClasses;
2473
+ /** Radio button styling configuration */
2422
2474
  uRadioButton?: RadioButtonClasses;
2475
+ /** Text box styling configuration */
2423
2476
  uTextBox?: TextBoxClasses;
2477
+ /** Input component styling configuration */
2424
2478
  uInput?: InputClasses;
2425
2479
  }
2426
2480
 
@@ -2471,19 +2525,52 @@ export declare const jsonTheme: KendoTheme;
2471
2525
  export declare const keepFocusInContainer: (e: React.KeyboardEvent, containerElement?: HTMLElement | null, elementsSelectors?: string[]) => void;
2472
2526
 
2473
2527
  export declare interface KendoMouse<T, E extends HTMLElement> {
2528
+ /**
2529
+ * Fired when the mouse button is pressed down on the element.
2530
+ */
2474
2531
  onMouseDown?: (args: KendoMouseEvent<T, E>) => void;
2532
+ /**
2533
+ * Fired when the mouse button is released over the element.
2534
+ */
2475
2535
  onMouseUp?: (args: KendoMouseEvent<T, E>) => void;
2536
+ /**
2537
+ * Fired when the element is clicked.
2538
+ */
2476
2539
  onClick?: (args: KendoMouseEvent<T, E>) => void;
2540
+ /**
2541
+ * Fired when the element is double-clicked.
2542
+ */
2477
2543
  onDoubleClick?: (args: KendoMouseEvent<T, E>) => void;
2544
+ /**
2545
+ * Fired when the mouse pointer enters the element.
2546
+ */
2478
2547
  onMouseEnter?: (args: KendoMouseEvent<T, E>) => void;
2548
+ /**
2549
+ * Fired when the mouse pointer leaves the element.
2550
+ */
2479
2551
  onMouseLeave?: (args: KendoMouseEvent<T, E>) => void;
2552
+ /**
2553
+ * Fired when the mouse pointer moves over the element.
2554
+ */
2480
2555
  onMouseMove?: (args: KendoMouseEvent<T, E>) => void;
2556
+ /**
2557
+ * Fired when the mouse pointer leaves the element or any of its child elements.
2558
+ */
2481
2559
  onMouseOut?: (args: KendoMouseEvent<T, E>) => void;
2560
+ /**
2561
+ * Fired when the mouse pointer moves over the element or any of its child elements.
2562
+ */
2482
2563
  onMouseOver?: (args: KendoMouseEvent<T, E>) => void;
2483
2564
  }
2484
2565
 
2485
2566
  export declare interface KendoMouseEvent<T, E extends HTMLElement = HTMLElement> {
2567
+ /**
2568
+ * The React synthetic mouse event that triggered the action.
2569
+ */
2486
2570
  syntheticEvent: React_2.MouseEvent<E>;
2571
+ /**
2572
+ * The target object that is associated with the event.
2573
+ */
2487
2574
  target: T;
2488
2575
  }
2489
2576
 
@@ -2664,9 +2751,13 @@ export declare const labels: {
2664
2751
  * Labels classes
2665
2752
  */
2666
2753
  export declare interface LabelsClassStructure {
2754
+ /** Error message styling configuration */
2667
2755
  uError?: ErrorClasses;
2756
+ /** Hint text styling configuration */
2668
2757
  uHint?: HintClasses;
2758
+ /** Label styling configuration */
2669
2759
  uLabel?: LabelClasses;
2760
+ /** Floating label styling configuration */
2670
2761
  uFloatingLabel?: FloatingLabelClasses;
2671
2762
  }
2672
2763
 
@@ -2986,6 +3077,7 @@ export declare interface PopupClasses {
2986
3077
  * Popup classes
2987
3078
  */
2988
3079
  export declare interface PopupClassStructure {
3080
+ /** Popup component styling configuration */
2989
3081
  uPopup?: PopupClasses;
2990
3082
  }
2991
3083
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-react-common",
3
- "version": "12.0.2-develop.1",
3
+ "version": "12.0.2-develop.2",
4
4
  "description": "React Common package delivers common utilities that can be used with the KendoReact UI components. KendoReact Common Utilities package",
5
5
  "author": "Progress",
6
6
  "license": "SEE LICENSE IN LICENSE.md",