@progress/kendo-react-inputs 10.2.0-develop.6 → 10.2.0-develop.8

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.ts CHANGED
@@ -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
  /**
@@ -628,16 +658,31 @@ export declare interface ColorPaletteProps {
628
658
  * The supported values are:
629
659
  * * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
630
660
  * * A string array.
661
+ *
662
+ * @example
663
+ * ```jsx
664
+ * <ColorPalette palette={['#ff0000', '#00ff00', '#0000ff']} />
665
+ * ```
631
666
  */
632
667
  palette?: string[] | string;
633
668
  /**
634
669
  * Specifies the number of columns that will be displayed.
635
670
  * Defaults to `10`.
671
+ *
672
+ * @example
673
+ * ```jsx
674
+ * <ColorPalette columns={5} />
675
+ * ```
636
676
  */
637
677
  columns?: number;
638
678
  /**
639
679
  * Specifies the size of a color cell in px.
640
680
  * Defaults to `24`.
681
+ *
682
+ * @example
683
+ * ```jsx
684
+ * <ColorPalette tileSize={30} />
685
+ * ```
641
686
  */
642
687
  tileSize?: number | TileSize;
643
688
  /**
@@ -973,10 +1018,20 @@ export declare interface ColorPickerProps {
973
1018
  /**
974
1019
  * The default value of the ColorPicker
975
1020
  * ([see example]({% slug default_value_colorpicker %})).
1021
+ *
1022
+ * @example
1023
+ * ```jsx
1024
+ * <ColorPicker defaultValue="#ff0000" />
1025
+ * ```
976
1026
  */
977
1027
  defaultValue?: string;
978
1028
  /**
979
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
+ * ```
980
1035
  */
981
1036
  value?: string;
982
1037
  /**
@@ -989,6 +1044,11 @@ export declare interface ColorPickerProps {
989
1044
  /**
990
1045
  * Sets the disabled state of the ColorPicker
991
1046
  * ([see example]({% slug disabled_colorpicker %})).
1047
+ *
1048
+ * @example
1049
+ * ```jsx
1050
+ * <ColorPicker disabled={true} />
1051
+ * ```
992
1052
  */
993
1053
  disabled?: boolean;
994
1054
  /**
@@ -1101,9 +1161,14 @@ export declare interface ColorPickerProps {
1101
1161
  * - `small`
1102
1162
  * - `medium`
1103
1163
  * - `large`
1104
- * - `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`.
1105
1165
  *
1106
1166
  * @default `medium`
1167
+ *
1168
+ * @example
1169
+ * ```jsx
1170
+ * <ColorPicker size="large" />
1171
+ * ```
1107
1172
  */
1108
1173
  size?: null | 'small' | 'medium' | 'large';
1109
1174
  /**
@@ -1744,14 +1809,29 @@ export declare interface MaskedTextBoxHandle extends Pick<MaskedTextBoxWithoutCo
1744
1809
  export declare interface MaskedTextBoxProps extends FormComponentProps {
1745
1810
  /**
1746
1811
  * Sets a class of the MaskedTextBox DOM element.
1812
+ *
1813
+ * @example
1814
+ * ```jsx
1815
+ * <MaskedTextBox className="custom-class" />
1816
+ * ```
1747
1817
  */
1748
1818
  className?: string;
1749
1819
  /**
1750
1820
  * Sets additional CSS styles to the MaskedTextBox DOM element.
1821
+ *
1822
+ * @example
1823
+ * ```jsx
1824
+ * <MaskedTextBox style={{ color: 'red' }} />
1825
+ * ```
1751
1826
  */
1752
1827
  style?: React.CSSProperties;
1753
1828
  /**
1754
1829
  * Specifies the value of the MaskedTextBox.
1830
+ *
1831
+ * @example
1832
+ * ```jsx
1833
+ * <MaskedTextBox value="123-45-6789" />
1834
+ * ```
1755
1835
  */
1756
1836
  value?: string;
1757
1837
  /**
@@ -1760,6 +1840,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1760
1840
  defaultValue?: string;
1761
1841
  /**
1762
1842
  * Specifies the input placeholder.
1843
+ *
1844
+ * @example
1845
+ * ```jsx
1846
+ * <MaskedTextBox placeholder="Enter text here" />
1847
+ * ```
1763
1848
  */
1764
1849
  placeholder?: string;
1765
1850
  /**
@@ -1768,6 +1853,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1768
1853
  title?: string;
1769
1854
  /**
1770
1855
  * Represents the `dir` HTML attribute.
1856
+ *
1857
+ * @example
1858
+ * ```jsx
1859
+ * <MaskedTextBox dir="rtl" />
1860
+ * ```
1771
1861
  */
1772
1862
  dir?: string;
1773
1863
  /**
@@ -1780,10 +1870,20 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1780
1870
  accessKey?: string;
1781
1871
  /**
1782
1872
  * Specifies the width of the MaskedTextBox.
1873
+ *
1874
+ * @example
1875
+ * ```jsx
1876
+ * <MaskedTextBox width="200px" />
1877
+ * ```
1783
1878
  */
1784
1879
  width?: number | string;
1785
1880
  /**
1786
1881
  * Determines whether the MaskedTextBox is disabled.
1882
+ *
1883
+ * @example
1884
+ * ```jsx
1885
+ * <MaskedTextBox disabled={true} />
1886
+ * ```
1787
1887
  */
1788
1888
  disabled?: boolean;
1789
1889
  /**
@@ -1833,6 +1933,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1833
1933
  maskValidation?: boolean;
1834
1934
  /**
1835
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
+ * ```
1836
1941
  */
1837
1942
  mask?: string;
1838
1943
  /**
@@ -1850,6 +1955,11 @@ export declare interface MaskedTextBoxProps extends FormComponentProps {
1850
1955
  };
1851
1956
  /**
1852
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
+ * ```
1853
1963
  */
1854
1964
  onChange?: (event: MaskedTextBoxChangeEvent) => void;
1855
1965
  /**
@@ -2628,71 +2738,151 @@ export declare interface RadioGroupProps {
2628
2738
  /**
2629
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).
2630
2740
  * For example these elements could contain error or hint message.
2741
+ *
2742
+ * @example
2743
+ * ```jsx
2744
+ * <RadioGroup ariaDescribedBy="error-message" />
2745
+ * ```
2631
2746
  */
2632
2747
  ariaDescribedBy?: string;
2633
2748
  /**
2634
2749
  * Identifies the element(s) which will label the component.
2750
+ *
2751
+ * @example
2752
+ * ```jsx
2753
+ * <RadioGroup ariaLabelledBy="group-label" />
2754
+ * ```
2635
2755
  */
2636
2756
  ariaLabelledBy?: string;
2637
2757
  /**
2638
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
+ * ```
2639
2764
  */
2640
2765
  className?: string;
2641
2766
  /**
2642
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
+ * ```
2643
2773
  */
2644
2774
  id?: string;
2645
2775
  /**
2646
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
+ * ```
2647
2782
  */
2648
2783
  data?: Array<RadioButtonProps>;
2649
2784
  /**
2650
2785
  * Sets the default checked state of a radio button when used in uncontrolled mode ([see example]({% slug overview_radiobutton %})).
2651
2786
  * The `checked` property is passed to the underlying `input` element.
2787
+ *
2788
+ * @example
2789
+ * ```jsx
2790
+ * <RadioGroup defaultValue={1} />
2791
+ * ```
2652
2792
  */
2653
2793
  defaultValue?: any;
2654
2794
  /**
2655
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
+ * ```
2656
2801
  */
2657
2802
  dir?: string;
2658
2803
  /**
2659
2804
  * Disable all radio buttons ([see example]({% slug disabled_radiobutton %})).
2805
+ *
2806
+ * @example
2807
+ * ```jsx
2808
+ * <RadioGroup disabled={true} />
2809
+ * ```
2660
2810
  */
2661
2811
  disabled?: boolean;
2662
2812
  /**
2663
2813
  * Overrides the default component responsible for visualizing a single item.
2664
2814
  *
2665
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
+ * ```
2666
2821
  */
2667
2822
  item?: React.ComponentType<HTMLAttributes<HTMLLIElement>>;
2668
2823
  /**
2669
2824
  * Sets the label position of the radio buttons.
2670
2825
  * Accepts two options: `before` or `after`. Defaults to `after`.
2826
+ *
2827
+ * @example
2828
+ * ```jsx
2829
+ * <RadioGroup labelPlacement="before" />
2830
+ * ```
2671
2831
  */
2672
2832
  labelPlacement?: string;
2673
2833
  /**
2674
2834
  * Specifies the radio group layout.
2835
+ *
2836
+ * @example
2837
+ * ```jsx
2838
+ * <RadioGroup layout="horizontal" />
2839
+ * ```
2675
2840
  */
2676
2841
  layout?: 'horizontal' | 'vertical';
2677
2842
  /**
2678
2843
  * Specifies the `name` property of the `input` DOM elements.
2844
+ *
2845
+ * @example
2846
+ * ```jsx
2847
+ * <RadioGroup name="options" />
2848
+ * ```
2679
2849
  */
2680
2850
  name?: string;
2681
2851
  /**
2682
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
+ * ```
2683
2858
  */
2684
2859
  onChange?: (event: RadioGroupChangeEvent) => void;
2685
2860
  /**
2686
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
+ * ```
2687
2867
  */
2688
2868
  onFocus?: (event: RadioGroupFocusEvent) => void;
2689
2869
  /**
2690
2870
  * Sets additional CSS styles to the radio group.
2871
+ *
2872
+ * @example
2873
+ * ```jsx
2874
+ * <RadioGroup style={{ margin: '10px' }} />
2875
+ * ```
2691
2876
  */
2692
2877
  style?: React.CSSProperties;
2693
2878
  /**
2694
2879
  * Sets the default checked state of a radio button when used in controlled mode ([see example]({% slug controlled_radiogroup %})).
2695
2880
  * The `checked` property is passed to the underlying `input` element.
2881
+ *
2882
+ * @example
2883
+ * ```jsx
2884
+ * <RadioGroup value={1} />
2885
+ * ```
2696
2886
  */
2697
2887
  value?: string | number | null;
2698
2888
  /**
@@ -2700,6 +2890,11 @@ export declare interface RadioGroupProps {
2700
2890
  * If `valid` is set, the `required` property will be ignored.
2701
2891
  *
2702
2892
  * This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
2893
+ *
2894
+ * @example
2895
+ * ```jsx
2896
+ * <RadioGroup valid={false} />
2897
+ * ```
2703
2898
  */
2704
2899
  valid?: boolean;
2705
2900
  }
@@ -3168,115 +3363,258 @@ export declare interface RatingMouseEvent {
3168
3363
  export declare interface RatingProps extends FormComponentProps {
3169
3364
  /**
3170
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
+ * ```
3171
3371
  */
3172
3372
  id?: string;
3173
3373
  /**
3174
- * 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
+ * ```
3175
3380
  */
3176
3381
  className?: string;
3177
3382
  /**
3178
3383
  * Sets the `tabIndex` attribute.
3384
+ *
3385
+ * @example
3386
+ * ```jsx
3387
+ * <Rating tabIndex={0} value={2} />
3388
+ * ```
3179
3389
  */
3180
3390
  tabIndex?: number;
3181
3391
  /**
3182
3392
  * Sets additional CSS styles to the Rating.
3393
+ *
3394
+ * @example
3395
+ * ```jsx
3396
+ * <Rating style={{ margin: '10px' }} value={5} />
3397
+ * ```
3183
3398
  */
3184
3399
  style?: React_2.CSSProperties;
3185
3400
  /**
3186
3401
  * Determines the children nodes.
3402
+ *
3403
+ * @example
3404
+ * ```jsx
3405
+ * <Rating>
3406
+ * <span>Custom Child</span>
3407
+ * </Rating>
3408
+ * ```
3187
3409
  */
3188
3410
  children?: React_2.ReactNode;
3189
3411
  /**
3190
3412
  * Represents the rendered Rating item.
3413
+ *
3414
+ * @example
3415
+ * ```jsx
3416
+ * <Rating item={(props) => <div>{props.value}</div>} />
3417
+ * ```
3191
3418
  */
3192
3419
  item?: React_2.ComponentType<RatingItemProps>;
3193
3420
  /**
3194
- * 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
+ * ```
3195
3427
  */
3196
3428
  value?: number;
3197
3429
  /**
3198
- * 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
+ * ```
3199
3436
  */
3200
3437
  defaultValue?: number;
3201
3438
  /**
3202
- * 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
+ * ```
3203
3445
  */
3204
3446
  min?: number;
3205
3447
  /**
3206
- * 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
+ * ```
3207
3454
  */
3208
3455
  max?: number;
3209
3456
  /**
3210
- * 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
+ * ```
3211
3463
  */
3212
3464
  step?: number;
3213
3465
  /**
3214
- * 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
+ * ```
3215
3472
  */
3216
3473
  dir?: string;
3217
3474
  /**
3218
- * 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
+ * ```
3219
3481
  */
3220
3482
  label?: string;
3221
3483
  /**
3222
- * 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
+ * ```
3223
3490
  */
3224
3491
  readonly?: boolean;
3225
3492
  /**
3226
- * 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
+ * ```
3227
3499
  */
3228
3500
  disabled?: boolean;
3229
3501
  /**
3230
- * 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
+ * ```
3231
3508
  */
3232
3509
  icon?: string;
3233
3510
  /**
3234
- * 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
+ * ```
3235
3519
  */
3236
3520
  svgIcon?: SVGIcon;
3237
3521
  /**
3238
- * 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
+ * ```
3239
3528
  */
3240
3529
  svgIconOutline?: SVGIcon;
3241
3530
  /**
3242
- * 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
+ * ```
3243
3537
  */
3244
3538
  selection?: 'continues' | 'single';
3245
3539
  /**
3246
- * 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
+ * ```
3247
3546
  */
3248
3547
  precision?: 'half' | 'item';
3249
3548
  /**
3250
- * 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
+ * ```
3251
3555
  */
3252
3556
  half?: boolean;
3253
3557
  /**
3254
- * 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
+ * ```
3255
3564
  */
3256
3565
  onChange?: (event: RatingChangeEvent) => void;
3257
3566
  /**
3258
- * 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
+ * ```
3259
3573
  */
3260
3574
  onClick?: (event: RatingItemMouseEvent) => void;
3261
3575
  /**
3262
- * 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
+ * ```
3263
3582
  */
3264
3583
  onKeyDown?: (event: RatingKeyboardEvent) => void;
3265
3584
  /**
3266
- * 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
+ * ```
3267
3591
  */
3268
3592
  onFocus?: (event: RatingItemFocusEvent) => void;
3269
3593
  /**
3270
- * 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
+ * ```
3271
3600
  */
3272
3601
  onBlur?: (event: RatingItemFocusEvent) => void;
3273
3602
  /**
3274
- * 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).
3275
- * 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
+ * ```
3276
3609
  */
3277
3610
  ariaDescribedBy?: string;
3278
3611
  /**
3279
3612
  * Identifies the element(s) which will label the component.
3613
+ *
3614
+ * @example
3615
+ * ```jsx
3616
+ * <Rating ariaLabelledBy="label-id" />
3617
+ * ```
3280
3618
  */
3281
3619
  ariaLabelledBy?: string;
3282
3620
  }
@@ -3395,132 +3733,201 @@ export declare interface SignatureOpenEvent extends BaseEvent<SignatureHandle> {
3395
3733
  */
3396
3734
  export declare interface SignatureProps extends FormComponentProps {
3397
3735
  /**
3398
- * 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
+ * ```
3399
3742
  */
3400
3743
  className?: string;
3401
3744
  /**
3402
- * Specifies the value of the Signature.
3745
+ * Specifies the value of the Signature as a Data URL.
3403
3746
  *
3404
- * 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
+ * ```
3405
3751
  */
3406
3752
  value?: string;
3407
3753
  /**
3408
3754
  * Specifies the width of the Signature in pixels.
3755
+ *
3756
+ * @example
3757
+ * ```jsx
3758
+ * <Signature width={500} />
3759
+ * ```
3409
3760
  */
3410
3761
  width?: number;
3411
3762
  /**
3412
3763
  * Specifies the height of the Signature in pixels.
3764
+ *
3765
+ * @example
3766
+ * ```jsx
3767
+ * <Signature height={300} />
3768
+ * ```
3413
3769
  */
3414
3770
  height?: number;
3415
3771
  /**
3416
- * Sets the `tabIndex` property of the Signature.
3772
+ * Specifies the `tabIndex` of the Signature.
3773
+ *
3774
+ * @example
3775
+ * ```jsx
3776
+ * <Signature tabIndex={0} />
3777
+ * ```
3417
3778
  */
3418
3779
  tabIndex?: number;
3419
3780
  /**
3420
- * 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
+ * ```
3421
3787
  */
3422
3788
  id?: string;
3423
3789
  /**
3424
3790
  * Represents the `dir` HTML attribute.
3791
+ *
3792
+ * @example
3793
+ * ```jsx
3794
+ * <Signature dir="rtl" />
3795
+ * ```
3425
3796
  */
3426
3797
  dir?: string;
3427
3798
  /**
3428
3799
  * Specifies the name of the Signature input.
3800
+ *
3801
+ * @example
3802
+ * ```jsx
3803
+ * <Signature name="signature" />
3804
+ * ```
3429
3805
  */
3430
3806
  name?: string;
3431
3807
  /**
3432
- * 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).
3433
- * 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
+ * ```
3434
3814
  */
3435
3815
  ariaDescribedBy?: string;
3436
3816
  /**
3437
3817
  * Identifies the element(s) which will label the component.
3818
+ *
3819
+ * @example
3820
+ * ```jsx
3821
+ * <Signature ariaLabelledBy="label-id" />
3822
+ * ```
3438
3823
  */
3439
3824
  ariaLabelledBy?: string;
3440
3825
  /**
3441
- * 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
+ * ```
3442
3832
  */
3443
3833
  ariaLabel?: string;
3444
3834
  /**
3445
- * 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
+ * ```
3446
3841
  */
3447
3842
  readOnly?: boolean;
3448
3843
  /**
3449
- * 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
+ * ```
3450
3850
  */
3451
3851
  disabled?: boolean;
3452
3852
  /**
3453
- * Configures the `size` of the Signature.
3853
+ * Configures the size of the Signature.
3454
3854
  *
3455
- * The available options are:
3456
- * - small
3457
- * - medium
3458
- * - large
3459
- * - null&mdash;Does not set a size `className`.
3460
- *
3461
- * @default `medium`
3855
+ * @example
3856
+ * ```jsx
3857
+ * <Signature size="large" />
3858
+ * ```
3462
3859
  */
3463
3860
  size?: null | 'small' | 'medium' | 'large';
3464
3861
  /**
3465
- * Configures the `roundness` of the Signature.
3862
+ * Configures the roundness of the Signature.
3466
3863
  *
3467
- * The available options are:
3468
- * - small
3469
- * - medium
3470
- * - large
3471
- * - null&mdash;Does not set a rounded `className`.
3472
- *
3473
- * @default `medium`
3864
+ * @example
3865
+ * ```jsx
3866
+ * <Signature rounded="medium" />
3867
+ * ```
3474
3868
  */
3475
3869
  rounded?: null | 'small' | 'medium' | 'large';
3476
3870
  /**
3477
- * Configures the `fillMode` of the Signature.
3871
+ * Configures the fill mode of the Signature.
3478
3872
  *
3479
- * The available options are:
3480
- * - solid
3481
- * - outline
3482
- * - flat
3483
- * - null&mdash;Does not set a fillMode `className`.
3484
- *
3485
- * @default `solid`
3873
+ * @example
3874
+ * ```jsx
3875
+ * <Signature fillMode="solid" />
3876
+ * ```
3486
3877
  */
3487
3878
  fillMode?: null | 'solid' | 'flat' | 'outline';
3488
3879
  /**
3489
- * The stroke color of the signature.
3490
- *
3491
- * Accepts CSS color names and hex values.
3880
+ * Specifies the stroke color of the Signature.
3492
3881
  *
3493
- * The default value is determined by the theme `$kendo-input-text` variable.
3882
+ * @example
3883
+ * ```jsx
3884
+ * <Signature color="blue" />
3885
+ * ```
3494
3886
  */
3495
3887
  color?: string;
3496
3888
  /**
3497
- * The background color of the signature.
3889
+ * Specifies the background color of the Signature.
3498
3890
  *
3499
- * Accepts CSS color names and hex values.
3500
- *
3501
- * The default value is determined by the theme `$kendo-input-bg` variable.
3891
+ * @example
3892
+ * ```jsx
3893
+ * <Signature backgroundColor="lightgray" />
3894
+ * ```
3502
3895
  */
3503
3896
  backgroundColor?: string;
3504
3897
  /**
3505
- * The stroke width of the signature.
3898
+ * Specifies the stroke width of the Signature.
3506
3899
  *
3507
- * @default 1
3900
+ * @example
3901
+ * ```jsx
3902
+ * <Signature strokeWidth={2} />
3903
+ * ```
3508
3904
  */
3509
3905
  strokeWidth?: number;
3510
3906
  /**
3511
- * A flag indicating whether to smooth out signature lines.
3907
+ * Enables smoothing of the signature lines.
3512
3908
  *
3513
- * @default false
3909
+ * @example
3910
+ * ```jsx
3911
+ * <Signature smooth={true} />
3912
+ * ```
3514
3913
  */
3515
3914
  smooth?: boolean;
3516
3915
  /**
3517
- * A flag indicating if the signature can be maximized.
3916
+ * Enables the maximizable feature of the Signature.
3518
3917
  *
3519
- * @default true
3918
+ * @example
3919
+ * ```jsx
3920
+ * <Signature maximizable={true} />
3921
+ * ```
3520
3922
  */
3521
3923
  maximizable?: boolean;
3522
3924
  /**
3523
- * 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
+ * ```
3524
3931
  */
3525
3932
  open?: boolean;
3526
3933
  /**
@@ -3529,6 +3936,10 @@ export declare interface SignatureProps extends FormComponentProps {
3529
3936
  * The Signature width and height will be multiplied by the scale when showing the popup.
3530
3937
  *
3531
3938
  * @default 3
3939
+ * @example
3940
+ * ```jsx
3941
+ * <Signature popupScale={1.5} />
3942
+ * ```
3532
3943
  */
3533
3944
  popupScale?: number;
3534
3945
  /**
@@ -3537,40 +3948,84 @@ export declare interface SignatureProps extends FormComponentProps {
3537
3948
  * The Signature width and height will be multiplied by the scale when converting the signature to an image.
3538
3949
  *
3539
3950
  * @default 2
3951
+ *
3952
+ * @example
3953
+ * ```jsx
3954
+ * <Signature exportScale={2} />
3955
+ * ```
3540
3956
  */
3541
3957
  exportScale?: number;
3542
3958
  /**
3543
- * A flag indicating whether the dotted line should be displayed in the background.
3959
+ * Hides the dotted line in the background.
3544
3960
  *
3545
3961
  * @default false
3962
+ * @example
3963
+ * ```jsx
3964
+ * <Signature hideLine={true} />
3965
+ * ```
3546
3966
  */
3547
3967
  hideLine?: boolean;
3548
3968
  /**
3549
3969
  * Represents the `style` HTML attribute.
3970
+ *
3971
+ * @example
3972
+ * ```jsx
3973
+ * <Signature style={{ border: '1px solid black' }} />
3974
+ * ```
3550
3975
  */
3551
3976
  style?: React.CSSProperties;
3552
3977
  /**
3553
3978
  * Represents the input element `style` HTML attribute.
3979
+ *
3980
+ * @example
3981
+ * ```jsx
3982
+ * <Signature inputStyle={{ padding: '10px' }} />
3983
+ * ```
3554
3984
  */
3555
3985
  inputStyle?: React.CSSProperties;
3556
3986
  /**
3557
- * 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
+ * ```
3558
3993
  */
3559
3994
  onChange?: (event: SignatureChangeEvent) => void;
3560
3995
  /**
3561
- * 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
+ * ```
3562
4002
  */
3563
4003
  onFocus?: (event: SignatureFocusEvent) => void;
3564
4004
  /**
3565
- * 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
+ * ```
3566
4011
  */
3567
4012
  onBlur?: (event: SignatureBlurEvent) => void;
3568
4013
  /**
3569
- * 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
+ * ```
3570
4020
  */
3571
4021
  onOpen?: (event: SignatureOpenEvent) => void;
3572
4022
  /**
3573
- * 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
+ * ```
3574
4029
  */
3575
4030
  onClose?: (event: SignatureCloseEvent) => void;
3576
4031
  /** @hidden */
@@ -3666,88 +4121,166 @@ export declare interface SliderLabelProps {
3666
4121
  export declare interface SliderProps extends FormComponentProps {
3667
4122
  children?: React_2.ReactNode;
3668
4123
  /**
3669
- * 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
+ * ```
3670
4130
  */
3671
4131
  value?: number;
3672
4132
  /**
3673
- * 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
+ * ```
3674
4139
  */
3675
4140
  defaultValue?: number;
3676
4141
  /**
3677
- * 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
+ * ```
3678
4148
  */
3679
4149
  min: number;
3680
4150
  /**
3681
- * 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
+ * ```
3682
4157
  */
3683
4158
  max: number;
3684
4159
  /**
3685
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
+ * ```
3686
4166
  */
3687
4167
  step?: number;
3688
4168
  /**
3689
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
+ * ```
3690
4175
  */
3691
4176
  largeStep?: number;
3692
4177
  /**
3693
- * 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
+ * ```
3694
4184
  */
3695
4185
  onChange?: (event: SliderChangeEvent) => void;
3696
4186
  /**
3697
- * 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
+ * ```
3698
4193
  */
3699
4194
  style?: React_2.CSSProperties;
3700
4195
  /**
3701
- * 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
+ * ```
3702
4202
  */
3703
4203
  className?: string;
3704
4204
  /**
3705
- * 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
+ * ```
3706
4211
  */
3707
4212
  buttons?: boolean;
3708
4213
  /**
3709
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex)
3710
- * of the Slider.
4214
+ * Specifies the `tabIndex` of the Slider.
4215
+ *
4216
+ * @example
4217
+ * ```jsx
4218
+ * <Slider tabIndex={0} min={0} max={100} />
4219
+ * ```
3711
4220
  */
3712
4221
  tabIndex?: number;
3713
4222
  /**
3714
- * Determines whether the Slider is disabled.
4223
+ * When `true`, disables the Slider.
3715
4224
  *
3716
4225
  * @example
3717
4226
  * ```jsx
3718
- * class App extends React.Component {
3719
- * render() {
3720
- * return (
3721
- * <Slider disabled={true} min={0} max={10} defaultValue={5} />
3722
- * );
3723
- * }
3724
- * }
3725
- * ReactDOM.render(<App />, document.querySelector('my-app'));
4227
+ * <Slider disabled={true} min={0} max={100} />
3726
4228
  * ```
3727
4229
  */
3728
4230
  disabled?: boolean;
3729
4231
  /**
3730
- * If `vertical` is set to `true`, the orientation of the Slider changes from horizontal to vertical
3731
- * ([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
+ * ```
3732
4238
  */
3733
4239
  vertical?: boolean;
3734
4240
  /**
3735
- * 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
+ * ```
3736
4247
  */
3737
4248
  id?: string;
3738
4249
  /**
3739
- * 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).
3740
- * 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
+ * ```
3741
4256
  */
3742
4257
  ariaDescribedBy?: string;
3743
4258
  /**
3744
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
+ * ```
3745
4265
  */
3746
4266
  ariaLabelledBy?: string;
3747
4267
  /**
3748
- * 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
+ * ```
3749
4274
  */
3750
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
+ */
3751
4284
  dir?: Direction;
3752
4285
  }
3753
4286
 
@@ -3886,34 +4419,74 @@ export declare interface SwitchHandle extends Pick<SwitchWithoutContext, keyof S
3886
4419
  export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps {
3887
4420
  /**
3888
4421
  * Specifies the `accessKey` of the Switch.
4422
+ *
4423
+ * @example
4424
+ * ```jsx
4425
+ * <Switch accessKey="s" />
4426
+ * ```
3889
4427
  */
3890
4428
  accessKey?: string;
3891
4429
  /**
3892
4430
  * Sets the current value of the Switch ([see example]({% slug controlled_switch %})).
4431
+ *
4432
+ * @example
4433
+ * ```jsx
4434
+ * <Switch checked={true} />
4435
+ * ```
3893
4436
  */
3894
4437
  checked?: boolean;
3895
4438
  /**
3896
- * 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
+ * ```
3897
4445
  */
3898
4446
  className?: string;
3899
4447
  /**
3900
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
+ * ```
3901
4454
  */
3902
4455
  defaultChecked?: boolean;
3903
4456
  /**
3904
- * 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
+ * ```
3905
4463
  */
3906
4464
  defaultValue?: any;
3907
4465
  /**
3908
4466
  * Disables the Switch when set to `true` ([see example]({% slug disabled_switch %})).
4467
+ *
4468
+ * @example
4469
+ * ```jsx
4470
+ * <Switch disabled={true} />
4471
+ * ```
3909
4472
  */
3910
4473
  disabled?: boolean;
3911
4474
  /**
3912
- * 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
+ * ```
3913
4481
  */
3914
4482
  dir?: string;
3915
4483
  /**
3916
- * Sets the `id` of the Switch.
4484
+ * Specifies the `id` of the Switch.
4485
+ *
4486
+ * @example
4487
+ * ```jsx
4488
+ * <Switch id="switch-component" />
4489
+ * ```
3917
4490
  */
3918
4491
  id?: string;
3919
4492
  /**
@@ -3926,6 +4499,10 @@ export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps
3926
4499
  * - null&mdash;Does not set a size `className`.
3927
4500
  *
3928
4501
  * @default `medium`
4502
+ * @example
4503
+ * ```jsx
4504
+ * <Switch size="large" />
4505
+ * ```
3929
4506
  */
3930
4507
  size?: null | 'small' | 'medium' | 'large';
3931
4508
  /**
@@ -3939,10 +4516,14 @@ export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps
3939
4516
  * - null&mdash;Does not set a trackRounded `className`.
3940
4517
  *
3941
4518
  * @default `full`
4519
+ * @example
4520
+ * ```jsx
4521
+ * <Switch trackRounded="medium" />
4522
+ * ```
3942
4523
  */
3943
4524
  trackRounded?: null | 'small' | 'medium' | 'large' | 'full';
3944
4525
  /**
3945
- * Configures the `thumbRounded` of the Switch.
4526
+ * Configures the `thumbRounded` property of the Switch.
3946
4527
  *
3947
4528
  * The available options are:
3948
4529
  * - small
@@ -3951,48 +4532,101 @@ export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps
3951
4532
  * - full
3952
4533
  * - null&mdash;Does not set a thumbRounded `className`.
3953
4534
  *
3954
- * @default `full`
4535
+ * @example
4536
+ * ```jsx
4537
+ * <Switch thumbRounded="full" />
4538
+ * ```
3955
4539
  */
3956
4540
  thumbRounded?: null | 'small' | 'medium' | 'large' | 'full';
3957
4541
  /**
3958
- * 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.
3959
4543
  * For example these elements could contain error or hint message.
4544
+ *
4545
+ * @example
4546
+ * ```jsx
4547
+ * <Switch ariaDescribedBy="description-id" />
4548
+ * ```
3960
4549
  */
3961
4550
  ariaDescribedBy?: string;
3962
4551
  /**
3963
4552
  * Identifies the element(s) which will label the component.
4553
+ *
4554
+ * @example
4555
+ * ```jsx
4556
+ * <Switch ariaLabelledBy="label-id" />
4557
+ * ```
3964
4558
  */
3965
4559
  ariaLabelledBy?: string;
3966
4560
  /**
3967
- * 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
+ * ```
3968
4567
  */
3969
4568
  offLabel?: React_2.ReactNode;
3970
4569
  /**
3971
- * 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
+ * ```
3972
4576
  */
3973
4577
  onBlur?: (event: React_2.FocusEvent<HTMLSpanElement>) => void;
3974
4578
  /**
3975
- * 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
+ * ```
3976
4585
  */
3977
4586
  onChange?: (event: SwitchChangeEvent) => void;
3978
4587
  /**
3979
- * 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
+ * ```
3980
4594
  */
3981
4595
  onFocus?: (event: React_2.FocusEvent<HTMLSpanElement>) => void;
3982
4596
  /**
3983
- * 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
+ * ```
3984
4603
  */
3985
4604
  onLabel?: React_2.ReactNode;
3986
4605
  /**
3987
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
+ * ```
3988
4612
  */
3989
4613
  tabIndex?: number;
3990
4614
  /**
3991
- * 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
+ * ```
3992
4621
  */
3993
4622
  value?: string | number | string[] | boolean | null;
3994
4623
  /**
3995
- * 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
+ * ```
3996
4630
  */
3997
4631
  ariaLabel?: string;
3998
4632
  }