@progress/kendo-react-buttons 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
@@ -11,7 +11,7 @@ import { ButtonsClassStructure } from '@progress/kendo-react-common';
11
11
  import { default as default_2 } from 'prop-types';
12
12
  import { FormComponentProps } from '@progress/kendo-react-common';
13
13
  import { ForwardRefExoticComponent } from 'react';
14
- import { JSX as JSX_2 } from 'react/jsx-runtime';
14
+ import { JSX } from 'react/jsx-runtime';
15
15
  import { KendoMouse } from '@progress/kendo-react-common';
16
16
  import { KendoReactComponentBaseProps } from '@progress/kendo-react-common';
17
17
  import { PopupAnimation } from '@progress/kendo-react-popup';
@@ -23,7 +23,7 @@ import { SVGIcon } from '@progress/kendo-react-common';
23
23
  export declare const Button: React_2.ForwardRefExoticComponent<ButtonProps & React_2.RefAttributes<ButtonHandle | null>>;
24
24
 
25
25
  export declare const ButtonGroup: {
26
- (props: ButtonGroupProps): JSX_2.Element;
26
+ (props: ButtonGroupProps): JSX.Element;
27
27
  propTypes: {
28
28
  children: default_2.Requireable<NonNullable<default_2.ReactElementLike | (default_2.ReactElementLike | null | undefined)[] | null | undefined>>;
29
29
  className: default_2.Requireable<string>;
@@ -72,10 +72,17 @@ declare interface ButtonGroupInterface {
72
72
  export declare interface ButtonGroupProps extends ButtonGroupInterface {
73
73
  /**
74
74
  * Sets the `className` of the ButtonGroup component.
75
+ * Specifies a list of CSS classes that will be added to the ButtonGroup element.
76
+ *
77
+ * @example
78
+ * ```jsx
79
+ * <ButtonGroup className="custom-group" />
80
+ * ```
75
81
  */
76
82
  className?: string;
77
83
  /**
78
84
  * @hidden
85
+ * Provides an option to use unstyled classes for the ButtonGroup component.
79
86
  */
80
87
  unstyled?: ButtonsClassStructure;
81
88
  }
@@ -433,79 +440,174 @@ export declare interface ChipListHandle {
433
440
  export declare interface ChipListProps extends FormComponentProps, KendoMouse<ChipListHandle, HTMLDivElement> {
434
441
  /**
435
442
  * Sets the `id` property of the top div element of the ChipList.
443
+ *
444
+ * @example
445
+ * ```jsx
446
+ * <ChipList id="chiplist1" />
447
+ * ```
436
448
  */
437
449
  id?: string;
438
450
  /**
439
451
  * Sets additional classes to the ChipList.
452
+ *
453
+ * @example
454
+ * ```jsx
455
+ * <ChipList className="custom-chiplist" />
456
+ * ```
440
457
  */
441
458
  className?: string;
442
459
  /**
443
460
  * Sets the `tabIndex` attribute.
461
+ *
462
+ * @example
463
+ * ```jsx
464
+ * <ChipList tabIndex={0} />
465
+ * ```
444
466
  */
445
467
  tabIndex?: number;
446
468
  /**
447
469
  * Sets additional CSS styles to the ChipList.
470
+ *
471
+ * @example
472
+ * ```jsx
473
+ * <ChipList style={{ margin: '10px' }} />
474
+ * ```
448
475
  */
449
476
  style?: React_2.CSSProperties;
450
477
  /**
451
478
  * Represents Chip component.
479
+ *
480
+ * @example
481
+ * ```jsx
482
+ * <ChipList chip={CustomChip} />
483
+ * ```
452
484
  */
453
485
  chip?: React_2.ComponentType<ChipProps>;
454
486
  /**
455
487
  * Represents the data about the child Chips.
488
+ *
489
+ * @example
490
+ * ```jsx
491
+ * <ChipList data={[{ text: 'Chip1' }, { text: 'Chip2' }]} />
492
+ * ```
456
493
  */
457
494
  data?: any;
458
495
  /**
459
496
  * Represents the default data about the child Chips.
497
+ *
498
+ * @example
499
+ * ```jsx
500
+ * <ChipList defaultData={[{ text: 'DefaultChip1' }, { text: 'DefaultChip2' }]} />
501
+ * ```
460
502
  */
461
503
  defaultData?: any[];
462
504
  /**
463
505
  * Triggered after Chip data change.
506
+ *
507
+ * @example
508
+ * ```jsx
509
+ * <ChipList onDataChange={(event) => console.log(event.value)} />
510
+ * ```
464
511
  */
465
512
  onDataChange?: (event: ChipListDataChangeEvent) => void;
466
513
  /**
467
514
  * Represents the selection state of Chip component.
515
+ *
516
+ * @example
517
+ * ```jsx
518
+ * <ChipList value={[{ text: 'SelectedChip' }]} />
519
+ * ```
468
520
  */
469
521
  value?: any | any[];
470
522
  /**
471
523
  * Represents the default value of the selection state of Chip component.
524
+ *
525
+ * @example
526
+ * ```jsx
527
+ * <ChipList defaultValue={[{ text: 'DefaultSelectedChip' }]} />
528
+ * ```
472
529
  */
473
530
  defaultValue?: any | any[];
474
531
  /**
475
532
  * Triggered after value change.
533
+ *
534
+ * @example
535
+ * ```jsx
536
+ * <ChipList onChange={(event) => console.log(event.value)} />
537
+ * ```
476
538
  */
477
539
  onChange?: (event: ChipListChangeEvent) => void;
478
540
  /**
479
541
  * Represents the selection state of Chip component.
542
+ *
543
+ * @example
544
+ * ```jsx
545
+ * <ChipList selection="multiple" />
546
+ * ```
480
547
  */
481
548
  selection?: string;
482
549
  /**
483
550
  * Represents the `text` field of Chip, used for the `label`.
551
+ *
552
+ * @example
553
+ * ```jsx
554
+ * <ChipList textField="name" />
555
+ * ```
484
556
  */
485
557
  textField?: string;
486
558
  /**
487
559
  * Represents the `value` field of Chip, used for setting the Chip `id`.
560
+ *
561
+ * @example
562
+ * ```jsx
563
+ * <ChipList valueField="id" />
564
+ * ```
488
565
  */
489
566
  valueField?: string;
490
567
  /**
491
568
  * Determines of ChipList is disabled.
569
+ *
570
+ * @example
571
+ * ```jsx
572
+ * <ChipList disabled={true} />
573
+ * ```
492
574
  */
493
575
  disabled?: boolean;
494
576
  /**
495
577
  * The ChipList direction 'ltr' as default or 'rtl'.
578
+ *
579
+ * @example
580
+ * ```jsx
581
+ * <ChipList dir="rtl" />
582
+ * ```
496
583
  */
497
584
  dir?: string;
498
585
  /**
499
586
  * 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).
500
587
  * For example these elements could contain error or hint message.
588
+ *
589
+ * @example
590
+ * ```jsx
591
+ * <ChipList ariaDescribedBy="description" />
592
+ * ```
501
593
  */
502
594
  ariaDescribedBy?: string;
503
595
  /**
504
596
  * Identifies the element(s) which will label the component.
597
+ *
598
+ * @example
599
+ * ```jsx
600
+ * <ChipList ariaLabelledBy="label" />
601
+ * ```
505
602
  */
506
603
  ariaLabelledBy?: string;
507
604
  /**
508
605
  * The accessible label of the component.
606
+ *
607
+ * @example
608
+ * ```jsx
609
+ * <ChipList ariaLabel="ChipList" />
610
+ * ```
509
611
  */
510
612
  ariaLabel?: string;
511
613
  /**
@@ -518,6 +620,11 @@ export declare interface ChipListProps extends FormComponentProps, KendoMouse<Ch
518
620
  * - null&mdash;Does not set a size `className`.
519
621
  *
520
622
  * @default `medium`
623
+ *
624
+ * @example
625
+ * ```jsx
626
+ * <ChipList size="large" />
627
+ * ```
521
628
  */
522
629
  size?: null | 'small' | 'medium' | 'large';
523
630
  }
@@ -542,135 +649,306 @@ export declare interface ChipMouseEvent {
542
649
  export declare interface ChipProps {
543
650
  /**
544
651
  * Sets the `id` property of the top div element of the Chip.
652
+ *
653
+ * @example
654
+ * ```jsx
655
+ * <Chip id="chip1" />
656
+ * ```
545
657
  */
546
658
  id?: string;
547
659
  /**
548
660
  * Sets additional classes to the Chip.
661
+ *
662
+ * @example
663
+ * ```jsx
664
+ * <Chip className="custom-chip" />
665
+ * ```
549
666
  */
550
667
  className?: string;
551
668
  /**
552
669
  * The React elements that will be rendered as custom content inside the Chip.
670
+ *
671
+ * @example
672
+ * ```jsx
673
+ * <Chip>Custom Content</Chip>
674
+ * ```
553
675
  */
554
676
  children?: React_2.ReactNode;
555
677
  /**
556
678
  * Sets the `tabIndex` attribute.
679
+ *
680
+ * @example
681
+ * ```jsx
682
+ * <Chip tabIndex={0} />
683
+ * ```
557
684
  */
558
685
  tabIndex?: number;
559
686
  /**
560
687
  * Sets additional CSS styles to the Chip.
688
+ *
689
+ * @example
690
+ * ```jsx
691
+ * <Chip style={{ margin: '10px' }} />
692
+ * ```
561
693
  */
562
694
  style?: React_2.CSSProperties;
563
695
  /**
564
696
  * Sets the label text of the Chip.
697
+ *
698
+ * @example
699
+ * ```jsx
700
+ * <Chip text="Label" />
701
+ * ```
565
702
  */
566
703
  text?: string;
567
704
  /**
568
705
  * Sets the `id` value of the Chip.
706
+ *
707
+ * @example
708
+ * ```jsx
709
+ * <Chip value="chip1" />
710
+ * ```
569
711
  */
570
712
  value?: any;
571
713
  /**
572
714
  * The Chip direction 'ltr' as default or 'rtl'.
715
+ *
716
+ * @example
717
+ * ```jsx
718
+ * <Chip dir="rtl" />
719
+ * ```
573
720
  */
574
721
  dir?: string;
575
722
  /**
576
723
  * Determines if the Chip could be removed.
724
+ *
725
+ * @example
726
+ * ```jsx
727
+ * <Chip removable />
728
+ * ```
577
729
  */
578
730
  removable?: boolean;
579
731
  /**
580
732
  * Determines if the Chip has custom font `removeIcon`.
733
+ *
734
+ * @example
735
+ * ```jsx
736
+ * <Chip removeIcon="k-i-close" />
737
+ * ```
581
738
  */
582
739
  removeIcon?: string;
583
740
  /**
584
741
  * Determines if the Chip has custom SVG `removeIcon`.
742
+ *
743
+ * @example
744
+ * ```jsx
745
+ * import { gearIcon } from '@progress/kendo-svg-icons';
746
+ *
747
+ * <Chip removeSvgIcon={gearIcon} />
748
+ * ```
585
749
  */
586
750
  removeSvgIcon?: SVGIcon;
587
751
  /**
588
752
  * Determines if the Chip is disabled.
753
+ *
754
+ * @example
755
+ * ```jsx
756
+ * <Chip disabled />
757
+ * ```
589
758
  */
590
759
  disabled?: boolean;
591
760
  /**
592
761
  * Determines if the Chip has a font `icon`.
762
+ *
763
+ * @example
764
+ * ```jsx
765
+ * <Chip icon="k-i-user" />
766
+ * ```
593
767
  */
594
768
  icon?: string;
595
769
  /**
596
770
  * Determines if the Chip has an SVG `icon`.
771
+ *
772
+ * @example
773
+ * ```jsx
774
+ * import { gearIcon } from '@progress/kendo-svg-icons';
775
+ *
776
+ * <Chip svgIcon={gearIcon} />
777
+ * ```
597
778
  */
598
779
  svgIcon?: SVGIcon;
599
780
  /**
600
781
  * Determines if the Chip has an avatar.
782
+ *
783
+ * @example
784
+ * ```jsx
785
+ * <Chip avatar={{ image: 'avatar.png', imageAlt: 'Avatar' }} />
786
+ * ```
601
787
  */
602
788
  avatar?: ChipAvatarProps;
603
789
  /**
604
790
  * Determines if the Chip has custom selection font `icon`.
791
+ *
792
+ * @example
793
+ * ```jsx
794
+ * <Chip selectedIcon="k-i-check" />
795
+ * ```
605
796
  */
606
797
  selectedIcon?: string;
607
798
  /**
608
799
  * Determines if the Chip has custom selection SVG `icon`.
800
+ *
801
+ * @example
802
+ * ```jsx
803
+ * import { gearIcon } from '@progress/kendo-svg-icons';
804
+ *
805
+ * <Chip selectedSvgIcon={gearIcon} />
806
+ * ```
609
807
  */
610
808
  selectedSvgIcon?: SVGIcon;
611
809
  /**
612
810
  * Triggered on Chip removing.
811
+ *
812
+ * @example
813
+ * ```jsx
814
+ * <Chip onRemove={(event) => console.log(event)} />
815
+ * ```
613
816
  */
614
817
  onRemove?: (event: ChipRemoveEvent) => void;
615
818
  /**
616
819
  * Triggered on `onClick` event.
820
+ *
821
+ * @example
822
+ * ```jsx
823
+ * <Chip onClick={(event) => console.log(event)} />
824
+ * ```
617
825
  */
618
826
  onClick?: (event: ChipMouseEvent) => void;
619
827
  /**
620
828
  * Triggered on `onMouseDown` event.
829
+ *
830
+ * @example
831
+ * ```jsx
832
+ * <Chip onMouseDown={(event) => console.log(event)} />
833
+ * ```
621
834
  */
622
835
  onMouseDown?: (event: ChipMouseEvent) => void;
623
836
  /**
624
837
  * Triggered on `onMouseUp` event.
838
+ *
839
+ * @example
840
+ * ```jsx
841
+ * <Chip onMouseUp={(event) => console.log(event)} />
842
+ * ```
625
843
  */
626
844
  onMouseUp?: (event: ChipMouseEvent) => void;
627
845
  /**
628
846
  * Triggered on `onDoubleClick` event.
847
+ *
848
+ * @example
849
+ * ```jsx
850
+ * <Chip onDoubleClick={(event) => console.log(event)} />
851
+ * ```
629
852
  */
630
853
  onDoubleClick?: (event: ChipMouseEvent) => void;
631
854
  /**
632
855
  * Triggered on `onMouseEnter` event.
856
+ *
857
+ * @example
858
+ * ```jsx
859
+ * <Chip onMouseEnter={(event) => console.log(event)} />
860
+ * ```
633
861
  */
634
862
  onMouseEnter?: (event: ChipMouseEvent) => void;
635
863
  /**
636
864
  * Triggered on `onMouseLeave` event.
865
+ *
866
+ * @example
867
+ * ```jsx
868
+ * <Chip onMouseLeave={(event) => console.log(event)} />
869
+ * ```
637
870
  */
638
871
  onMouseLeave?: (event: ChipMouseEvent) => void;
639
872
  /**
640
873
  * Triggered on `onMouseMove` event.
874
+ *
875
+ * @example
876
+ * ```jsx
877
+ * <Chip onMouseMove={(event) => console.log(event)} />
878
+ * ```
641
879
  */
642
880
  onMouseMove?: (event: ChipMouseEvent) => void;
643
881
  /**
644
882
  * Triggered on `onMouseOut` event.
883
+ *
884
+ * @example
885
+ * ```jsx
886
+ * <Chip onMouseOut={(event) => console.log(event)} />
887
+ * ```
645
888
  */
646
889
  onMouseOut?: (event: ChipMouseEvent) => void;
647
890
  /**
648
891
  * Triggered on `onMouseOver` event.
892
+ *
893
+ * @example
894
+ * ```jsx
895
+ * <Chip onMouseOver={(event) => console.log(event)} />
896
+ * ```
649
897
  */
650
898
  onMouseOver?: (event: ChipMouseEvent) => void;
651
899
  /**
652
900
  * Triggered on `onKeyDown` event.
901
+ *
902
+ * @example
903
+ * ```jsx
904
+ * <Chip onKeyDown={(event) => console.log(event)} />
905
+ * ```
653
906
  */
654
907
  onKeyDown?: (event: ChipKeyboardEvent) => void;
655
908
  /**
656
909
  * Triggered on `onFocus` event.
910
+ *
911
+ * @example
912
+ * ```jsx
913
+ * <Chip onFocus={(event) => console.log(event)} />
914
+ * ```
657
915
  */
658
916
  onFocus?: (event: ChipFocusEvent) => void;
659
917
  /**
660
918
  * Triggered on `onBlur` event.
919
+ *
920
+ * @example
921
+ * ```jsx
922
+ * <Chip onBlur={(event) => console.log(event)} />
923
+ * ```
661
924
  */
662
925
  onBlur?: (event: ChipFocusEvent) => void;
663
926
  /**
664
927
  * Represents the item data, coming from the `ChipList` component.
928
+ *
929
+ * @example
930
+ * ```jsx
931
+ * <Chip dataItem={{ text: 'Chip1' }} />
932
+ * ```
665
933
  */
666
934
  dataItem?: any;
667
935
  /**
668
936
  * Determines if the Chip is selected.
937
+ *
938
+ * @example
939
+ * ```jsx
940
+ * <Chip selected />
941
+ * ```
669
942
  */
670
943
  selected?: boolean;
671
944
  /**
672
945
  * Identifies the element(s) which will describe the component, similar to an [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
673
946
  * For example, these elements could contain an error or a hint message.
947
+ *
948
+ * @example
949
+ * ```jsx
950
+ * <Chip ariaDescribedBy="description" />
951
+ * ```
674
952
  */
675
953
  ariaDescribedBy?: string;
676
954
  /**
@@ -679,56 +957,73 @@ export declare interface ChipProps {
679
957
  role?: string;
680
958
  /**
681
959
  * Configures the `size` of the Chip.
682
- *
683
960
  * The available options are:
684
- * - small
685
- * - medium
686
- * - large
687
- * - null&mdash;Does not set a size `className`.
961
+ * - `small`
962
+ * - `medium`
963
+ * - `large`
964
+ * - `null` (removes built-in size styles)
688
965
  *
689
966
  * @default `medium`
967
+ * @example
968
+ * ```jsx
969
+ * <Chip size="large" />
970
+ * ```
690
971
  */
691
972
  size?: null | 'small' | 'medium' | 'large';
692
973
  /**
693
974
  * Configures the `roundness` of the Chip.
694
- *
695
975
  * The available options are:
696
- * - small
697
- * - medium
698
- * - large
699
- * - full
700
- * - null&mdash;Does not set a rounded `className`.
976
+ * - `small`
977
+ * - `medium`
978
+ * - `large`
979
+ * - `full`
980
+ * - `null` (removes built-in roundness styles)
701
981
  *
702
982
  * @default `medium`
983
+ * @example
984
+ * ```jsx
985
+ * <Chip rounded="full" />
986
+ * ```
703
987
  */
704
988
  rounded?: null | 'small' | 'medium' | 'large' | 'full';
705
989
  /**
706
990
  * Configures the `fillMode` of the Chip.
707
- *
708
991
  * The available options are:
709
- * - solid
710
- * - outline
711
- * - null&mdash;Does not set a fillMode `className`.
992
+ * - `solid`
993
+ * - `outline`
994
+ * - `null` (removes built-in fill mode styles)
712
995
  *
713
996
  * @default `solid`
997
+ * @example
998
+ * ```jsx
999
+ * <Chip fillMode="outline" />
1000
+ * ```
714
1001
  */
715
1002
  fillMode?: null | 'solid' | 'outline';
716
1003
  /**
717
1004
  * Configures the `themeColor` of the Chip.
718
- *
719
1005
  * The available options are:
720
- * - base
721
- * - info
722
- * - success
723
- * - warning
724
- * - error
725
- * - null&mdash;Does not set a themeColor `className`.
1006
+ * - `base`
1007
+ * - `info`
1008
+ * - `success`
1009
+ * - `warning`
1010
+ * - `error`
1011
+ * - `null` (removes built-in theme color styles)
726
1012
  *
727
1013
  * @default `base`
1014
+ * @example
1015
+ * ```jsx
1016
+ * <Chip themeColor="success" />
1017
+ * ```
728
1018
  */
729
1019
  themeColor?: null | 'base' | 'info' | 'success' | 'warning' | 'error';
730
1020
  /**
731
1021
  * Represents the label of the Chip component.
1022
+ *
1023
+ * @example
1024
+ * ```jsx
1025
+ * <Chip ariaLabel="Chip Label" />
1026
+ * ```
732
1027
  */
733
1028
  ariaLabel?: string;
734
1029
  }
@@ -1098,7 +1393,7 @@ declare class DropDownButtonWithoutContext extends React_2.Component<DropDownBut
1098
1393
  /**
1099
1394
  * @hidden
1100
1395
  */
1101
- render(): JSX_2.Element;
1396
+ render(): JSX.Element;
1102
1397
  /**
1103
1398
  * @hidden
1104
1399
  */
@@ -1261,19 +1556,40 @@ export declare interface FloatingActionButtonItemHandle {
1261
1556
  export declare interface FloatingActionButtonItemProps {
1262
1557
  /**
1263
1558
  * Sets additional CSS styles to the FloatingActionButtonItem.
1559
+ *
1560
+ * @example
1561
+ * ```jsx
1562
+ * <FloatingActionButtonItem style={{ margin: '10px' }} />
1563
+ * ```
1264
1564
  */
1265
1565
  style?: React_2.CSSProperties;
1266
1566
  /**
1267
1567
  * Specifies a list of CSS classes that will be added to the FloatingActionButtonItem.
1568
+ *
1569
+ * @example
1570
+ * ```jsx
1571
+ * <FloatingActionButtonItem className="custom-item" />
1572
+ * ```
1268
1573
  */
1269
1574
  className?: string;
1270
1575
  /**
1271
1576
  * Represents the children that are passed to the FloatingActionButtonItem.
1577
+ *
1578
+ * @example
1579
+ * ```jsx
1580
+ * <FloatingActionButtonItem>Custom Content</FloatingActionButtonItem>
1581
+ * ```
1272
1582
  */
1273
1583
  children?: any;
1274
1584
  /**
1275
1585
  * Specifies if the Floating Action Button Item is disabled [see example]({% slug disabled_floatingactionbuttonitem %}).
1276
1586
  * Defaults to `false`.
1587
+ *
1588
+ * @default false
1589
+ * @example
1590
+ * ```jsx
1591
+ * <FloatingActionButtonItem disabled />
1592
+ * ```
1277
1593
  */
1278
1594
  disabled?: boolean;
1279
1595
  /**
@@ -1371,43 +1687,90 @@ export declare type FloatingActionButtonPositionMode = 'absolute' | 'fixed';
1371
1687
  export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onBlur' | 'onFocus' | 'onKeyDown' | 'onClick'> {
1372
1688
  /**
1373
1689
  * Sets additional CSS styles to the Floating Action Button.
1690
+ *
1691
+ * @example
1692
+ * ```jsx
1693
+ * <FloatingActionButton style={{ backgroundColor: 'blue' }} />
1694
+ * ```
1374
1695
  */
1375
1696
  style?: React.CSSProperties;
1376
1697
  /**
1377
1698
  * Specifies a list of CSS classes that will be added to the Floating Action Button.
1699
+ *
1700
+ * @example
1701
+ * ```jsx
1702
+ * <FloatingActionButton className="custom-fab" />
1703
+ * ```
1378
1704
  */
1379
1705
  className?: string;
1380
1706
  /**
1381
- * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL [see example]({% slug rtl_buttons %}).
1707
+ * Represents the `dir` HTML attribute for text direction.
1708
+ *
1709
+ * @example
1710
+ * ```jsx
1711
+ * <FloatingActionButton dir="rtl" />
1712
+ * ```
1382
1713
  */
1383
1714
  dir?: string;
1384
1715
  /**
1385
1716
  * Sets the `id` property of the root HTML element.
1717
+ *
1718
+ * @example
1719
+ * ```jsx
1720
+ * <FloatingActionButton id="fab1" />
1721
+ * ```
1386
1722
  */
1387
1723
  id?: string;
1388
1724
  /**
1389
- * Specifies if the Floating Action Button is disabled [see example]({% slug disabled_floatingactionbutton %}). Defaults to `false`.
1725
+ * Disables the Floating Action Button.
1726
+ *
1727
+ * @default false
1728
+ * @example
1729
+ * ```jsx
1730
+ * <FloatingActionButton disabled />
1731
+ * ```
1390
1732
  */
1391
1733
  disabled?: boolean;
1392
1734
  /**
1393
- * Defines the icon rendered in the Floating Action Button [see example]({% slug contenttypes_floatingactionbutton %}).
1735
+ * Defines the icon rendered in the Floating Action Button.
1736
+ *
1737
+ * @example
1738
+ * ```jsx
1739
+ * <FloatingActionButton icon="k-icon k-i-plus" />
1740
+ * ```
1394
1741
  */
1395
1742
  icon?: string;
1396
1743
  /**
1397
- * Defines the SVG icon rendered in the Floating Action Button [see example]({% slug contenttypes_floatingactionbutton %}).
1744
+ * Defines the SVG icon rendered in the Floating Action Button.
1745
+ *
1746
+ * @example
1747
+ * ```jsx
1748
+ * import { gearIcon } from '@progress/kendo-svg-icons';
1749
+ *
1750
+ * <FloatingActionButton svgIcon={gearIcon} />
1751
+ * ```
1398
1752
  */
1399
1753
  svgIcon?: SVGIcon;
1400
1754
  /**
1401
- * Defines a CSS class or multiple classes separated by spaces which are applied
1402
- * to a `span` element inside the Floating Action Button. Allows the usage of custom icons.
1755
+ * Defines a custom CSS class for the icon.
1756
+ *
1757
+ * @example
1758
+ * ```jsx
1759
+ * <FloatingActionButton iconClass="custom-icon-class" />
1760
+ * ```
1403
1761
  */
1404
1762
  iconClass?: string;
1405
1763
  /**
1406
- * Specifies the text of the Floating Action Button [see example]({% slug contenttypes_floatingactionbutton %}).
1764
+ * Specifies the text of the Floating Action Button.
1765
+ *
1766
+ * @example
1767
+ * ```jsx
1768
+ * <FloatingActionButton text="Click me" />
1769
+ * ```
1407
1770
  */
1408
1771
  text?: string;
1409
1772
  /**
1410
- * Specifies the horizontal and vertical offset applied to the Floating Action Button
1773
+ * Specifies the horizontal and vertical offset of the Floating Action Button.
1411
1774
  * [see example]({% slug positioning_floatingactionbutton %}).
1412
1775
  *
1413
1776
  * Normally, the floating button is positioned next to the boundaries of its container with a default offset of `16px`.
@@ -1421,10 +1784,14 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
1421
1784
  * * `x`&mdash;Sets the horizontal offset of the Floating Action Button.
1422
1785
  * * `y`&mdash;Sets the vertical offset of the Floating Action Button.
1423
1786
  *
1787
+ * @example
1788
+ * ```jsx
1789
+ * <FloatingActionButton alignOffset={{ horizontal: 10, vertical: 20 }} />
1790
+ * ```
1424
1791
  */
1425
1792
  alignOffset?: FloatingActionButtonAlignOffset;
1426
1793
  /**
1427
- * Specifies the horizontal and vertical alignment of the Floating Action Button in relation to the container
1794
+ * Specifies the alignment of the Floating Action Button within its container.
1428
1795
  * [see example]({% slug positioning_floatingactionbutton %}).
1429
1796
  *
1430
1797
  * > Centering the Floating Action Button in both horizontal and vertical dimension is not a typical use case.
@@ -1441,20 +1808,30 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
1441
1808
  * * `middle`&mdash;Uses the middle point of the container.
1442
1809
  * * `bottom`(Default)&mdash;Uses the bottom point of the container.
1443
1810
  *
1811
+ * @example
1812
+ * ```jsx
1813
+ * <FloatingActionButton align="bottom end" />
1814
+ * ```
1444
1815
  */
1445
1816
  align?: FloatingActionButtonAlign;
1446
1817
  /**
1447
- * Specifies the position mode of the Floating Action Button
1818
+ * Specifies the position mode of the Floating Action Button.
1448
1819
  * [see example]({% slug positioning_floatingactionbutton %}). It is based on the
1449
1820
  * [CSS position](https://developer.mozilla.org/en-US/docs/Web/CSS/position) rule.
1450
1821
  *
1451
1822
  * * The possible values are:
1452
1823
  * * 'fixed' (Default)
1453
1824
  * * 'absolute'
1825
+ *
1826
+ * @default 'fixed'
1827
+ * @example
1828
+ * ```jsx
1829
+ * <FloatingActionButton positionMode="absolute" />
1830
+ * ```
1454
1831
  */
1455
1832
  positionMode?: FloatingActionButtonPositionMode;
1456
1833
  /**
1457
- * Specifies the size of the Floating Action Button
1834
+ * Specifies the size of the Floating Action Button.
1458
1835
  * [see example]({% slug appearance_floatingactionbutton %}).
1459
1836
  *
1460
1837
  * The possible values are:
@@ -1463,10 +1840,15 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
1463
1840
  * * `large`&mdash;Applies one and one half of the default padding, e.g. `24px`.
1464
1841
  * * `null`&mdash;Does not set a size `className`.
1465
1842
  *
1843
+ * @default 'medium'
1844
+ * @example
1845
+ * ```jsx
1846
+ * <FloatingActionButton size="large" />
1847
+ * ```
1466
1848
  */
1467
1849
  size?: FloatingActionButtonSize;
1468
1850
  /**
1469
- * Specifies the rounding of the Floating Action Button.
1851
+ * Configures the rounding of the Floating Action Button.
1470
1852
  *
1471
1853
  * The possible values are:
1472
1854
  * * `small`
@@ -1476,10 +1858,16 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
1476
1858
  * * `null`&mdash;Does not set a rounded `className`.
1477
1859
  *
1478
1860
  * @default `full`
1861
+ *
1862
+ * @default 'full'
1863
+ * @example
1864
+ * ```jsx
1865
+ * <FloatingActionButton rounded="small" />
1866
+ * ```
1479
1867
  */
1480
1868
  rounded?: FloatingActionButtonRounded;
1481
1869
  /**
1482
- * Specifies the theme color of the Floating Action Button
1870
+ * Configures the theme color of the Floating Action Button.
1483
1871
  * [see example]({% slug appearance_floatingactionbutton %}).
1484
1872
  *
1485
1873
  * The possible values are:
@@ -1495,73 +1883,138 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
1495
1883
  * * `inverse`&mdash; Applies coloring based on the inverse theme color.
1496
1884
  * * `null`&mdash;Does not set a theme color `className`.
1497
1885
  *
1886
+ * @default 'primary'
1887
+ * @example
1888
+ * ```jsx
1889
+ * <FloatingActionButton themeColor="secondary" />
1890
+ * ```
1498
1891
  */
1499
1892
  themeColor?: FloatingActionButtonThemeColor;
1500
1893
  /**
1501
- * The collection of items that will be rendered in the Floating Action Button
1502
- * [see example]({% slug databinding_floatingactionbutton %}).
1894
+ * Defines the collection of items rendered in the Floating Action Button.
1895
+ *
1896
+ * @example
1897
+ * ```jsx
1898
+ * <FloatingActionButton items={[{ text: 'Item 1' }, { text: 'Item 2' }]} />
1899
+ * ```
1503
1900
  */
1504
1901
  items?: Array<FloatingActionButtonItemProps>;
1505
1902
  /**
1506
- * Overrides the default component responsible for visualizing a single item
1507
- * [see example]({% slug customization_floatingactionbutton %}#toc-items-rendering).
1903
+ * Overrides the default component responsible for rendering items.
1508
1904
  *
1509
- * The default Component is: [FloatingActionButtonItem]({% slug api_buttons_floatingactionbuttonitem %}).
1905
+ * @example
1906
+ * ```jsx
1907
+ * <FloatingActionButton item={CustomItemComponent} />
1908
+ * ```
1510
1909
  */
1511
1910
  item?: React.ComponentType<FloatingActionButtonItemProps>;
1512
1911
  /**
1513
- * Represents the additional props that will be passed to the Popup inside the Floating Action Button
1514
- * [see example]({% slug customization_floatingactionbutton %}#toc-popup-behavior).
1912
+ * Configures the popup settings for the Floating Action Button.
1913
+ *
1914
+ * @example
1915
+ * ```jsx
1916
+ * <FloatingActionButton popupSettings={{ animate: false }} />
1917
+ * ```
1515
1918
  */
1516
1919
  popupSettings?: FloatingActionButtonPopupSettings;
1517
1920
  /**
1518
- * Specifies the `tabIndex` of the main button.
1921
+ * Sets the `tabIndex` of the main button.
1922
+ *
1923
+ * @example
1924
+ * ```jsx
1925
+ * <FloatingActionButton tabIndex={0} />
1926
+ * ```
1519
1927
  */
1520
1928
  tabIndex?: number;
1521
1929
  /**
1522
- * Specifies the `accessKey` of the main button.
1930
+ * Sets the `accessKey` of the main button.
1931
+ *
1932
+ * @example
1933
+ * ```jsx
1934
+ * <FloatingActionButton accessKey="a" />
1935
+ * ```
1523
1936
  */
1524
1937
  accessKey?: string;
1525
1938
  /**
1526
- * Specifies if the Floating Action Button will be modal by rendering an overlay under the component.
1939
+ * Enables modal behavior by rendering an overlay under the Floating Action Button.
1940
+ *
1941
+ * @example
1942
+ * ```jsx
1943
+ * <FloatingActionButton modal />
1944
+ * ```
1527
1945
  */
1528
1946
  modal?: boolean;
1529
1947
  /**
1530
- * Set styles to the Floating Action Button overlay element rendered when the `modal` prop is enabled.
1948
+ * Sets styles for the overlay element when the `modal` prop is enabled.
1949
+ *
1950
+ * @example
1951
+ * ```jsx
1952
+ * <FloatingActionButton overlayStyle={{ backgroundColor: 'rgba(0, 0, 0, 0.5)' }} />
1953
+ * ```
1531
1954
  */
1532
1955
  overlayStyle?: React.CSSProperties;
1533
1956
  /**
1534
- * Fires when the Floating Action Button is focused
1535
- * [see example]({% slug events_floatingactionbutton %}).
1957
+ * Fires when the Floating Action Button is focused.
1958
+ *
1959
+ * @example
1960
+ * ```jsx
1961
+ * <FloatingActionButton onFocus={(event) => console.log(event)} />
1962
+ * ```
1536
1963
  */
1537
1964
  onFocus?: (event: FloatingActionButtonEvent) => void;
1538
1965
  /**
1539
- * Fires when the Floating Action Button is blurred
1540
- * [see example]({% slug events_floatingactionbutton %}).
1966
+ * Fires when the Floating Action Button is blurred.
1967
+ *
1968
+ * @example
1969
+ * ```jsx
1970
+ * <FloatingActionButton onBlur={(event) => console.log(event)} />
1971
+ * ```
1541
1972
  */
1542
1973
  onBlur?: (event: FloatingActionButtonEvent) => void;
1543
1974
  /**
1544
1975
  * Fires when the Floating Action Button is clicked.
1976
+ *
1977
+ * @example
1978
+ * ```jsx
1979
+ * <FloatingActionButton onClick={(event) => console.log(event)} />
1980
+ * ```
1545
1981
  */
1546
1982
  onClick?: (event: FloatingActionButtonEvent) => void;
1547
1983
  /**
1548
- * Fires when the Floating Action Button Item is clicked
1549
- * [see example]({% slug events_floatingactionbutton %}).
1984
+ * Fires when a Floating Action Button item is clicked.
1985
+ *
1986
+ * @example
1987
+ * ```jsx
1988
+ * <FloatingActionButton onItemClick={(event) => console.log(event)} />
1989
+ * ```
1550
1990
  */
1551
1991
  onItemClick?: (event: FloatingActionButtonItemEvent) => void;
1552
1992
  /**
1553
- * Triggers onKeyDown event
1554
- * [see example]({% slug events_floatingactionbutton %}).
1993
+ * Fires when a key is pressed while the Floating Action Button is focused.
1994
+ *
1995
+ * @example
1996
+ * ```jsx
1997
+ * <FloatingActionButton onKeyDown={(event) => console.log(event)} />
1998
+ * ```
1555
1999
  */
1556
2000
  onKeyDown?: (event: FloatingActionButtonEvent) => void;
1557
2001
  /**
1558
2002
  * Fires when the popup which contains the items is opened
1559
2003
  * [see example]({% slug events_floatingactionbutton %}).
2004
+ *
2005
+ * @example
2006
+ * ```jsx
2007
+ * <FloatingActionButton onOpen={(event) => console.log(event)} />
2008
+ * ```
1560
2009
  */
1561
2010
  onOpen?: (event: FloatingActionButtonEvent) => void;
1562
2011
  /**
1563
- * Fires when the popup which contains the items is closed
1564
- * [see example]({% slug events_floatingactionbutton %}).
2012
+ * Fires when the popup containing the items is closed.
2013
+ *
2014
+ * @example
2015
+ * ```jsx
2016
+ * <FloatingActionButton onClose={(event) => console.log(event)} />
2017
+ * ```
1565
2018
  */
1566
2019
  onClose?: (event: FloatingActionButtonEvent) => void;
1567
2020
  }
@@ -1580,7 +2033,7 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
1580
2033
  export declare type FloatingActionButtonRounded = null | 'small' | 'medium' | 'large' | 'full';
1581
2034
 
1582
2035
  /**
1583
- * Specifies the size of the Floating Action Button.
2036
+ * Specifies the size of the FloatingActionButton.
1584
2037
  *
1585
2038
  * The possible values are:
1586
2039
  * * `small`&mdash;Applies half of the default padding, e.g. `8px`.
@@ -1702,7 +2155,7 @@ export declare class SplitButtonClassComponent extends React_2.Component<SplitBu
1702
2155
  /**
1703
2156
  * @hidden
1704
2157
  */
1705
- render(): JSX_2.Element;
2158
+ render(): JSX.Element;
1706
2159
  /**
1707
2160
  * @hidden
1708
2161
  */
@@ -2047,10 +2500,20 @@ export declare interface ToolbarItemHandle {
2047
2500
  export declare interface ToolbarItemProps extends KendoReactComponentBaseProps {
2048
2501
  /**
2049
2502
  * Sets additional classes to the ToolbarItem component.
2503
+ *
2504
+ * @example
2505
+ * ```jsx
2506
+ * <ToolbarItem className="custom-class" />
2507
+ * ```
2050
2508
  */
2051
2509
  className?: string;
2052
2510
  /**
2053
2511
  * Sets additional styles to the ToolbarItem component.
2512
+ *
2513
+ * @example
2514
+ * ```jsx
2515
+ * <ToolbarItem style={{ margin: '10px' }} />
2516
+ * ```
2054
2517
  */
2055
2518
  style?: React_2.CSSProperties;
2056
2519
  }
@@ -2105,30 +2568,65 @@ export declare interface ToolbarOverflowProps {
2105
2568
  export declare interface ToolbarProps extends KendoReactComponentBaseProps, ToolbarOverflowProps {
2106
2569
  /**
2107
2570
  * Sets additional classes to the Toolbar.
2571
+ *
2572
+ * @example
2573
+ * ```jsx
2574
+ * <Toolbar className="custom-toolbar" />
2575
+ * ```
2108
2576
  */
2109
2577
  className?: string;
2110
2578
  /**
2111
2579
  * Represents the `dir` HTML attribute.
2580
+ *
2581
+ * @example
2582
+ * ```jsx
2583
+ * <Toolbar dir="rtl" />
2584
+ * ```
2112
2585
  */
2113
2586
  dir?: string;
2114
2587
  /**
2115
2588
  * The styles that are applied to the Toolbar.
2589
+ *
2590
+ * @example
2591
+ * ```jsx
2592
+ * <Toolbar style={{ backgroundColor: 'lightblue' }} />
2593
+ * ```
2116
2594
  */
2117
2595
  style?: React_2.CSSProperties;
2118
2596
  /**
2119
2597
  * Represents the `aria-label` HTML attribute of the Toolbar component.
2598
+ *
2599
+ * @example
2600
+ * ```jsx
2601
+ * <Toolbar ariaLabel="Main toolbar" />
2602
+ * ```
2120
2603
  */
2121
2604
  ariaLabel?: string;
2122
2605
  /**
2123
2606
  * Specifies the `tabIndex` of the Toolbar.
2607
+ *
2608
+ * @example
2609
+ * ```jsx
2610
+ * <Toolbar tabIndex={0} />
2611
+ * ```
2124
2612
  */
2125
2613
  tabIndex?: number;
2126
2614
  /**
2127
2615
  * The `resize` event of the Toolbar.
2616
+ *
2617
+ * @example
2618
+ * ```jsx
2619
+ * <Toolbar onResize={(event) => console.log(event)} />
2620
+ * ```
2128
2621
  */
2129
2622
  onResize?: (event: ToolbarResizeEvent) => void;
2130
2623
  /**
2131
2624
  * If set to `false`, it will turn off the built-in keyboard navigation.
2625
+ *
2626
+ * @example
2627
+ * ```jsx
2628
+ * <Toolbar keyboardNavigation={false} />
2629
+ * ```
2132
2630
  */
2133
2631
  keyboardNavigation?: boolean;
2134
2632
  /**
@@ -2146,7 +2644,6 @@ export declare interface ToolbarProps extends KendoReactComponentBaseProps, Tool
2146
2644
  buttons?: string[];
2147
2645
  /**
2148
2646
  * Configures the `size` of the Toolbar.
2149
- *
2150
2647
  * The available options are:
2151
2648
  * - `small`&mdash;Sets the padding of the component to 4px 4px.
2152
2649
  * - `medium`&mdash;Sets the padding of the component to 8px 8px.
@@ -2154,11 +2651,14 @@ export declare interface ToolbarProps extends KendoReactComponentBaseProps, Tool
2154
2651
  * - `null`&mdash;This option removes the the built-in size styles of the Toolbar. Allows for custom `padding`.
2155
2652
  *
2156
2653
  * @default `medium`
2654
+ * @example
2655
+ * ```jsx
2656
+ * <Toolbar size="large" />
2657
+ * ```
2157
2658
  */
2158
2659
  size?: null | 'small' | 'medium' | 'large';
2159
2660
  /**
2160
2661
  * Configures the `fillMode` of the Toolbar.
2161
- *
2162
2662
  * The available options are:
2163
2663
  * - `solid`&mdash;Applies a `background` color and `solid borders`.
2164
2664
  * - `flat`&mdash;Sets a `transparent background` and `solid bottom border`.
@@ -2166,6 +2666,10 @@ export declare interface ToolbarProps extends KendoReactComponentBaseProps, Tool
2166
2666
  * - `null`&mdash;This option removes the built-in fill mode styles of the Toolbar. Allows for custom `background` and `border` styles.
2167
2667
  *
2168
2668
  * @default `solid`
2669
+ * @example
2670
+ * ```jsx
2671
+ * <Toolbar fillMode="flat" />
2672
+ * ```
2169
2673
  */
2170
2674
  fillMode?: null | 'solid' | 'flat' | 'outline';
2171
2675
  /**
@@ -2196,7 +2700,7 @@ export declare interface ToolbarResizeEvent {
2196
2700
  nativeEvent: any;
2197
2701
  }
2198
2702
 
2199
- export declare const ToolbarSeparator: (props: ToolbarSeparatorProps) => JSX_2.Element;
2703
+ export declare const ToolbarSeparator: (props: ToolbarSeparatorProps) => JSX.Element;
2200
2704
 
2201
2705
  /**
2202
2706
  * Represents the KendoReact Toolbar Separator component.