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