@progress/kendo-react-inputs 10.2.0-develop.1 → 10.2.0-develop.10

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.
package/index.d.mts CHANGED
@@ -16,7 +16,7 @@ import { HTMLAttributes } from 'react';
16
16
  import { IconHandle } from '@progress/kendo-react-common';
17
17
  import { IconProps } from '@progress/kendo-react-common';
18
18
  import { InputsClassStructure } from '@progress/kendo-react-common';
19
- import { JSX as JSX_2 } from 'react/jsx-runtime';
19
+ import { JSX } from 'react/jsx-runtime';
20
20
  import { NumberFormatOptions } from '@progress/kendo-react-intl';
21
21
  import { PopupAnimation } from '@progress/kendo-react-popup';
22
22
  import * as React_2 from 'react';
@@ -77,6 +77,11 @@ export declare interface CheckboxProps extends ToggleBaseProps, FormComponentPro
77
77
  /**
78
78
  * Sets the checked state of the Checkbox.
79
79
  * Set to null to enable the indeterminate state of the Checkbox ([see example]({% slug overview_checkbox %})).
80
+ *
81
+ * @example
82
+ * ```jsx
83
+ * <Checkbox checked={true} />
84
+ * ```
80
85
  */
81
86
  checked?: boolean | null;
82
87
  /**
@@ -153,10 +158,20 @@ export declare interface CheckboxProps extends ToggleBaseProps, FormComponentPro
153
158
  ariaLabelledBy?: string;
154
159
  /**
155
160
  * Sets the label of the Checkbox component ([see example]({% slug labels_checkbox %})).
161
+ *
162
+ * @example
163
+ * ```jsx
164
+ * <Checkbox label="Accept Terms" />
165
+ * ```
156
166
  */
157
167
  label?: React.ReactNode;
158
168
  /**
159
169
  * Sets the label position of the Checkbox component ([see example]({% slug labels_checkbox %})).
170
+ *
171
+ * @example
172
+ * ```jsx
173
+ * <Checkbox labelPlacement="before" />
174
+ * ```
160
175
  */
161
176
  labelPlacement?: 'before' | 'after';
162
177
  /**
@@ -261,6 +276,11 @@ export declare interface ColorGradientProps {
261
276
  * Sets the background color that will be compared to the selected value.
262
277
  * The tool will calculate the contrast ratio between two colors.
263
278
  * Currently, only the RGBA format is supported.
279
+ *
280
+ * @example
281
+ * ```jsx
282
+ * <ColorGradient backgroundColor="#ffffff" />
283
+ * ```
264
284
  */
265
285
  backgroundColor?: string;
266
286
  /**
@@ -292,6 +312,11 @@ export declare interface ColorGradientProps {
292
312
  * Sets the default input format in the gradient input editor.
293
313
  *
294
314
  * @default 'rgb'
315
+ *
316
+ * @example
317
+ * ```jsx
318
+ * <ColorGradient format="hex" />
319
+ * ```
295
320
  */
296
321
  format?: 'rgba' | 'rgb' | 'hex';
297
322
  /**
@@ -318,6 +343,11 @@ export declare interface ColorGradientProps {
318
343
  isInsidePopup?: boolean;
319
344
  /**
320
345
  * Determines whether the alpha slider and the alpha input will be displayed. Defaults to `true`.
346
+ *
347
+ * @example
348
+ * ```jsx
349
+ * <ColorGradient opacity={false} />
350
+ * ```
321
351
  */
322
352
  opacity?: boolean;
323
353
  /**
@@ -422,16 +452,17 @@ export declare class ColorGradientWithoutContext extends React_2.Component<Color
422
452
  /**
423
453
  * @hidden
424
454
  */
425
- wrapperRef: React_2.RefObject<HTMLDivElement>;
455
+ wrapperRef: React_2.RefObject<HTMLDivElement | null>;
426
456
  /**
427
457
  * @hidden
428
458
  */
429
- hsvGradientRef: React_2.RefObject<HTMLDivElement>;
459
+ hsvGradientRef: React_2.RefObject<HTMLDivElement | null>;
430
460
  private gradientWrapper;
431
461
  private alphaSlider;
432
462
  private navigation?;
433
463
  private hsvNavigation?;
434
464
  private readonly showLicenseWatermark;
465
+ private resizeObserver;
435
466
  constructor(props: ColorGradientProps);
436
467
  /**
437
468
  * @hidden
@@ -497,7 +528,7 @@ export declare class ColorGradientWithoutContext extends React_2.Component<Color
497
528
  /**
498
529
  * @hidden
499
530
  */
500
- renderRectangleDragHandle(): JSX_2.Element;
531
+ renderRectangleDragHandle(): JSX.Element;
501
532
  /**
502
533
  * @hidden
503
534
  */
@@ -538,11 +569,11 @@ export declare class ColorGradientWithoutContext extends React_2.Component<Color
538
569
  /**
539
570
  * @hidden
540
571
  */
541
- getGradientRectMetrics(): ClientRect;
572
+ getGradientRectMetrics(): DOMRect;
542
573
  /**
543
574
  * @hidden
544
575
  */
545
- render(): JSX_2.Element;
576
+ render(): JSX.Element;
546
577
  private onKeyDown;
547
578
  }
548
579
 
@@ -553,7 +584,7 @@ export declare class ColorInput extends React_2.Component<ColorInputProps, {
553
584
  inputMode: string;
554
585
  }> {
555
586
  constructor(props: ColorInputProps);
556
- render(): JSX_2.Element;
587
+ render(): JSX.Element;
557
588
  private onRgbaRChange;
558
589
  private onRgbaGChange;
559
590
  private onRgbaBChange;
@@ -627,16 +658,31 @@ export declare interface ColorPaletteProps {
627
658
  * The supported values are:
628
659
  * * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
629
660
  * * A string array.
661
+ *
662
+ * @example
663
+ * ```jsx
664
+ * <ColorPalette palette={['#ff0000', '#00ff00', '#0000ff']} />
665
+ * ```
630
666
  */
631
667
  palette?: string[] | string;
632
668
  /**
633
669
  * Specifies the number of columns that will be displayed.
634
670
  * Defaults to `10`.
671
+ *
672
+ * @example
673
+ * ```jsx
674
+ * <ColorPalette columns={5} />
675
+ * ```
635
676
  */
636
677
  columns?: number;
637
678
  /**
638
679
  * Specifies the size of a color cell in px.
639
680
  * Defaults to `24`.
681
+ *
682
+ * @example
683
+ * ```jsx
684
+ * <ColorPalette tileSize={30} />
685
+ * ```
640
686
  */
641
687
  tileSize?: number | TileSize;
642
688
  /**
@@ -761,7 +807,7 @@ export declare class ColorPaletteWithoutContext extends React_2.Component<ColorP
761
807
  /**
762
808
  * @hidden
763
809
  */
764
- wrapperRef: React_2.RefObject<HTMLDivElement>;
810
+ wrapperRef: React_2.RefObject<HTMLDivElement | null>;
765
811
  private paletteService;
766
812
  private get guid();
767
813
  constructor(props: ColorPaletteProps);
@@ -772,7 +818,7 @@ export declare class ColorPaletteWithoutContext extends React_2.Component<ColorP
772
818
  /**
773
819
  * @hidden
774
820
  */
775
- render(): "" | JSX_2.Element;
821
+ render(): "" | JSX.Element;
776
822
  /**
777
823
  * @hidden
778
824
  */
@@ -972,10 +1018,20 @@ export declare interface ColorPickerProps {
972
1018
  /**
973
1019
  * The default value of the ColorPicker
974
1020
  * ([see example]({% slug default_value_colorpicker %})).
1021
+ *
1022
+ * @example
1023
+ * ```jsx
1024
+ * <ColorPicker defaultValue="#ff0000" />
1025
+ * ```
975
1026
  */
976
1027
  defaultValue?: string;
977
1028
  /**
978
1029
  * Specifies the value of the ColorPicker. Currently, only the RGBA format is supported.
1030
+ *
1031
+ * @example
1032
+ * ```jsx
1033
+ * <ColorPicker value="rgba(255, 0, 0, 1)" />
1034
+ * ```
979
1035
  */
980
1036
  value?: string;
981
1037
  /**
@@ -988,6 +1044,11 @@ export declare interface ColorPickerProps {
988
1044
  /**
989
1045
  * Sets the disabled state of the ColorPicker
990
1046
  * ([see example]({% slug disabled_colorpicker %})).
1047
+ *
1048
+ * @example
1049
+ * ```jsx
1050
+ * <ColorPicker disabled={true} />
1051
+ * ```
991
1052
  */
992
1053
  disabled?: boolean;
993
1054
  /**
@@ -1100,9 +1161,14 @@ export declare interface ColorPickerProps {
1100
1161
  * - `small`
1101
1162
  * - `medium`
1102
1163
  * - `large`
1103
- * - `null`&mdash;This option removes the the built-in size styles of the ColorPicker. Allows for custom `padding`.
1164
+ * - `null`&mdash;This option removes the built-in size styles of the ColorPicker. Allows for custom `padding`.
1104
1165
  *
1105
1166
  * @default `medium`
1167
+ *
1168
+ * @example
1169
+ * ```jsx
1170
+ * <ColorPicker size="large" />
1171
+ * ```
1106
1172
  */
1107
1173
  size?: null | 'small' | 'medium' | 'large';
1108
1174
  /**
@@ -1743,14 +1809,29 @@ export declare interface MaskedTextBoxHandle extends Pick<MaskedTextBoxWithoutCo
1743
1809
  export declare interface MaskedTextBoxProps extends FormComponentProps {
1744
1810
  /**
1745
1811
  * Sets a class of the MaskedTextBox DOM element.
1812
+ *
1813
+ * @example
1814
+ * ```jsx
1815
+ * <MaskedTextBox className="custom-class" />
1816
+ * ```
1746
1817
  */
1747
1818
  className?: string;
1748
1819
  /**
1749
1820
  * Sets additional CSS styles to the MaskedTextBox DOM element.
1821
+ *
1822
+ * @example
1823
+ * ```jsx
1824
+ * <MaskedTextBox style={{ color: 'red' }} />
1825
+ * ```
1750
1826
  */
1751
1827
  style?: React.CSSProperties;
1752
1828
  /**
1753
1829
  * Specifies the value of the MaskedTextBox.
1830
+ *
1831
+ * @example
1832
+ * ```jsx
1833
+ * <MaskedTextBox value="123-45-6789" />
1834
+ * ```
1754
1835
  */
1755
1836
  value?: string;
1756
1837
  /**
@@ -1759,6 +1840,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1759
1840
  defaultValue?: string;
1760
1841
  /**
1761
1842
  * Specifies the input placeholder.
1843
+ *
1844
+ * @example
1845
+ * ```jsx
1846
+ * <MaskedTextBox placeholder="Enter text here" />
1847
+ * ```
1762
1848
  */
1763
1849
  placeholder?: string;
1764
1850
  /**
@@ -1767,6 +1853,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1767
1853
  title?: string;
1768
1854
  /**
1769
1855
  * Represents the `dir` HTML attribute.
1856
+ *
1857
+ * @example
1858
+ * ```jsx
1859
+ * <MaskedTextBox dir="rtl" />
1860
+ * ```
1770
1861
  */
1771
1862
  dir?: string;
1772
1863
  /**
@@ -1779,10 +1870,20 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1779
1870
  accessKey?: string;
1780
1871
  /**
1781
1872
  * Specifies the width of the MaskedTextBox.
1873
+ *
1874
+ * @example
1875
+ * ```jsx
1876
+ * <MaskedTextBox width="200px" />
1877
+ * ```
1782
1878
  */
1783
1879
  width?: number | string;
1784
1880
  /**
1785
1881
  * Determines whether the MaskedTextBox is disabled.
1882
+ *
1883
+ * @example
1884
+ * ```jsx
1885
+ * <MaskedTextBox disabled={true} />
1886
+ * ```
1786
1887
  */
1787
1888
  disabled?: boolean;
1788
1889
  /**
@@ -1832,6 +1933,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1832
1933
  maskValidation?: boolean;
1833
1934
  /**
1834
1935
  * Represents the current mask. If no mask is set, the component behaves as a standard `type="text"` input.
1936
+ *
1937
+ * @example
1938
+ * ```jsx
1939
+ * <MaskedTextBox mask="(999) 000-0000" />
1940
+ * ```
1835
1941
  */
1836
1942
  mask?: string;
1837
1943
  /**
@@ -1849,6 +1955,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1849
1955
  };
1850
1956
  /**
1851
1957
  * Determines the event handler that will be fired when the user edits the value.
1958
+ *
1959
+ * @example
1960
+ * ```jsx
1961
+ * <MaskedTextBox onChange={(e) => console.log(e.value)} />
1962
+ * ```
1852
1963
  */
1853
1964
  onChange?: (event: MaskedTextBoxChangeEvent) => void;
1854
1965
  /**
@@ -2074,7 +2185,7 @@ export declare class MaskedTextBoxWithoutContext extends React_2.Component<Maske
2074
2185
  /**
2075
2186
  * @hidden
2076
2187
  */
2077
- render(): JSX_2.Element;
2188
+ render(): JSX.Element;
2078
2189
  private pasteHandler;
2079
2190
  private onChangeHandler;
2080
2191
  private focusHandler;
@@ -2627,71 +2738,151 @@ export declare interface RadioGroupProps {
2627
2738
  /**
2628
2739
  * Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
2629
2740
  * For example these elements could contain error or hint message.
2741
+ *
2742
+ * @example
2743
+ * ```jsx
2744
+ * <RadioGroup ariaDescribedBy="error-message" />
2745
+ * ```
2630
2746
  */
2631
2747
  ariaDescribedBy?: string;
2632
2748
  /**
2633
2749
  * Identifies the element(s) which will label the component.
2750
+ *
2751
+ * @example
2752
+ * ```jsx
2753
+ * <RadioGroup ariaLabelledBy="group-label" />
2754
+ * ```
2634
2755
  */
2635
2756
  ariaLabelledBy?: string;
2636
2757
  /**
2637
2758
  * Specifies a list of CSS classes that will be added to the RadioGroup element.
2759
+ *
2760
+ * @example
2761
+ * ```jsx
2762
+ * <RadioGroup className="custom-class" />
2763
+ * ```
2638
2764
  */
2639
2765
  className?: string;
2640
2766
  /**
2641
2767
  * Specifies the value of the `id` attribute that will be added to the RadioGroup element.
2768
+ *
2769
+ * @example
2770
+ * ```jsx
2771
+ * <RadioGroup id="radio-group" />
2772
+ * ```
2642
2773
  */
2643
2774
  id?: string;
2644
2775
  /**
2645
2776
  * The collection of radio buttons that will be rendered in the RadioGroup ([see example]({% slug overview_radiobutton %})).
2777
+ *
2778
+ * @example
2779
+ * ```jsx
2780
+ * <RadioGroup data={[{ label: 'Option 1', value: 1 }, { label: 'Option 2', value: 2 }]} />
2781
+ * ```
2646
2782
  */
2647
2783
  data?: Array<RadioButtonProps>;
2648
2784
  /**
2649
2785
  * Sets the default checked state of a radio button when used in uncontrolled mode ([see example]({% slug overview_radiobutton %})).
2650
2786
  * The `checked` property is passed to the underlying `input` element.
2787
+ *
2788
+ * @example
2789
+ * ```jsx
2790
+ * <RadioGroup defaultValue={1} />
2791
+ * ```
2651
2792
  */
2652
2793
  defaultValue?: any;
2653
2794
  /**
2654
2795
  * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
2796
+ *
2797
+ * @example
2798
+ * ```jsx
2799
+ * <RadioGroup dir="rtl" />
2800
+ * ```
2655
2801
  */
2656
2802
  dir?: string;
2657
2803
  /**
2658
2804
  * Disable all radio buttons ([see example]({% slug disabled_radiobutton %})).
2805
+ *
2806
+ * @example
2807
+ * ```jsx
2808
+ * <RadioGroup disabled={true} />
2809
+ * ```
2659
2810
  */
2660
2811
  disabled?: boolean;
2661
2812
  /**
2662
2813
  * Overrides the default component responsible for visualizing a single item.
2663
2814
  *
2664
2815
  * The default element is `li` with a [RadioButton]({% slug api_inputs_radiobutton %}) as `children`.
2816
+ *
2817
+ * @example
2818
+ * ```jsx
2819
+ * <RadioGroup item={(props) => <li>{props.label}</li>} />
2820
+ * ```
2665
2821
  */
2666
2822
  item?: React.ComponentType<HTMLAttributes<HTMLLIElement>>;
2667
2823
  /**
2668
2824
  * Sets the label position of the radio buttons.
2669
2825
  * Accepts two options: `before` or `after`. Defaults to `after`.
2826
+ *
2827
+ * @example
2828
+ * ```jsx
2829
+ * <RadioGroup labelPlacement="before" />
2830
+ * ```
2670
2831
  */
2671
2832
  labelPlacement?: string;
2672
2833
  /**
2673
2834
  * Specifies the radio group layout.
2835
+ *
2836
+ * @example
2837
+ * ```jsx
2838
+ * <RadioGroup layout="horizontal" />
2839
+ * ```
2674
2840
  */
2675
2841
  layout?: 'horizontal' | 'vertical';
2676
2842
  /**
2677
2843
  * Specifies the `name` property of the `input` DOM elements.
2844
+ *
2845
+ * @example
2846
+ * ```jsx
2847
+ * <RadioGroup name="options" />
2848
+ * ```
2678
2849
  */
2679
2850
  name?: string;
2680
2851
  /**
2681
2852
  * The event handler that will be fired when the changes the selected value.
2853
+ *
2854
+ * @example
2855
+ * ```jsx
2856
+ * <RadioGroup onChange={(event) => console.log(event.value)} />
2857
+ * ```
2682
2858
  */
2683
2859
  onChange?: (event: RadioGroupChangeEvent) => void;
2684
2860
  /**
2685
2861
  * The event handler that will be fired when Radio button is focused.
2862
+ *
2863
+ * @example
2864
+ * ```jsx
2865
+ * <RadioGroup onFocus={(event) => console.log('Focused')} />
2866
+ * ```
2686
2867
  */
2687
2868
  onFocus?: (event: RadioGroupFocusEvent) => void;
2688
2869
  /**
2689
2870
  * Sets additional CSS styles to the radio group.
2871
+ *
2872
+ * @example
2873
+ * ```jsx
2874
+ * <RadioGroup style={{ margin: '10px' }} />
2875
+ * ```
2690
2876
  */
2691
2877
  style?: React.CSSProperties;
2692
2878
  /**
2693
2879
  * Sets the default checked state of a radio button when used in controlled mode ([see example]({% slug controlled_radiogroup %})).
2694
2880
  * The `checked` property is passed to the underlying `input` element.
2881
+ *
2882
+ * @example
2883
+ * ```jsx
2884
+ * <RadioGroup value={1} />
2885
+ * ```
2695
2886
  */
2696
2887
  value?: string | number | null;
2697
2888
  /**
@@ -2699,6 +2890,11 @@ export declare interface RadioGroupProps {
2699
2890
  * If `valid` is set, the `required` property will be ignored.
2700
2891
  *
2701
2892
  * This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
2893
+ *
2894
+ * @example
2895
+ * ```jsx
2896
+ * <RadioGroup valid={false} />
2897
+ * ```
2702
2898
  */
2703
2899
  valid?: boolean;
2704
2900
  }
@@ -3167,115 +3363,258 @@ export declare interface RatingMouseEvent {
3167
3363
  export declare interface RatingProps extends FormComponentProps {
3168
3364
  /**
3169
3365
  * Sets the `id` property of the top div element of the Rating.
3366
+ *
3367
+ * @example
3368
+ * ```jsx
3369
+ * <Rating id="rating-component" value={3} />
3370
+ * ```
3170
3371
  */
3171
3372
  id?: string;
3172
3373
  /**
3173
- * Sets additional classes to the Rating.
3374
+ * Adds custom CSS classes to the Rating.
3375
+ *
3376
+ * @example
3377
+ * ```jsx
3378
+ * <Rating className="custom-class" value={4} />
3379
+ * ```
3174
3380
  */
3175
3381
  className?: string;
3176
3382
  /**
3177
3383
  * Sets the `tabIndex` attribute.
3384
+ *
3385
+ * @example
3386
+ * ```jsx
3387
+ * <Rating tabIndex={0} value={2} />
3388
+ * ```
3178
3389
  */
3179
3390
  tabIndex?: number;
3180
3391
  /**
3181
3392
  * Sets additional CSS styles to the Rating.
3393
+ *
3394
+ * @example
3395
+ * ```jsx
3396
+ * <Rating style={{ margin: '10px' }} value={5} />
3397
+ * ```
3182
3398
  */
3183
3399
  style?: React_2.CSSProperties;
3184
3400
  /**
3185
3401
  * Determines the children nodes.
3402
+ *
3403
+ * @example
3404
+ * ```jsx
3405
+ * <Rating>
3406
+ * <span>Custom Child</span>
3407
+ * </Rating>
3408
+ * ```
3186
3409
  */
3187
3410
  children?: React_2.ReactNode;
3188
3411
  /**
3189
3412
  * Represents the rendered Rating item.
3413
+ *
3414
+ * @example
3415
+ * ```jsx
3416
+ * <Rating item={(props) => <div>{props.value}</div>} />
3417
+ * ```
3190
3418
  */
3191
3419
  item?: React_2.ComponentType<RatingItemProps>;
3192
3420
  /**
3193
- * Sets the current value of the Rating, used in controlled mode. [See example]({% slug item_customization_ratingitem %})
3421
+ * Sets the current value of the Rating, used in controlled mode.
3422
+ *
3423
+ * @example
3424
+ * ```jsx
3425
+ * <Rating value={3} />
3426
+ * ```
3194
3427
  */
3195
3428
  value?: number;
3196
3429
  /**
3197
- * Sets the default value of the Rating, used in uncontrolled mode. [See example]({% slug controlled_rating %})
3430
+ * Sets the default value of the Rating, used in uncontrolled mode.
3431
+ *
3432
+ * @example
3433
+ * ```jsx
3434
+ * <Rating defaultValue={2} />
3435
+ * ```
3198
3436
  */
3199
3437
  defaultValue?: number;
3200
3438
  /**
3201
- * Sets the min possible icon value or star value in the main use-case.
3439
+ * Sets the minimum possible value of the Rating.
3440
+ *
3441
+ * @example
3442
+ * ```jsx
3443
+ * <Rating min={1} max={10} />
3444
+ * ```
3202
3445
  */
3203
3446
  min?: number;
3204
3447
  /**
3205
- * Sets the max possible icon value or star value in the main use-case.
3448
+ * Sets the maximum possible value of the Rating.
3449
+ *
3450
+ * @example
3451
+ * ```jsx
3452
+ * <Rating max={10} />
3453
+ * ```
3206
3454
  */
3207
3455
  max?: number;
3208
3456
  /**
3209
- * Sets the step value between the min and max value.
3457
+ * Sets the step value between the minimum and maximum values.
3458
+ *
3459
+ * @example
3460
+ * ```jsx
3461
+ * <Rating step={0.5} />
3462
+ * ```
3210
3463
  */
3211
3464
  step?: number;
3212
3465
  /**
3213
- * Determines the Rating direction `ltr` - by default, or `rtl`.
3466
+ * Specifies the direction of the Rating (`ltr` or `rtl`).
3467
+ *
3468
+ * @example
3469
+ * ```jsx
3470
+ * <Rating dir="rtl" />
3471
+ * ```
3214
3472
  */
3215
3473
  dir?: string;
3216
3474
  /**
3217
- * Determines if the Rating has a label and is it a custom one.
3475
+ * Sets a custom label for the Rating.
3476
+ *
3477
+ * @example
3478
+ * ```jsx
3479
+ * <Rating label="Rating Label" />
3480
+ * ```
3218
3481
  */
3219
3482
  label?: string;
3220
3483
  /**
3221
- * Sets the `readonly` mode of the Rating, if it is set to `true`. [See example]({% slug label_rating %})
3484
+ * Sets the `readonly` mode of the Rating.
3485
+ *
3486
+ * @example
3487
+ * ```jsx
3488
+ * <Rating readonly={true} value={4} />
3489
+ * ```
3222
3490
  */
3223
3491
  readonly?: boolean;
3224
3492
  /**
3225
- * Sets the `disabled` mode of the Rating, if it is set to `true`. [See example]({% slug readonly_rating %})
3493
+ * Disables the Rating when set to `true`.
3494
+ *
3495
+ * @example
3496
+ * ```jsx
3497
+ * <Rating disabled={true} />
3498
+ * ```
3226
3499
  */
3227
3500
  disabled?: boolean;
3228
3501
  /**
3229
- * Sets custom Rating icon, by default - star. [See example]({% slug disabled_rating %})
3502
+ * Sets a custom icon for the Rating.
3503
+ *
3504
+ * @example
3505
+ * ```jsx
3506
+ * <Rating icon="star" />
3507
+ * ```
3230
3508
  */
3231
3509
  icon?: string;
3232
3510
  /**
3233
- * Sets custom Rating SVG icon.
3511
+ * Sets a custom SVG icon for the Rating.
3512
+ *
3513
+ * @example
3514
+ * ```jsx
3515
+ * import { gearIcon } from '@progress/kendo-svg-icons';
3516
+ *
3517
+ * <Rating svgIcon={gearIcon} />
3518
+ * ```
3234
3519
  */
3235
3520
  svgIcon?: SVGIcon;
3236
3521
  /**
3237
- * Sets custom Rating SVG icon.
3522
+ * Sets a custom outline SVG icon for the Rating.
3523
+ *
3524
+ * @example
3525
+ * ```jsx
3526
+ * <Rating svgIconOutline={customOutlineSvgIcon} />
3527
+ * ```
3238
3528
  */
3239
3529
  svgIconOutline?: SVGIcon;
3240
3530
  /**
3241
- * Determines the selection mode. By default set to `continues`. [See example]({% slug icon_rating %})
3531
+ * Determines the selection mode of the Rating (`continues` or `single`).
3532
+ *
3533
+ * @example
3534
+ * ```jsx
3535
+ * <Rating selection="single" />
3536
+ * ```
3242
3537
  */
3243
3538
  selection?: 'continues' | 'single';
3244
3539
  /**
3245
- * Determines the precision of the Rating. By default set to `item`. [See example]({% slug selection_rating %})
3540
+ * Determines the precision of the Rating (`item` or `half`).
3541
+ *
3542
+ * @example
3543
+ * ```jsx
3544
+ * <Rating precision="half" />
3545
+ * ```
3246
3546
  */
3247
3547
  precision?: 'half' | 'item';
3248
3548
  /**
3249
- * Determines if value represents half icon -> true, or not -> false. [See example]({% slug precision_rating %})
3549
+ * Determines if the value represents a half icon (`true`) or not (`false`).
3550
+ *
3551
+ * @example
3552
+ * ```jsx
3553
+ * <Rating half={true} />
3554
+ * ```
3250
3555
  */
3251
3556
  half?: boolean;
3252
3557
  /**
3253
- * Triggered after value change. Gets outside access to the target element, the new value and the event type.
3558
+ * Fires when the value of the Rating changes.
3559
+ *
3560
+ * @example
3561
+ * ```jsx
3562
+ * <Rating onChange={(event) => console.log(event.value)} />
3563
+ * ```
3254
3564
  */
3255
3565
  onChange?: (event: RatingChangeEvent) => void;
3256
3566
  /**
3257
- * Triggered after `onClick` event. Gets outside access to the target element, the new value and the event type.
3567
+ * Fires when the Rating is clicked.
3568
+ *
3569
+ * @example
3570
+ * ```jsx
3571
+ * <Rating onClick={(event) => console.log(event.value)} />
3572
+ * ```
3258
3573
  */
3259
3574
  onClick?: (event: RatingItemMouseEvent) => void;
3260
3575
  /**
3261
- * Triggered after `onKeyDown` event. Gets outside access to the target element, the new value and the event type.
3576
+ * Fires when a key is pressed while the Rating is focused.
3577
+ *
3578
+ * @example
3579
+ * ```jsx
3580
+ * <Rating onKeyDown={(event) => console.log(event.value)} />
3581
+ * ```
3262
3582
  */
3263
3583
  onKeyDown?: (event: RatingKeyboardEvent) => void;
3264
3584
  /**
3265
- * Triggered after `onFocus` event. Gets outside access to the target element and the event type.
3585
+ * Fires when the Rating is focused.
3586
+ *
3587
+ * @example
3588
+ * ```jsx
3589
+ * <Rating onFocus={(event) => console.log('Focused')} />
3590
+ * ```
3266
3591
  */
3267
3592
  onFocus?: (event: RatingItemFocusEvent) => void;
3268
3593
  /**
3269
- * Triggered after `onBlur` event. Gets outside access to the target element and the event type.
3594
+ * Fires when the Rating loses focus.
3595
+ *
3596
+ * @example
3597
+ * ```jsx
3598
+ * <Rating onBlur={(event) => console.log('Blurred')} />
3599
+ * ```
3270
3600
  */
3271
3601
  onBlur?: (event: RatingItemFocusEvent) => void;
3272
3602
  /**
3273
- * Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
3274
- * For example these elements could contain error or hint message.
3603
+ * Identifies the element(s) which will describe the component.
3604
+ *
3605
+ * @example
3606
+ * ```jsx
3607
+ * <Rating ariaDescribedBy="description-id" />
3608
+ * ```
3275
3609
  */
3276
3610
  ariaDescribedBy?: string;
3277
3611
  /**
3278
3612
  * Identifies the element(s) which will label the component.
3613
+ *
3614
+ * @example
3615
+ * ```jsx
3616
+ * <Rating ariaLabelledBy="label-id" />
3617
+ * ```
3279
3618
  */
3280
3619
  ariaLabelledBy?: string;
3281
3620
  }
@@ -3394,132 +3733,201 @@ export declare interface SignatureOpenEvent extends BaseEvent<SignatureHandle> {
3394
3733
  */
3395
3734
  export declare interface SignatureProps extends FormComponentProps {
3396
3735
  /**
3397
- * Sets a class of the Signature DOM element.
3736
+ * Adds custom CSS classes to the Signature.
3737
+ *
3738
+ * @example
3739
+ * ```jsx
3740
+ * <Signature className="custom-class" />
3741
+ * ```
3398
3742
  */
3399
3743
  className?: string;
3400
3744
  /**
3401
- * Specifies the value of the Signature.
3745
+ * Specifies the value of the Signature as a Data URL.
3402
3746
  *
3403
- * The value is an image encoded as a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
3747
+ * @example
3748
+ * ```jsx
3749
+ * <Signature value="data:image/png;base64,..." />
3750
+ * ```
3404
3751
  */
3405
3752
  value?: string;
3406
3753
  /**
3407
3754
  * Specifies the width of the Signature in pixels.
3755
+ *
3756
+ * @example
3757
+ * ```jsx
3758
+ * <Signature width={500} />
3759
+ * ```
3408
3760
  */
3409
3761
  width?: number;
3410
3762
  /**
3411
3763
  * Specifies the height of the Signature in pixels.
3764
+ *
3765
+ * @example
3766
+ * ```jsx
3767
+ * <Signature height={300} />
3768
+ * ```
3412
3769
  */
3413
3770
  height?: number;
3414
3771
  /**
3415
- * Sets the `tabIndex` property of the Signature.
3772
+ * Specifies the `tabIndex` of the Signature.
3773
+ *
3774
+ * @example
3775
+ * ```jsx
3776
+ * <Signature tabIndex={0} />
3777
+ * ```
3416
3778
  */
3417
3779
  tabIndex?: number;
3418
3780
  /**
3419
- * Sets the `id` of the Signature DOM element.
3781
+ * Specifies the `id` of the Signature.
3782
+ *
3783
+ * @example
3784
+ * ```jsx
3785
+ * <Signature id="signature-component" />
3786
+ * ```
3420
3787
  */
3421
3788
  id?: string;
3422
3789
  /**
3423
3790
  * Represents the `dir` HTML attribute.
3791
+ *
3792
+ * @example
3793
+ * ```jsx
3794
+ * <Signature dir="rtl" />
3795
+ * ```
3424
3796
  */
3425
3797
  dir?: string;
3426
3798
  /**
3427
3799
  * Specifies the name of the Signature input.
3800
+ *
3801
+ * @example
3802
+ * ```jsx
3803
+ * <Signature name="signature" />
3804
+ * ```
3428
3805
  */
3429
3806
  name?: string;
3430
3807
  /**
3431
- * Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
3432
- * For example these elements could contain error or hint message.
3808
+ * Identifies the element(s) which will describe the component.
3809
+ *
3810
+ * @example
3811
+ * ```jsx
3812
+ * <Signature ariaDescribedBy="description-id" />
3813
+ * ```
3433
3814
  */
3434
3815
  ariaDescribedBy?: string;
3435
3816
  /**
3436
3817
  * Identifies the element(s) which will label the component.
3818
+ *
3819
+ * @example
3820
+ * ```jsx
3821
+ * <Signature ariaLabelledBy="label-id" />
3822
+ * ```
3437
3823
  */
3438
3824
  ariaLabelledBy?: string;
3439
3825
  /**
3440
- * The accessible label of the component.
3826
+ * Specifies the accessible label of the Signature.
3827
+ *
3828
+ * @example
3829
+ * ```jsx
3830
+ * <Signature ariaLabel="Signature field" />
3831
+ * ```
3441
3832
  */
3442
3833
  ariaLabel?: string;
3443
3834
  /**
3444
- * Determines whether the Signature is in its read-only state.
3835
+ * Sets the Signature to read-only mode.
3836
+ *
3837
+ * @example
3838
+ * ```jsx
3839
+ * <Signature readOnly={true} />
3840
+ * ```
3445
3841
  */
3446
3842
  readOnly?: boolean;
3447
3843
  /**
3448
- * Determines whether the Signature is in its disabled state.
3844
+ * Disables the Signature when set to `true`.
3845
+ *
3846
+ * @example
3847
+ * ```jsx
3848
+ * <Signature disabled={true} />
3849
+ * ```
3449
3850
  */
3450
3851
  disabled?: boolean;
3451
3852
  /**
3452
- * Configures the `size` of the Signature.
3853
+ * Configures the size of the Signature.
3453
3854
  *
3454
- * The available options are:
3455
- * - small
3456
- * - medium
3457
- * - large
3458
- * - null&mdash;Does not set a size `className`.
3459
- *
3460
- * @default `medium`
3855
+ * @example
3856
+ * ```jsx
3857
+ * <Signature size="large" />
3858
+ * ```
3461
3859
  */
3462
3860
  size?: null | 'small' | 'medium' | 'large';
3463
3861
  /**
3464
- * Configures the `roundness` of the Signature.
3862
+ * Configures the roundness of the Signature.
3465
3863
  *
3466
- * The available options are:
3467
- * - small
3468
- * - medium
3469
- * - large
3470
- * - null&mdash;Does not set a rounded `className`.
3471
- *
3472
- * @default `medium`
3864
+ * @example
3865
+ * ```jsx
3866
+ * <Signature rounded="medium" />
3867
+ * ```
3473
3868
  */
3474
3869
  rounded?: null | 'small' | 'medium' | 'large';
3475
3870
  /**
3476
- * Configures the `fillMode` of the Signature.
3871
+ * Configures the fill mode of the Signature.
3477
3872
  *
3478
- * The available options are:
3479
- * - solid
3480
- * - outline
3481
- * - flat
3482
- * - null&mdash;Does not set a fillMode `className`.
3483
- *
3484
- * @default `solid`
3873
+ * @example
3874
+ * ```jsx
3875
+ * <Signature fillMode="solid" />
3876
+ * ```
3485
3877
  */
3486
3878
  fillMode?: null | 'solid' | 'flat' | 'outline';
3487
3879
  /**
3488
- * The stroke color of the signature.
3489
- *
3490
- * Accepts CSS color names and hex values.
3880
+ * Specifies the stroke color of the Signature.
3491
3881
  *
3492
- * The default value is determined by the theme `$kendo-input-text` variable.
3882
+ * @example
3883
+ * ```jsx
3884
+ * <Signature color="blue" />
3885
+ * ```
3493
3886
  */
3494
3887
  color?: string;
3495
3888
  /**
3496
- * The background color of the signature.
3889
+ * Specifies the background color of the Signature.
3497
3890
  *
3498
- * Accepts CSS color names and hex values.
3499
- *
3500
- * The default value is determined by the theme `$kendo-input-bg` variable.
3891
+ * @example
3892
+ * ```jsx
3893
+ * <Signature backgroundColor="lightgray" />
3894
+ * ```
3501
3895
  */
3502
3896
  backgroundColor?: string;
3503
3897
  /**
3504
- * The stroke width of the signature.
3898
+ * Specifies the stroke width of the Signature.
3505
3899
  *
3506
- * @default 1
3900
+ * @example
3901
+ * ```jsx
3902
+ * <Signature strokeWidth={2} />
3903
+ * ```
3507
3904
  */
3508
3905
  strokeWidth?: number;
3509
3906
  /**
3510
- * A flag indicating whether to smooth out signature lines.
3907
+ * Enables smoothing of the signature lines.
3511
3908
  *
3512
- * @default false
3909
+ * @example
3910
+ * ```jsx
3911
+ * <Signature smooth={true} />
3912
+ * ```
3513
3913
  */
3514
3914
  smooth?: boolean;
3515
3915
  /**
3516
- * A flag indicating if the signature can be maximized.
3916
+ * Enables the maximizable feature of the Signature.
3517
3917
  *
3518
- * @default true
3918
+ * @example
3919
+ * ```jsx
3920
+ * <Signature maximizable={true} />
3921
+ * ```
3519
3922
  */
3520
3923
  maximizable?: boolean;
3521
3924
  /**
3522
- * Sets the open and close state of the Signature.
3925
+ * Sets the open state of the Signature popup.
3926
+ *
3927
+ * @example
3928
+ * ```jsx
3929
+ * <Signature open={true} />
3930
+ * ```
3523
3931
  */
3524
3932
  open?: boolean;
3525
3933
  /**
@@ -3528,6 +3936,10 @@ export declare interface SignatureProps extends FormComponentProps {
3528
3936
  * The Signature width and height will be multiplied by the scale when showing the popup.
3529
3937
  *
3530
3938
  * @default 3
3939
+ * @example
3940
+ * ```jsx
3941
+ * <Signature popupScale={1.5} />
3942
+ * ```
3531
3943
  */
3532
3944
  popupScale?: number;
3533
3945
  /**
@@ -3536,40 +3948,84 @@ export declare interface SignatureProps extends FormComponentProps {
3536
3948
  * The Signature width and height will be multiplied by the scale when converting the signature to an image.
3537
3949
  *
3538
3950
  * @default 2
3951
+ *
3952
+ * @example
3953
+ * ```jsx
3954
+ * <Signature exportScale={2} />
3955
+ * ```
3539
3956
  */
3540
3957
  exportScale?: number;
3541
3958
  /**
3542
- * A flag indicating whether the dotted line should be displayed in the background.
3959
+ * Hides the dotted line in the background.
3543
3960
  *
3544
3961
  * @default false
3962
+ * @example
3963
+ * ```jsx
3964
+ * <Signature hideLine={true} />
3965
+ * ```
3545
3966
  */
3546
3967
  hideLine?: boolean;
3547
3968
  /**
3548
3969
  * Represents the `style` HTML attribute.
3970
+ *
3971
+ * @example
3972
+ * ```jsx
3973
+ * <Signature style={{ border: '1px solid black' }} />
3974
+ * ```
3549
3975
  */
3550
3976
  style?: React.CSSProperties;
3551
3977
  /**
3552
3978
  * Represents the input element `style` HTML attribute.
3979
+ *
3980
+ * @example
3981
+ * ```jsx
3982
+ * <Signature inputStyle={{ padding: '10px' }} />
3983
+ * ```
3553
3984
  */
3554
3985
  inputStyle?: React.CSSProperties;
3555
3986
  /**
3556
- * Determines the event handler that will be fired when the user edits the value.
3987
+ * Fires when the value of the Signature changes.
3988
+ *
3989
+ * @example
3990
+ * ```jsx
3991
+ * <Signature onChange={(event) => console.log(event.value)} />
3992
+ * ```
3557
3993
  */
3558
3994
  onChange?: (event: SignatureChangeEvent) => void;
3559
3995
  /**
3560
- * The event handler that will be fired when Signature is focused.
3996
+ * Fires when the Signature is focused.
3997
+ *
3998
+ * @example
3999
+ * ```jsx
4000
+ * <Signature onFocus={(event) => console.log('Focused')} />
4001
+ * ```
3561
4002
  */
3562
4003
  onFocus?: (event: SignatureFocusEvent) => void;
3563
4004
  /**
3564
- * The event handler that will be fired when Signature is blurred.
4005
+ * Fires when the Signature is blurred.
4006
+ *
4007
+ * @example
4008
+ * ```jsx
4009
+ * <Signature onBlur={(event) => console.log('Blurred')} />
4010
+ * ```
3565
4011
  */
3566
4012
  onBlur?: (event: SignatureBlurEvent) => void;
3567
4013
  /**
3568
- * The event handler that will be fired when Signature popup is open.
4014
+ * Fires when the Signature popup is opened.
4015
+ *
4016
+ * @example
4017
+ * ```jsx
4018
+ * <Signature onOpen={(event) => console.log('Popup opened')} />
4019
+ * ```
3569
4020
  */
3570
4021
  onOpen?: (event: SignatureOpenEvent) => void;
3571
4022
  /**
3572
- * The event handler that will be fired when Signature popup is closed.
4023
+ * Fires when the Signature popup is closed.
4024
+ *
4025
+ * @example
4026
+ * ```jsx
4027
+ * <Signature onClose={(event) => console.log('Popup closed')} />
4028
+ * ```
3573
4029
  */
3574
4030
  onClose?: (event: SignatureCloseEvent) => void;
3575
4031
  /** @hidden */
@@ -3621,7 +4077,7 @@ export declare interface SliderHandle extends Pick<SliderWithoutContext, keyof S
3621
4077
  /**
3622
4078
  * Represents the KendoReact SliderLabel component.
3623
4079
  */
3624
- export declare const SliderLabel: (props: SliderLabelProps) => JSX_2.Element;
4080
+ export declare const SliderLabel: (props: SliderLabelProps) => JSX.Element;
3625
4081
 
3626
4082
  /**
3627
4083
  * Represents the props of the KendoReact SliderLabel component.
@@ -3665,88 +4121,166 @@ export declare interface SliderLabelProps {
3665
4121
  export declare interface SliderProps extends FormComponentProps {
3666
4122
  children?: React_2.ReactNode;
3667
4123
  /**
3668
- * The value of the Slider.
4124
+ * Specifies the current value of the Slider.
4125
+ *
4126
+ * @example
4127
+ * ```jsx
4128
+ * <Slider value={50} min={0} max={100} />
4129
+ * ```
3669
4130
  */
3670
4131
  value?: number;
3671
4132
  /**
3672
- * The default value of the Slider.
4133
+ * Specifies the default value of the Slider.
4134
+ *
4135
+ * @example
4136
+ * ```jsx
4137
+ * <Slider defaultValue={30} min={0} max={100} />
4138
+ * ```
3673
4139
  */
3674
4140
  defaultValue?: number;
3675
4141
  /**
3676
- * The minimum value of the Slider.
4142
+ * Specifies the minimum value of the Slider.
4143
+ *
4144
+ * @example
4145
+ * ```jsx
4146
+ * <Slider min={0} max={100} />
4147
+ * ```
3677
4148
  */
3678
4149
  min: number;
3679
4150
  /**
3680
- * The maximum value of the Slider.
4151
+ * Specifies the maximum value of the Slider.
4152
+ *
4153
+ * @example
4154
+ * ```jsx
4155
+ * <Slider min={0} max={100} />
4156
+ * ```
3681
4157
  */
3682
4158
  max: number;
3683
4159
  /**
3684
4160
  * Specifies the step by which the Slider's value will be increased or decreased using its buttons or keyboard arrows.
4161
+ *
4162
+ * @example
4163
+ * ```jsx
4164
+ * <Slider step={5} min={0} max={100} />
4165
+ * ```
3685
4166
  */
3686
4167
  step?: number;
3687
4168
  /**
3688
4169
  * Specifies the step by which the Slider's value will be increased or decreased using `pageUp` or `pageDown` keyboard buttons.
4170
+ *
4171
+ * @example
4172
+ * ```jsx
4173
+ * <Slider largeStep={10} min={0} max={100} />
4174
+ * ```
3689
4175
  */
3690
4176
  largeStep?: number;
3691
4177
  /**
3692
- * Determines the event handler that will be fired when the user edits the value.
4178
+ * Fires when the value of the Slider changes.
4179
+ *
4180
+ * @example
4181
+ * ```jsx
4182
+ * <Slider onChange={(event) => console.log(event.value)} min={0} max={100} />
4183
+ * ```
3693
4184
  */
3694
4185
  onChange?: (event: SliderChangeEvent) => void;
3695
4186
  /**
3696
- * The styles that are applied to the Slider.
4187
+ * Sets additional CSS styles to the Slider.
4188
+ *
4189
+ * @example
4190
+ * ```jsx
4191
+ * <Slider style={{ margin: '10px' }} min={0} max={100} />
4192
+ * ```
3697
4193
  */
3698
4194
  style?: React_2.CSSProperties;
3699
4195
  /**
3700
- * Sets additional classes to the Slider.
4196
+ * Adds custom CSS classes to the Slider.
4197
+ *
4198
+ * @example
4199
+ * ```jsx
4200
+ * <Slider className="custom-class" min={0} max={100} />
4201
+ * ```
3701
4202
  */
3702
4203
  className?: string;
3703
4204
  /**
3704
- * Renders the arrow side buttons of the Slider if set to true.
4205
+ * Renders the arrow side buttons of the Slider if set to `true`.
4206
+ *
4207
+ * @example
4208
+ * ```jsx
4209
+ * <Slider buttons={true} min={0} max={100} />
4210
+ * ```
3705
4211
  */
3706
4212
  buttons?: boolean;
3707
4213
  /**
3708
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex)
3709
- * of the Slider.
4214
+ * Specifies the `tabIndex` of the Slider.
4215
+ *
4216
+ * @example
4217
+ * ```jsx
4218
+ * <Slider tabIndex={0} min={0} max={100} />
4219
+ * ```
3710
4220
  */
3711
4221
  tabIndex?: number;
3712
4222
  /**
3713
- * Determines whether the Slider is disabled.
4223
+ * When `true`, disables the Slider.
3714
4224
  *
3715
4225
  * @example
3716
4226
  * ```jsx
3717
- * class App extends React.Component {
3718
- * render() {
3719
- * return (
3720
- * <Slider disabled={true} min={0} max={10} defaultValue={5} />
3721
- * );
3722
- * }
3723
- * }
3724
- * ReactDOM.render(<App />, document.querySelector('my-app'));
4227
+ * <Slider disabled={true} min={0} max={100} />
3725
4228
  * ```
3726
4229
  */
3727
4230
  disabled?: boolean;
3728
4231
  /**
3729
- * If `vertical` is set to `true`, the orientation of the Slider changes from horizontal to vertical
3730
- * ([see example]({% slug orientation_slider %})).
4232
+ * Changes the orientation of the Slider to vertical if set to `true`.
4233
+ *
4234
+ * @example
4235
+ * ```jsx
4236
+ * <Slider vertical={true} min={0} max={100} />
4237
+ * ```
3731
4238
  */
3732
4239
  vertical?: boolean;
3733
4240
  /**
3734
- * Specifies the id of the component.
4241
+ * Specifies the `id` of the Slider.
4242
+ *
4243
+ * @example
4244
+ * ```jsx
4245
+ * <Slider id="slider-component" min={0} max={100} />
4246
+ * ```
3735
4247
  */
3736
4248
  id?: string;
3737
4249
  /**
3738
- * Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
3739
- * For example these elements could contain error or hint message.
4250
+ * Identifies the element(s) which will describe the component.
4251
+ *
4252
+ * @example
4253
+ * ```jsx
4254
+ * <Slider ariaDescribedBy="description-id" min={0} max={100} />
4255
+ * ```
3740
4256
  */
3741
4257
  ariaDescribedBy?: string;
3742
4258
  /**
3743
4259
  * Identifies the element(s) which will label the component.
4260
+ *
4261
+ * @example
4262
+ * ```jsx
4263
+ * <Slider ariaLabelledBy="label-id" min={0} max={100} />
4264
+ * ```
3744
4265
  */
3745
4266
  ariaLabelledBy?: string;
3746
4267
  /**
3747
- * The accessible label of the component.
4268
+ * Specifies the accessible label of the Slider.
4269
+ *
4270
+ * @example
4271
+ * ```jsx
4272
+ * <Slider ariaLabel="Slider component" min={0} max={100} />
4273
+ * ```
3748
4274
  */
3749
4275
  ariaLabel?: string;
4276
+ /**
4277
+ * Specifies the direction of the Slider (`ltr` or `rtl`).
4278
+ *
4279
+ * @example
4280
+ * ```jsx
4281
+ * <Slider dir="rtl" min={0} max={100} />
4282
+ * ```
4283
+ */
3750
4284
  dir?: Direction;
3751
4285
  }
3752
4286
 
@@ -3811,7 +4345,7 @@ export declare class SliderWithoutContext extends React_2.Component<SliderProps,
3811
4345
  /**
3812
4346
  * @hidden
3813
4347
  */
3814
- render(): JSX_2.Element;
4348
+ render(): JSX.Element;
3815
4349
  /**
3816
4350
  * @hidden
3817
4351
  */
@@ -3885,34 +4419,74 @@ export declare interface SwitchHandle extends Pick<SwitchWithoutContext, keyof S
3885
4419
  export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps {
3886
4420
  /**
3887
4421
  * Specifies the `accessKey` of the Switch.
4422
+ *
4423
+ * @example
4424
+ * ```jsx
4425
+ * <Switch accessKey="s" />
4426
+ * ```
3888
4427
  */
3889
4428
  accessKey?: string;
3890
4429
  /**
3891
4430
  * Sets the current value of the Switch ([see example]({% slug controlled_switch %})).
4431
+ *
4432
+ * @example
4433
+ * ```jsx
4434
+ * <Switch checked={true} />
4435
+ * ```
3892
4436
  */
3893
4437
  checked?: boolean;
3894
4438
  /**
3895
- * Sets the `className` of the wrapping element of the Switch.
4439
+ * Adds custom CSS classes to the Switch.
4440
+ *
4441
+ * @example
4442
+ * ```jsx
4443
+ * <Switch className="custom-class" />
4444
+ * ```
3896
4445
  */
3897
4446
  className?: string;
3898
4447
  /**
3899
4448
  * Sets the value of the Switch when it is initially displayed ([see example]({% slug default_state %})).
4449
+ *
4450
+ * @example
4451
+ * ```jsx
4452
+ * <Switch defaultChecked={true} />
4453
+ * ```
3900
4454
  */
3901
4455
  defaultChecked?: boolean;
3902
4456
  /**
3903
- * Sets the default value of the Switch.
4457
+ * Specifies the default value of the Switch.
4458
+ *
4459
+ * @example
4460
+ * ```jsx
4461
+ * <Switch defaultValue={true} />
4462
+ * ```
3904
4463
  */
3905
4464
  defaultValue?: any;
3906
4465
  /**
3907
4466
  * Disables the Switch when set to `true` ([see example]({% slug disabled_switch %})).
4467
+ *
4468
+ * @example
4469
+ * ```jsx
4470
+ * <Switch disabled={true} />
4471
+ * ```
3908
4472
  */
3909
4473
  disabled?: boolean;
3910
4474
  /**
3911
- * Sets the `dir` property of the wrapping element of the Switch.
4475
+ * Specifies the `dir` property of the wrapping element of the Switch.
4476
+ *
4477
+ * @example
4478
+ * ```jsx
4479
+ * <Switch dir="rtl" />
4480
+ * ```
3912
4481
  */
3913
4482
  dir?: string;
3914
4483
  /**
3915
- * Sets the `id` of the Switch.
4484
+ * Specifies the `id` of the Switch.
4485
+ *
4486
+ * @example
4487
+ * ```jsx
4488
+ * <Switch id="switch-component" />
4489
+ * ```
3916
4490
  */
3917
4491
  id?: string;
3918
4492
  /**
@@ -3925,6 +4499,10 @@ export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps
3925
4499
  * - null&mdash;Does not set a size `className`.
3926
4500
  *
3927
4501
  * @default `medium`
4502
+ * @example
4503
+ * ```jsx
4504
+ * <Switch size="large" />
4505
+ * ```
3928
4506
  */
3929
4507
  size?: null | 'small' | 'medium' | 'large';
3930
4508
  /**
@@ -3938,10 +4516,14 @@ export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps
3938
4516
  * - null&mdash;Does not set a trackRounded `className`.
3939
4517
  *
3940
4518
  * @default `full`
4519
+ * @example
4520
+ * ```jsx
4521
+ * <Switch trackRounded="medium" />
4522
+ * ```
3941
4523
  */
3942
4524
  trackRounded?: null | 'small' | 'medium' | 'large' | 'full';
3943
4525
  /**
3944
- * Configures the `thumbRounded` of the Switch.
4526
+ * Configures the `thumbRounded` property of the Switch.
3945
4527
  *
3946
4528
  * The available options are:
3947
4529
  * - small
@@ -3950,48 +4532,101 @@ export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps
3950
4532
  * - full
3951
4533
  * - null&mdash;Does not set a thumbRounded `className`.
3952
4534
  *
3953
- * @default `full`
4535
+ * @example
4536
+ * ```jsx
4537
+ * <Switch thumbRounded="full" />
4538
+ * ```
3954
4539
  */
3955
4540
  thumbRounded?: null | 'small' | 'medium' | 'large' | 'full';
3956
4541
  /**
3957
- * Identifies the element(s) which will describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
4542
+ * Identifies the element(s) which will describe the component.
3958
4543
  * For example these elements could contain error or hint message.
4544
+ *
4545
+ * @example
4546
+ * ```jsx
4547
+ * <Switch ariaDescribedBy="description-id" />
4548
+ * ```
3959
4549
  */
3960
4550
  ariaDescribedBy?: string;
3961
4551
  /**
3962
4552
  * Identifies the element(s) which will label the component.
4553
+ *
4554
+ * @example
4555
+ * ```jsx
4556
+ * <Switch ariaLabelledBy="label-id" />
4557
+ * ```
3963
4558
  */
3964
4559
  ariaLabelledBy?: string;
3965
4560
  /**
3966
- * Sets custom **Off** label([see example]({% slug labels_switch %})).
4561
+ * Sets a custom label for the **Off** state.
4562
+ *
4563
+ * @example
4564
+ * ```jsx
4565
+ * <Switch offLabel="No" />
4566
+ * ```
3967
4567
  */
3968
4568
  offLabel?: React_2.ReactNode;
3969
4569
  /**
3970
- * Fires each time the Switch gets blurred.
4570
+ * Fires when the Switch is blurred.
4571
+ *
4572
+ * @example
4573
+ * ```jsx
4574
+ * <Switch onBlur={(event) => console.log('Blurred')} />
4575
+ * ```
3971
4576
  */
3972
4577
  onBlur?: (event: React_2.FocusEvent<HTMLSpanElement>) => void;
3973
4578
  /**
3974
- * Fires each time the user selects a new value ([see example]({% slug controlled_switch %})).
4579
+ * Fires when the value of the Switch changes.
4580
+ *
4581
+ * @example
4582
+ * ```jsx
4583
+ * <Switch onChange={(event) => console.log(event.value)} />
4584
+ * ```
3975
4585
  */
3976
4586
  onChange?: (event: SwitchChangeEvent) => void;
3977
4587
  /**
3978
- * Fires each time the Switch component gets focused.
4588
+ * Fires when the Switch is focused.
4589
+ *
4590
+ * @example
4591
+ * ```jsx
4592
+ * <Switch onFocus={(event) => console.log('Focused')} />
4593
+ * ```
3979
4594
  */
3980
4595
  onFocus?: (event: React_2.FocusEvent<HTMLSpanElement>) => void;
3981
4596
  /**
3982
- * Sets custom **On** label ([see example]({% slug labels_switch %})).
4597
+ * Sets a custom label for the **On** state.
4598
+ *
4599
+ * @example
4600
+ * ```jsx
4601
+ * <Switch onLabel="Yes" />
4602
+ * ```
3983
4603
  */
3984
4604
  onLabel?: React_2.ReactNode;
3985
4605
  /**
3986
4606
  * Specifies the [`tabIndex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
4607
+ *
4608
+ * @example
4609
+ * ```jsx
4610
+ * <Switch tabIndex={0} />
4611
+ * ```
3987
4612
  */
3988
4613
  tabIndex?: number;
3989
4614
  /**
3990
- * Sets the value of the Switch. It can either be of the primitive (string, number, boolean) or of the complex (array) type.
4615
+ * Specifies the value of the Switch.
4616
+ *
4617
+ * @example
4618
+ * ```jsx
4619
+ * <Switch value={true} />
4620
+ * ```
3991
4621
  */
3992
4622
  value?: string | number | string[] | boolean | null;
3993
4623
  /**
3994
- * The accessible label of the component.
4624
+ * Specifies the accessible label of the Switch.
4625
+ *
4626
+ * @example
4627
+ * ```jsx
4628
+ * <Switch ariaLabel="Toggle switch" />
4629
+ * ```
3995
4630
  */
3996
4631
  ariaLabel?: string;
3997
4632
  }
@@ -4116,7 +4751,7 @@ export declare class SwitchWithoutContext extends React_2.Component<SwitchProps,
4116
4751
  /**
4117
4752
  * @hidden
4118
4753
  */
4119
- render(): JSX_2.Element;
4754
+ render(): JSX.Element;
4120
4755
  private dummyInput;
4121
4756
  private handleClick;
4122
4757
  private handleKeyDown;