widenarrow-ui 2.1.3 → 2.2.0

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/lib/index.d.ts CHANGED
@@ -66,7 +66,6 @@ declare enum IconTypes {
66
66
  CROSS = "iconCross",
67
67
  CROSS_CIRCLE_200 = "iconCrossCircle200",
68
68
  CROSS_CIRCLE_300 = "iconCrossCircle300",
69
- DOCUMENT = "iconDocument",
70
69
  DASHBOARD_200 = "iconDashboard200",
71
70
  DASHBOARD_300 = "iconDashboard300",
72
71
  DASHBOARD_FILLED = "iconDashboardFilled",
@@ -453,10 +452,12 @@ declare const borderClassNames: ({ borderColor, border, borderTop, borderLeft, b
453
452
 
454
453
  interface BoxProps extends MarginInterface, PaddingInterface, BorderInterface, FlexStylingInterface {
455
454
  children?: react__default.ReactNode;
455
+ id?: string;
456
456
  className?: string;
457
457
  position?: string;
458
458
  backgroundColor?: Partial<ColorTypes>;
459
459
  showOnBreakpoint?: string;
460
+ /** @default false */
460
461
  withBorderRadius?: boolean;
461
462
  width?: string;
462
463
  minWidth?: string;
@@ -473,7 +474,9 @@ declare const Box: react.ForwardRefExoticComponent<BoxProps & react.RefAttribute
473
474
  interface ButtonProps {
474
475
  text?: string;
475
476
  onClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
477
+ /** @default HierarchyTypes.PRIMARY */
476
478
  type?: Partial<HierarchyTypes>;
479
+ /** @default SizeTypes.MEDIUM */
477
480
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
478
481
  sizeMd?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
479
482
  sizeLg?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
@@ -481,17 +484,22 @@ interface ButtonProps {
481
484
  icon?: Partial<IconTypes>;
482
485
  iconColor?: Partial<ColorTypes>;
483
486
  iconSize?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE | SizeTypes.AUTO;
487
+ /** @default false */
484
488
  withIconRight?: boolean;
485
489
  leftIcon?: Partial<IconTypes>;
486
490
  rightIcon?: Partial<IconTypes>;
491
+ /** @default false */
487
492
  disabled?: boolean;
488
493
  className?: string;
489
494
  style?: CSSProperties;
495
+ /** @default false */
490
496
  withEllipsis?: boolean;
491
497
  buttonRef?: RefObject<HTMLButtonElement>;
492
498
  rotateIconByDegree?: 0 | 45 | 90 | 135 | 180 | 225 | 270 | 315;
493
- id?: string | number;
499
+ id?: string;
500
+ /** @default false */
494
501
  loading?: boolean;
502
+ /** @default false */
495
503
  autoFocus?: boolean;
496
504
  ariaLabel?: string;
497
505
  children?: ReactNode;
@@ -504,7 +512,7 @@ declare const Button: react.MemoExoticComponent<({ className, id, style, type, s
504
512
 
505
513
  interface CheckboxProps {
506
514
  label: string;
507
- id?: string | number;
515
+ id?: string;
508
516
  value?: string;
509
517
  name?: string;
510
518
  onChange?: (val: string, event: ChangeEvent<HTMLInputElement> | KeyboardEvent<HTMLInputElement>) => void;
@@ -515,28 +523,40 @@ interface CheckboxProps {
515
523
  ariaLabel?: string;
516
524
  inputRef?: RefObject<HTMLInputElement>;
517
525
  helperText?: string;
526
+ /** @default false */
518
527
  checked?: boolean;
528
+ /** @default false */
519
529
  blocked?: boolean;
530
+ /** @default false */
520
531
  autoFocus?: boolean;
532
+ /** @default false */
521
533
  withEllipsis?: boolean;
534
+ /** @default true */
522
535
  withLabel?: boolean;
536
+ /** @default false */
523
537
  indeterminate?: boolean;
538
+ /** @default false */
524
539
  disabled?: boolean;
540
+ /** @default false */
525
541
  isFake?: boolean;
526
542
  }
527
543
 
528
544
  declare const Checkbox: FC<CheckboxProps>;
529
545
 
530
546
  interface CardProps extends PaddingInterface, MarginInterface, FlexStylingInterface {
547
+ id?: string;
531
548
  onClickCallback?: () => void;
549
+ /** @default AspectRatioTypes.ar16_9 */
532
550
  imageAspectRatio?: Partial<AspectRatioTypes>;
533
551
  imageIcon?: Partial<IconTypes>;
534
552
  imageIconSize?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE | SizeTypes.AUTO | undefined;
553
+ /** @default false */
535
554
  withEllipsis?: boolean;
536
555
  imageSrc?: string;
537
556
  imageAlt?: string;
538
557
  description?: string;
539
558
  wrapperElement?: 'div' | 'li' | 'section' | 'link';
559
+ /** @default false */
540
560
  withHoverEffect?: boolean;
541
561
  className?: string;
542
562
  title?: string;
@@ -549,21 +569,25 @@ interface CardProps extends PaddingInterface, MarginInterface, FlexStylingInterf
549
569
  }
550
570
 
551
571
  declare const Card: {
552
- ({ className, onClickCallback, withHoverEffect, imageSrc, imageAlt, imageIcon, imageIconSize, imageAspectRatio, title, withEllipsis, description, children, topCustomComponent, imageCustomComponent, descriptionComponent, leftFooterComponent, rightFooterComponent, padding, paddingX, paddingY, paddingTop, paddingBottom, paddingRight, paddingLeft, displayFlex, displayFlexCenter, displayFlexCenterSpaceBetween, alignSelf, justifyContent, flexDirection, flexGrow, flexWrap, alignItems }: CardProps): JSX.Element;
572
+ ({ id, className, onClickCallback, withHoverEffect, imageSrc, imageAlt, imageIcon, imageIconSize, imageAspectRatio, title, withEllipsis, description, children, topCustomComponent, imageCustomComponent, descriptionComponent, leftFooterComponent, rightFooterComponent, padding, paddingX, paddingY, paddingTop, paddingBottom, paddingRight, paddingLeft, displayFlex, displayFlexCenter, displayFlexCenterSpaceBetween, alignSelf, justifyContent, flexDirection, flexGrow, flexWrap, alignItems }: CardProps): JSX.Element;
553
573
  displayName: string;
554
574
  };
555
575
 
556
576
  interface RadioButtonProps {
557
577
  className?: string;
558
578
  name?: string;
559
- id?: string | number;
579
+ id?: string;
560
580
  label: string;
581
+ /** @default true */
561
582
  withLabel?: boolean;
562
583
  ariaLabel?: string;
563
584
  value?: string | number;
585
+ /** @default false */
564
586
  disabled?: boolean;
565
587
  helperText?: string;
588
+ /** @default false */
566
589
  withEllipsis?: boolean;
590
+ /** @default false */
567
591
  autoFocus?: boolean;
568
592
  checked: boolean;
569
593
  toolTip?: string;
@@ -579,29 +603,41 @@ declare const RadioButton: {
579
603
  };
580
604
 
581
605
  interface DropDownProps {
606
+ id?: string;
582
607
  children: ReactNode[] | ReactNode;
583
608
  buttonComponent?: ReactNode;
584
609
  triggerComponent?: ReactNode;
610
+ /** @default 'onClickCallback' */
585
611
  buttonCallbackName?: string;
586
612
  footerComponent?: ReactNode;
587
613
  title?: string;
588
614
  className?: string;
589
615
  dropDownClassName?: string;
590
616
  childrenClassName?: string;
617
+ /** @default true */
591
618
  withArrow?: boolean;
619
+ /** @default false */
592
620
  loading?: boolean;
621
+ /** @default true */
593
622
  childrenIsList?: boolean;
623
+ /** @default true */
594
624
  closeOnEscape?: boolean;
595
625
  isOpen?: boolean;
626
+ /** @default false */
596
627
  withVisibleOverflow?: boolean;
597
628
  rotateIconByDegree?: number;
598
629
  rotateLeftIconByDegree?: number;
599
630
  rotateMiddleIconByDegree?: number;
600
631
  rotateRightIconByDegree?: number;
632
+ /** @default false */
601
633
  withPortal?: boolean;
634
+ /** @default true */
602
635
  withShadow?: boolean;
636
+ /** @default 'auto' */
603
637
  placement?: Placement;
638
+ /** @default 'absolute' */
604
639
  strategy?: PositioningStrategy;
640
+ /** @default { horizontal: 8, vertical: 12 } */
605
641
  offset?: {
606
642
  horizontal: number;
607
643
  vertical: number;
@@ -616,14 +652,60 @@ interface DropDownRef {
616
652
 
617
653
  declare const DropDown: react.ForwardRefExoticComponent<DropDownProps & react.RefAttributes<DropDownRef>>;
618
654
 
655
+ type TypographyFontWeight = '300' | '400' | '600' | '700';
656
+ type TypographyFontSize = 'xxs' | 'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl' | 'xxxl';
657
+ type TypographyFontStyle = 'italic';
658
+ type TypographyTextAlign = 'left' | 'center' | 'right';
659
+ interface TypographyBaseProps extends ColorStyleInterface, MarginInterface, PaddingInterface {
660
+ id?: string;
661
+ className?: string;
662
+ textAlign?: TypographyTextAlign;
663
+ fontWeight?: TypographyFontWeight;
664
+ fontSize?: TypographyFontSize;
665
+ fontStyle?: TypographyFontStyle;
666
+ /** @default false */
667
+ meta?: boolean;
668
+ /** @default false */
669
+ withBorderBottom?: boolean;
670
+ /** @default false */
671
+ withEllipsis?: boolean;
672
+ /** @default false */
673
+ withNoWordBreak?: boolean;
674
+ /** @default false */
675
+ withWordBreak?: boolean;
676
+ /** @default false */
677
+ disabled?: boolean;
678
+ }
679
+ interface HeadingProps extends TypographyBaseProps {
680
+ children: ReactNode;
681
+ type: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
682
+ style?: CSSProperties;
683
+ }
684
+ interface LabelProps extends TypographyBaseProps {
685
+ children: ReactNode | string;
686
+ htmlFor?: string;
687
+ style?: CSSProperties;
688
+ }
689
+ interface ParagraphProps extends TypographyBaseProps {
690
+ children: ReactNode;
691
+ }
692
+ interface SpanProps extends TypographyBaseProps {
693
+ children: ReactNode;
694
+ }
695
+
619
696
  interface DropDownItemProps {
697
+ id?: string;
620
698
  text?: string;
621
699
  description?: string;
622
700
  onClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
701
+ /** @default SizeTypes.MEDIUM */
623
702
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
624
703
  active?: boolean;
704
+ /** @default false */
625
705
  withEllipsis?: boolean;
706
+ /** @default false */
626
707
  disabled?: boolean;
708
+ /** @default 'li' */
627
709
  wrapperElement?: 'div' | 'li';
628
710
  className?: string;
629
711
  leftIcon?: Partial<IconTypes>;
@@ -633,21 +715,24 @@ interface DropDownItemProps {
633
715
  iconSize?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
634
716
  iconColor?: Partial<ColorTypes>;
635
717
  textColor?: Partial<ColorTypes>;
636
- fontSize?: string;
637
- textAlign?: string;
638
- fontWeight?: string;
718
+ /** @default 'm' */
719
+ fontSize?: TypographyFontSize;
720
+ /** @default 'left' */
721
+ textAlign?: TypographyTextAlign;
722
+ fontWeight?: TypographyFontWeight;
639
723
  iconClassName?: string;
724
+ /** @default true */
640
725
  closeDropDownOnClick?: boolean;
641
726
  descriptionColor?: Partial<ColorTypes>;
642
- descriptionTextAlign?: string;
643
- descriptionFontSize?: string;
644
- descriptionFontWeight?: string;
727
+ descriptionTextAlign?: TypographyTextAlign;
728
+ descriptionFontSize?: TypographyFontSize;
729
+ descriptionFontWeight?: TypographyFontWeight;
645
730
  descriptionClassName?: string;
646
731
  descriptionContainerClassName?: string;
647
732
  }
648
733
 
649
734
  declare const DropDownItem: {
650
- ({ text, description, onClickCallback, size, textAlign, fontSize, fontWeight, descriptionClassName, descriptionContainerClassName, textColor, active, disabled, className, iconColor, leftIcon, rightIcon, rightComponent, children, iconSize, withEllipsis, iconClassName, wrapperElement, closeDropDownOnClick }: DropDownItemProps): JSX.Element;
735
+ ({ id, text, description, onClickCallback, size, textAlign, fontSize, fontWeight, descriptionClassName, descriptionContainerClassName, textColor, active, disabled, className, iconColor, leftIcon, rightIcon, rightComponent, children, iconSize, withEllipsis, iconClassName, wrapperElement, closeDropDownOnClick }: DropDownItemProps): JSX.Element;
651
736
  defaultProps: {
652
737
  closeDropDownOnClick: boolean;
653
738
  };
@@ -657,11 +742,14 @@ declare const DropDownItem: {
657
742
  interface FacetButtonProps {
658
743
  text?: string;
659
744
  component?: ReactNode;
660
- id?: string | number;
745
+ id?: string;
661
746
  onClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
662
747
  onRightClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
748
+ /** @default false */
663
749
  disabled?: boolean;
750
+ /** @default false */
664
751
  selected?: boolean;
752
+ /** @default false */
665
753
  blocked?: boolean;
666
754
  icon?: Partial<IconTypes>;
667
755
  rightIcon?: Partial<IconTypes>;
@@ -690,13 +778,20 @@ interface SearchResultInterface {
690
778
  }
691
779
 
692
780
  interface PaginationProps {
781
+ id?: string;
693
782
  pagination: SearchResultInterface;
694
783
  onChange: (searchResult: SearchResultInterface) => void;
784
+ /** @default false */
695
785
  slim?: boolean;
786
+ /** @default false */
696
787
  withPageSizeChange?: boolean;
788
+ /** @default false */
697
789
  withTablePagination?: boolean;
790
+ /** @default false */
698
791
  withFastForwardButtons?: boolean;
792
+ /** @default [10, 20, 30, 40, 50, 80, 100] */
699
793
  pageSizeOptions?: Array<number>;
794
+ /** @default HierarchyTypes.SECONDARY */
700
795
  buttonType?: HierarchyTypes.PRIMARY | HierarchyTypes.SECONDARY;
701
796
  className?: string;
702
797
  nextPageTitle?: string;
@@ -718,17 +813,20 @@ interface Block {
718
813
  col: number;
719
814
  }
720
815
  interface FormSkeletonProps {
816
+ id?: string;
721
817
  className?: string;
722
818
  blocks: Array<Block>;
819
+ /** @default ColorTypes.GREY_2 */
723
820
  color?: Partial<ColorTypes>;
724
821
  }
725
822
 
726
823
  declare const FormSkeleton: {
727
- ({ className, blocks, color }: FormSkeletonProps): JSX.Element;
824
+ ({ id, className, blocks, color }: FormSkeletonProps): JSX.Element;
728
825
  displayName: string;
729
826
  };
730
827
 
731
828
  interface GridProps extends MarginInterface, PaddingInterface, FlexStylingInterface {
829
+ id?: string;
732
830
  /**
733
831
  * Number of columns on viewports < 576px
734
832
  */
@@ -753,12 +851,9 @@ interface GridProps extends MarginInterface, PaddingInterface, FlexStylingInterf
753
851
  * Number of columns on viewports < 2000px
754
852
  */
755
853
  xxl?: number;
756
- /**
757
- * Optionally provide the number of columns in the grid.
758
- * @default 12
759
- */
760
854
  /**
761
855
  * If the component is a grid container
856
+ * @default false
762
857
  */
763
858
  container?: boolean;
764
859
  /**
@@ -769,6 +864,10 @@ interface GridProps extends MarginInterface, PaddingInterface, FlexStylingInterf
769
864
  * @default '4'
770
865
  */
771
866
  spacing?: string | Array<string> | Record<never, string | string[]>;
867
+ /**
868
+ * Optionally provide the number of columns in the grid.
869
+ * @default 12
870
+ */
772
871
  columns?: number;
773
872
  className?: string;
774
873
  children?: ReactNode;
@@ -778,9 +877,18 @@ interface GridProps extends MarginInterface, PaddingInterface, FlexStylingInterf
778
877
  declare const Grid: FC<GridProps>;
779
878
 
780
879
  interface IconProps extends ColorStyleInterface, IconStyleInterface {
880
+ /** @default SizeTypes.MEDIUM */
781
881
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE | SizeTypes.AUTO | undefined;
882
+ /**
883
+ * Set to true to rotate the icon 180 deg
884
+ * @default false
885
+ */
782
886
  rotateIcon?: boolean | undefined;
783
887
  rotateIconByDegree?: 0 | 45 | 90 | 135 | 180 | 225 | 270 | 315 | undefined;
888
+ /**
889
+ * Set to true to set disabled state ($disabled color)
890
+ * @default false
891
+ */
784
892
  disabled?: boolean | undefined;
785
893
  className?: string | undefined;
786
894
  toolTip?: string | undefined;
@@ -794,19 +902,24 @@ declare const Icon: {
794
902
  interface IconButtonProps extends IconStyleInterface {
795
903
  className?: string;
796
904
  text?: string;
905
+ /** @default false */
797
906
  rotateIcon?: boolean;
798
- id?: string | number;
907
+ id?: string;
799
908
  rotateIconByDegree?: 0 | 45 | 90 | 135 | 180 | 225 | 270 | 315;
800
909
  iconClassName?: string;
910
+ /** @default HierarchyTypes.SECONDARY */
801
911
  type?: HierarchyTypes.PRIMARY | HierarchyTypes.SECONDARY | HierarchyTypes.TERTIARY;
802
912
  onClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
803
913
  style?: CSSProperties;
804
914
  iconSize?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
915
+ /** @default SizeTypes.MEDIUM */
805
916
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
806
917
  iconColor?: Partial<ColorTypes>;
807
918
  href?: string;
919
+ /** @default false */
808
920
  disabled?: boolean;
809
921
  buttonRef?: RefObject<HTMLButtonElement>;
922
+ /** @default false */
810
923
  autoFocus?: boolean;
811
924
  tabIndex?: number;
812
925
  toolTip?: string;
@@ -827,26 +940,36 @@ interface IconInterface$1 {
827
940
  }
828
941
  interface InputProps {
829
942
  value: string | number;
943
+ /** @default 'off' */
830
944
  autoComplete?: string;
945
+ /** @default false */
831
946
  autoFocus?: boolean;
832
947
  className?: string;
833
948
  name?: string;
949
+ /** @default false */
834
950
  disabled?: boolean;
951
+ /** @default false */
835
952
  readOnly?: boolean;
836
953
  error?: string;
837
- id?: string | number;
954
+ id?: string;
838
955
  iconClassName?: string;
839
956
  inputClassName?: string;
840
957
  label?: string;
841
958
  ariaLabel?: string;
959
+ /** @default false */
842
960
  required?: boolean;
961
+ /** @default true */
843
962
  withLabel?: boolean;
963
+ /** @default false */
844
964
  marginBottom?: boolean;
965
+ /** @default '' */
845
966
  placeholder?: string;
846
967
  inputRef?: RefObject<HTMLInputElement>;
968
+ /** @default SizeTypes.MEDIUM */
847
969
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
848
970
  helperText?: string;
849
971
  characterLimit?: number;
972
+ /** @default 'text' */
850
973
  type?: 'text' | 'number' | 'password' | 'time' | 'email';
851
974
  iconRight?: IconInterface$1;
852
975
  iconLeft?: IconInterface$1;
@@ -863,6 +986,7 @@ declare const Input: {
863
986
  };
864
987
 
865
988
  interface ImageProps {
989
+ id?: string;
866
990
  src: string;
867
991
  alt?: string;
868
992
  className?: string;
@@ -870,6 +994,7 @@ interface ImageProps {
870
994
  customCellComponent?: ReactNode;
871
995
  aspectRatio?: Partial<AspectRatioTypes>;
872
996
  hoverOverlayColor?: Partial<ColorTypes>;
997
+ /** @default false */
873
998
  bgImage?: boolean;
874
999
  bgImageProps?: {
875
1000
  size: 'cover' | 'contain';
@@ -877,17 +1002,19 @@ interface ImageProps {
877
1002
  };
878
1003
  placeHolderColor?: string;
879
1004
  customComponent?: ReactNode;
1005
+ /** @default false */
880
1006
  withContainer?: boolean;
881
1007
  }
882
1008
 
883
1009
  declare const Image: {
884
- ({ src, alt, className, imageClassName, withContainer, placeHolderColor, hoverOverlayColor, bgImage, bgImageProps, aspectRatio, customComponent }: ImageProps): JSX.Element;
1010
+ ({ id, src, alt, className, imageClassName, withContainer, placeHolderColor, hoverOverlayColor, bgImage, bgImageProps, aspectRatio, customComponent }: ImageProps): JSX.Element;
885
1011
  displayName: string;
886
1012
  };
887
1013
 
888
1014
  interface InlineButtonProps {
889
1015
  text: string;
890
- id?: string | number;
1016
+ id?: string;
1017
+ /** @default false */
891
1018
  loading?: boolean;
892
1019
  ariaLabel?: string;
893
1020
  onClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
@@ -895,25 +1022,36 @@ interface InlineButtonProps {
895
1022
  children?: ReactNode;
896
1023
  icon?: Partial<IconTypes>;
897
1024
  iconSize?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1025
+ /** @default false */
898
1026
  rotateIcon?: boolean;
899
1027
  rotateIconByDegree?: 0 | 45 | 90 | 135 | 180 | 225 | 270 | 315;
900
1028
  iconClassName?: string;
1029
+ /** @default false */
901
1030
  withIconRight?: boolean;
1031
+ /** @default HierarchyTypes.PRIMARY */
902
1032
  type?: HierarchyTypes.PRIMARY | HierarchyTypes.SECONDARY | HierarchyTypes.TERTIARY;
1033
+ /** @default SizeTypes.MEDIUM */
903
1034
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM;
904
1035
  sizeMd?: SizeTypes.SMALL | SizeTypes.MEDIUM;
905
1036
  sizeLg?: SizeTypes.SMALL | SizeTypes.MEDIUM;
906
1037
  sizeXl?: SizeTypes.SMALL | SizeTypes.MEDIUM;
907
1038
  textClassName?: string;
1039
+ /** @default false */
908
1040
  withEllipsis?: boolean;
1041
+ /** @default false */
909
1042
  withoutHoverEffect?: boolean;
1043
+ /** @default false */
910
1044
  withPrimaryHoverEffect?: boolean;
1045
+ /** @default false */
911
1046
  withSecondaryHoverEffect?: boolean;
1047
+ /** @default false */
912
1048
  withTertiaryHoverEffect?: boolean;
1049
+ /** @default false */
913
1050
  disabled?: boolean | undefined;
914
1051
  style?: CSSProperties;
915
1052
  buttonRef?: RefObject<HTMLButtonElement>;
916
1053
  tabIndex?: number;
1054
+ /** @default false */
917
1055
  autoFocus?: boolean;
918
1056
  toolTip?: string;
919
1057
  toolTipComponent?: ReactNode;
@@ -938,10 +1076,13 @@ interface TextAreaInputProps {
938
1076
  onBlur?: () => void;
939
1077
  iconRight?: IconInterface;
940
1078
  iconLeft?: IconInterface;
1079
+ /** @default 5 */
941
1080
  rows?: number;
1081
+ /** @default '' */
942
1082
  placeholder?: string;
943
- id?: number | string;
1083
+ id?: string;
944
1084
  label?: string;
1085
+ /** @default true */
945
1086
  withLabel?: boolean;
946
1087
  name?: string;
947
1088
  ariaLabel?: string;
@@ -950,11 +1091,15 @@ interface TextAreaInputProps {
950
1091
  inputClassName?: string;
951
1092
  iconClassName?: string;
952
1093
  className?: string;
1094
+ /** @default false */
953
1095
  disabled?: boolean;
1096
+ /** @default false */
954
1097
  marginBottom?: boolean;
1098
+ /** @default false */
955
1099
  autoFocus?: boolean;
956
1100
  inputRef?: RefObject<HTMLTextAreaElement>;
957
1101
  style?: CSSProperties;
1102
+ /** @default false */
958
1103
  readonly?: boolean;
959
1104
  }
960
1105
 
@@ -964,18 +1109,26 @@ declare const TextAreaInput: {
964
1109
  };
965
1110
 
966
1111
  interface ListItemProps extends MarginInterface, PaddingInterface {
1112
+ id?: string;
967
1113
  buttonsComponent?: ReactNode;
968
1114
  contentComponent?: ReactNode;
969
1115
  className?: string;
970
1116
  imageSrc?: string;
1117
+ /** @default true */
971
1118
  withBorderRadius?: boolean;
1119
+ /** @default false */
972
1120
  withHoverEffect?: boolean;
1121
+ /** @default true */
973
1122
  withEllipsis?: boolean;
974
1123
  imageIcon?: Partial<IconTypes>;
1124
+ /** @default SizeTypes.MEDIUM */
975
1125
  size: Partial<SizeTypes>;
1126
+ /** @default AspectRatioTypes.ar1_1 */
976
1127
  imageAspectRatio?: Partial<AspectRatioTypes>;
977
1128
  borderColor?: Partial<ColorTypes>;
1129
+ /** @default ColorTypes.WHITE */
978
1130
  backgroundColor?: Partial<ColorTypes>;
1131
+ /** @default 'li' */
979
1132
  wrapperElement?: 'div' | 'li' | 'section' | 'link';
980
1133
  border?: '1' | '2' | '3';
981
1134
  borderTop?: '1' | '2' | '3';
@@ -988,34 +1141,45 @@ interface ListItemProps extends MarginInterface, PaddingInterface {
988
1141
  }
989
1142
 
990
1143
  declare const ListItem: {
991
- ({ wrapperElement, backgroundColor, size, padding, imageAspectRatio, withBorderRadius, withEllipsis, withHoverEffect, onClickCallback, linkTo, borderColor, border, title, imageContainerClassName, imageIcon, imageSrc, description, borderTop, borderBottom, marginBottom, paddingX, paddingY, paddingTop, paddingBottom, paddingRight, paddingLeft, className, buttonsComponent, contentComponent }: ListItemProps): JSX.Element;
1144
+ ({ id, wrapperElement, backgroundColor, size, padding, imageAspectRatio, withBorderRadius, withEllipsis, withHoverEffect, onClickCallback, linkTo, borderColor, border, title, imageContainerClassName, imageIcon, imageSrc, description, borderTop, borderBottom, marginBottom, paddingX, paddingY, paddingTop, paddingBottom, paddingRight, paddingLeft, className, buttonsComponent, contentComponent }: ListItemProps): JSX.Element;
992
1145
  displayName: string;
993
1146
  };
994
1147
 
995
1148
  interface ListSkeletonProps extends MarginInterface, PaddingInterface {
1149
+ id?: string;
996
1150
  items: number;
1151
+ /** @default '60px' */
997
1152
  itemHeight?: string;
998
1153
  className?: string;
999
1154
  itemClassName?: string;
1155
+ /** @default false */
1000
1156
  withBorderRadius?: boolean;
1157
+ /** @default false */
1001
1158
  withContent?: boolean;
1159
+ /** @default false */
1002
1160
  withImage?: boolean;
1161
+ /** @default false */
1003
1162
  withImageRadius?: boolean;
1163
+ /** @default false */
1004
1164
  withLoadingAnimation?: boolean;
1165
+ /** @default 2 */
1005
1166
  itemContentRows?: number;
1167
+ /** @default ColorTypes.WHITE */
1006
1168
  backgroundColor?: Partial<ColorTypes>;
1007
1169
  borderColor?: Partial<ColorTypes>;
1170
+ /** @default ColorTypes.GREY_1 */
1008
1171
  imageColor?: Partial<ColorTypes>;
1009
1172
  border?: '1' | '2' | '3';
1010
1173
  borderTop?: '1' | '2' | '3';
1011
1174
  borderBottom?: '1' | '2' | '3';
1012
1175
  borderRight?: '1' | '2' | '3';
1013
1176
  borderLeft?: '1' | '2' | '3';
1177
+ /** @default ColorTypes.GREY_1 */
1014
1178
  contentColor?: Partial<ColorTypes>;
1015
1179
  }
1016
1180
 
1017
1181
  declare const ListSkeleton: {
1018
- ({ items, className, itemClassName, backgroundColor, contentColor, imageColor, withImage, withImageRadius, withLoadingAnimation, itemContentRows, itemHeight, marginBottom, padding, borderColor, border, borderTop, borderLeft, borderBottom, borderRight, withBorderRadius }: ListSkeletonProps): JSX.Element;
1182
+ ({ id, items, className, itemClassName, backgroundColor, contentColor, imageColor, withImage, withImageRadius, withLoadingAnimation, itemContentRows, itemHeight, marginBottom, padding, borderColor, border, borderTop, borderLeft, borderBottom, borderRight, withBorderRadius }: ListSkeletonProps): JSX.Element;
1019
1183
  displayName: string;
1020
1184
  };
1021
1185
 
@@ -1023,7 +1187,9 @@ interface MultiActionButtonProps {
1023
1187
  text?: string;
1024
1188
  onLeftClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
1025
1189
  onRightClickCallback?: (e: MouseEvent<HTMLButtonElement>) => void;
1190
+ /** @default HierarchyTypes.PRIMARY */
1026
1191
  type?: HierarchyTypes.PRIMARY | HierarchyTypes.SECONDARY | HierarchyTypes.TERTIARY | HierarchyTypes.QUATERNARY;
1192
+ /** @default SizeTypes.MEDIUM */
1027
1193
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1028
1194
  sizeMd?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1029
1195
  sizeLg?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
@@ -1035,16 +1201,21 @@ interface MultiActionButtonProps {
1035
1201
  rotateLeftIconByDegree?: 0 | 45 | 90 | 135 | 180 | 225 | 270 | 315;
1036
1202
  rotateMiddleIconByDegree?: 0 | 45 | 90 | 135 | 180 | 225 | 270 | 315;
1037
1203
  rotateRightIconByDegree?: 0 | 45 | 90 | 135 | 180 | 225 | 270 | 315;
1204
+ /** @default false */
1038
1205
  disabled?: boolean;
1039
1206
  className?: string;
1040
1207
  innerClassName?: string;
1041
1208
  iconClassName?: string;
1042
1209
  toolTip?: string;
1043
1210
  toolTipComponent?: ReactNode;
1044
- id?: string | number;
1211
+ id?: string;
1212
+ /** @default false */
1045
1213
  loading?: boolean;
1214
+ /** @default false */
1046
1215
  withEllipsis?: boolean;
1216
+ /** @default 'left' */
1047
1217
  textPosition?: 'center' | 'left' | 'right';
1218
+ /** @default false */
1048
1219
  autoFocus?: boolean;
1049
1220
  leftAriaLabel?: string;
1050
1221
  rightAriaLabel?: string;
@@ -1057,29 +1228,38 @@ declare const MultiActionButton: {
1057
1228
  };
1058
1229
 
1059
1230
  interface SeparatorProps extends MarginInterface, PaddingInterface {
1231
+ id?: string;
1060
1232
  className?: string;
1233
+ /** @default ColorTypes.GREY_3 */
1061
1234
  color?: Partial<ColorTypes>;
1235
+ /** @default 'vertical' */
1062
1236
  orientation?: 'vertical' | 'horizontal';
1237
+ /** @default SizeTypes.MEDIUM */
1063
1238
  size?: SizeTypes.AUTO | SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1064
1239
  }
1065
1240
 
1066
1241
  declare const Separator: {
1067
- ({ className, margin, marginY, marginBottom, marginTop, marginLeft, marginRight, marginX, padding, paddingY, paddingRight, paddingTop, paddingBottom, paddingLeft, paddingX, orientation, size, color }: SeparatorProps): JSX.Element;
1242
+ ({ id, className, margin, marginY, marginBottom, marginTop, marginLeft, marginRight, marginX, padding, paddingY, paddingRight, paddingTop, paddingBottom, paddingLeft, paddingX, orientation, size, color }: SeparatorProps): JSX.Element;
1068
1243
  displayName: string;
1069
1244
  };
1070
1245
 
1071
1246
  interface SolidSpinnerProps {
1247
+ id?: string;
1248
+ /** @default HierarchyTypes.PRIMARY */
1072
1249
  type?: HierarchyTypes.PRIMARY | HierarchyTypes.SECONDARY | HierarchyTypes.TERTIARY | HierarchyTypes.QUATERNARY;
1250
+ /** @default SizeTypes.MEDIUM */
1073
1251
  size?: SizeTypes.EXTRA_SMALL | SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1252
+ /** @default false */
1074
1253
  disabled?: boolean;
1075
1254
  className?: string;
1076
1255
  label?: string;
1077
1256
  labelClassName?: string;
1257
+ /** @default false */
1078
1258
  absoluteCenter?: boolean;
1079
1259
  }
1080
1260
 
1081
1261
  declare const SolidSpinner: {
1082
- ({ className, disabled, type, size, label, labelClassName, absoluteCenter }: SolidSpinnerProps): JSX.Element;
1262
+ ({ id, className, disabled, type, size, label, labelClassName, absoluteCenter }: SolidSpinnerProps): JSX.Element;
1083
1263
  displayName: string;
1084
1264
  };
1085
1265
 
@@ -1098,6 +1278,7 @@ interface CellInterface {
1098
1278
  customCellComponent?: (row: any) => ReactNode | JSX.Element;
1099
1279
  }
1100
1280
  interface SortableTableProps {
1281
+ id?: string;
1101
1282
  cells: Array<{
1102
1283
  key: string;
1103
1284
  title: string;
@@ -1123,9 +1304,13 @@ interface SortableTableProps {
1123
1304
  bodyClassName?: string;
1124
1305
  spinnerClassName?: string;
1125
1306
  caption?: string;
1307
+ /** @default false */
1126
1308
  loading?: boolean;
1309
+ /** @default 6 */
1127
1310
  skeletonRows?: number;
1311
+ /** @default false */
1128
1312
  withStickyHeader?: boolean;
1313
+ /** @default false */
1129
1314
  withIntersectionObserver?: boolean;
1130
1315
  minWidth?: string;
1131
1316
  onSortCallback?: (keyName: string, ascending: boolean) => void;
@@ -1138,23 +1323,30 @@ interface SortableTableProps {
1138
1323
  }
1139
1324
 
1140
1325
  declare const SortableTable: {
1141
- ({ cells, data, sortBy, skeletonRows, loading, caption, className, headerClassName, rowClassName, bodyClassName, spinnerClassName, withStickyHeader, withIntersectionObserver, noDataMessage, minWidth, onSortCallback }: SortableTableProps): JSX.Element;
1326
+ ({ id, cells, data, sortBy, skeletonRows, loading, caption, className, headerClassName, rowClassName, bodyClassName, spinnerClassName, withStickyHeader, withIntersectionObserver, noDataMessage, minWidth, onSortCallback }: SortableTableProps): JSX.Element;
1142
1327
  displayName: string;
1143
1328
  };
1144
1329
 
1145
1330
  interface SwitchButtonProps {
1146
1331
  checked: boolean;
1147
- id?: string | number;
1332
+ id?: string;
1148
1333
  label?: string;
1149
1334
  name?: string;
1335
+ /** @default false */
1150
1336
  withLabel?: boolean;
1337
+ /** @default false */
1151
1338
  withInlineLabel?: boolean;
1339
+ /** @default false */
1152
1340
  withEllipsis?: boolean;
1153
1341
  ariaLabel?: string;
1342
+ /** @default false */
1154
1343
  disabled?: boolean;
1344
+ /** @default false */
1155
1345
  autoFocus?: boolean;
1346
+ /** @default false */
1156
1347
  alignCenter?: boolean;
1157
1348
  className?: string;
1349
+ /** @default false */
1158
1350
  marginBottom?: boolean;
1159
1351
  buttonRef?: RefObject<HTMLInputElement>;
1160
1352
  onClickCallback: () => void;
@@ -1174,21 +1366,27 @@ interface OptionItem {
1174
1366
  }
1175
1367
  interface SelectInputProps {
1176
1368
  inputRef?: RefObject<HTMLSelectElement>;
1177
- id?: string | number;
1369
+ id?: string;
1178
1370
  className?: string;
1179
1371
  inputClassName?: string;
1180
1372
  defaultOption?: string;
1373
+ /** @default SizeTypes.MEDIUM */
1181
1374
  size?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1182
1375
  sizeMd?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1183
1376
  sizeLg?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1184
1377
  sizeXl?: SizeTypes.SMALL | SizeTypes.MEDIUM | SizeTypes.LARGE;
1378
+ /** @default false */
1185
1379
  disabled?: boolean;
1380
+ /** @default true */
1186
1381
  withLabel?: boolean;
1187
1382
  error?: string;
1188
1383
  helperText?: string;
1189
1384
  text?: string;
1385
+ /** @default false */
1190
1386
  marginBottom?: boolean;
1387
+ /** @default false */
1191
1388
  autoFocus?: boolean;
1389
+ /** @default false */
1192
1390
  loading?: boolean;
1193
1391
  ariaLabel?: string;
1194
1392
  label?: string;
@@ -1196,6 +1394,7 @@ interface SelectInputProps {
1196
1394
  onChange: (value: string | number) => void;
1197
1395
  options: Array<OptionItem>;
1198
1396
  value: string | number;
1397
+ /** @default true */
1199
1398
  nativeHtmlComponent?: boolean;
1200
1399
  }
1201
1400
 
@@ -1231,38 +1430,8 @@ declare const ToolTip: {
1231
1430
  displayName: string;
1232
1431
  };
1233
1432
 
1234
- interface TypographyBaseProps extends ColorStyleInterface, MarginInterface, PaddingInterface {
1235
- className?: string;
1236
- textAlign?: string;
1237
- fontWeight?: string;
1238
- fontSize?: string;
1239
- fontStyle?: string;
1240
- meta?: boolean;
1241
- withBorderBottom?: boolean;
1242
- withEllipsis?: boolean;
1243
- withNoWordBreak?: boolean;
1244
- withWordBreak?: boolean;
1245
- disabled?: boolean;
1246
- }
1247
- interface HeadingProps extends TypographyBaseProps {
1248
- children: ReactNode;
1249
- type: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
1250
- style?: CSSProperties;
1251
- }
1252
- interface LabelProps extends TypographyBaseProps {
1253
- children: ReactNode | string;
1254
- htmlFor?: string;
1255
- style?: CSSProperties;
1256
- }
1257
- interface ParagraphProps extends TypographyBaseProps {
1258
- children: ReactNode;
1259
- }
1260
- interface SpanProps extends TypographyBaseProps {
1261
- children: ReactNode;
1262
- }
1263
-
1264
1433
  declare const Heading: {
1265
- ({ children, type, style, ...props }: HeadingProps): JSX.Element;
1434
+ ({ children, type, style, id, ...props }: HeadingProps): JSX.Element;
1266
1435
  displayName: string;
1267
1436
  defaultProps: {
1268
1437
  marginTop: string;
@@ -1271,52 +1440,62 @@ declare const Heading: {
1271
1440
  };
1272
1441
  };
1273
1442
  declare const Label: {
1274
- ({ children, htmlFor, style, ...props }: LabelProps): JSX.Element;
1443
+ ({ children, htmlFor, style, id, ...props }: LabelProps): JSX.Element;
1275
1444
  displayName: string;
1276
1445
  defaultProps: {
1277
1446
  marginBottom: string;
1278
1447
  };
1279
1448
  };
1280
1449
  declare const Paragraph: {
1281
- ({ children, ...props }: ParagraphProps): JSX.Element;
1450
+ ({ children, id, ...props }: ParagraphProps): JSX.Element;
1282
1451
  displayName: string;
1283
1452
  };
1284
1453
  declare const Span: {
1285
- ({ children, ...props }: SpanProps): JSX.Element;
1454
+ ({ children, id, ...props }: SpanProps): JSX.Element;
1286
1455
  displayName: string;
1287
1456
  };
1288
1457
 
1289
1458
  interface SkeletonItemProps extends MarginInterface, PaddingInterface {
1459
+ id?: string;
1290
1460
  className?: string;
1461
+ /** @default true */
1291
1462
  withBorderRadius?: boolean;
1463
+ /** @default 'div' */
1292
1464
  wrapperElement?: 'div' | 'li';
1293
1465
  height: string;
1294
1466
  width: string;
1295
1467
  contentRows?: number;
1468
+ /** @default ColorTypes.WHITE */
1296
1469
  backgroundColor?: Partial<ColorTypes>;
1297
1470
  borderColor?: Partial<ColorTypes>;
1298
1471
  imageColor?: Partial<ColorTypes>;
1472
+ /** @default ColorTypes.GREY_1 */
1299
1473
  contentColor?: Partial<ColorTypes>;
1300
1474
  border?: '1' | '2' | '3';
1301
1475
  borderTop?: '1' | '2' | '3';
1302
1476
  borderBottom?: '1' | '2' | '3';
1303
1477
  borderRight?: '1' | '2' | '3';
1304
1478
  borderLeft?: '1' | '2' | '3';
1479
+ /** @default false */
1305
1480
  withImage?: boolean;
1481
+ /** @default false */
1306
1482
  withImageRadius?: boolean;
1483
+ /** @default false */
1307
1484
  withLoadingAnimation?: boolean;
1308
1485
  }
1309
1486
 
1310
1487
  declare const SkeletonItem: {
1311
- ({ className, margin, marginY, marginTop, marginLeft, marginBottom, marginRight, marginX, paddingY, paddingBottom, paddingTop, paddingRight, paddingLeft, paddingX, height, width, contentRows, withImage, withImageRadius, withLoadingAnimation, imageColor, borderColor, border, borderTop, borderLeft, borderBottom, borderRight, contentColor, wrapperElement, padding, backgroundColor, withBorderRadius }: SkeletonItemProps): JSX.Element;
1488
+ ({ id, className, margin, marginY, marginTop, marginLeft, marginBottom, marginRight, marginX, paddingY, paddingBottom, paddingTop, paddingRight, paddingLeft, paddingX, height, width, contentRows, withImage, withImageRadius, withLoadingAnimation, imageColor, borderColor, border, borderTop, borderLeft, borderBottom, borderRight, contentColor, wrapperElement, padding, backgroundColor, withBorderRadius }: SkeletonItemProps): JSX.Element;
1312
1489
  displayName: string;
1313
1490
  };
1314
1491
 
1315
1492
  interface NoDataMessageProps {
1493
+ id?: string;
1316
1494
  className?: string;
1317
1495
  icon?: Partial<IconTypes>;
1318
1496
  title?: string;
1319
1497
  message?: string;
1498
+ /** @default false */
1320
1499
  absoluteCenter?: boolean;
1321
1500
  customLink?: ReactNode;
1322
1501
  button?: {
@@ -1327,7 +1506,7 @@ interface NoDataMessageProps {
1327
1506
  }
1328
1507
 
1329
1508
  declare const NoDataMessage: {
1330
- ({ icon, title, message, className, absoluteCenter, customLink, button }: NoDataMessageProps): JSX.Element;
1509
+ ({ id, icon, title, message, className, absoluteCenter, customLink, button }: NoDataMessageProps): JSX.Element;
1331
1510
  displayName: string;
1332
1511
  };
1333
1512