@sikka/hawa 0.0.239 → 0.0.241

package/lib/elements/ArrowCarousel.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
+import { FunctionComponent } from "react";
 type Item = {
     label?: string;
     icon?: JSX.Element;
@@ -9,5 +9,5 @@ type ComponentTypes = {
     arrowSize?: number;
     labelSize?: "small" | "medium" | "big";
 };
-export declare const ArrowCarousel: React.FunctionComponent<ComponentTypes>;
+export declare const ArrowCarousel: FunctionComponent<ComponentTypes>;
 export {};

package/lib/elements/BackToTop.d.ts

@@ -0,0 +1,10 @@
+import React, { FunctionComponent } from "react";
+type ComponentTypes = {
+    paddingX?: number;
+    paddingY?: number;
+    paddingThreshold?: number;
+    corner?: "top-left" | "top-right" | "bottom-left" | "bottom-right";
+    anchor: React.RefObject<HTMLInputElement>;
+};
+export declare const BackToTop: FunctionComponent<ComponentTypes>;
+export {};

package/lib/elements/Breadcrumb.d.ts

@@ -1,11 +1,14 @@
 import { FC, ReactNode } from "react";
-type TBreadcrumItem = {
-    label: string;
-    href: string;
-};
 type TBreadcrumb = {
-    breadcrumbLink: TBreadcrumItem[];
+    /**
+     * The array of crumbs, each one with a label and a href link
+     */
+    breadcrumbLinks: [{
+        label: string;
+        href: string;
+    }];
+    /** The separator between each crumb, can be character or React Node */
     separator?: string | ReactNode;
 };
-declare const Breadcrumb: FC<TBreadcrumb>;
-export default Breadcrumb;
+declare const HawaBreadcrumb: FC<TBreadcrumb>;
+export default HawaBreadcrumb;

package/lib/elements/DragDropImages.d.ts

@@ -1,5 +1,8 @@
 import React from "react";
 type DragDropImagesTypes = {
+    /**
+     * The text label above the component. Consistant with the other form input fields
+     */
     label?: string;
     files: [File];
     setFiles: any;
@@ -9,15 +12,18 @@ type DragDropImagesTypes = {
     onAcceptedFiles: any;
     showPreview: any;
     onDeleteFile: any;
+    onClearFiles: any;
+    maxSize: number;
+    errorMessages: string;
+    /**
+     * The translation object, use this to replace the default text with any translated text you want.
+     */
     texts: {
         clickHereToUpload: string;
         maxFileSize: string;
         tooManyFiles: string;
         fileTooLarge: string;
     };
-    onClearFiles: any;
-    maxSize: number;
-    errorMessages: string;
 };
 export declare const DragDropImages: React.FunctionComponent<DragDropImagesTypes>;
 export {};

package/lib/elements/HawaAccordion.d.ts

@@ -1,6 +1,17 @@
 import React from "react";
 type AccordionTypes = {
+    /**
+     * The title of the clickable accordion bar
+     */
+    title: string;
+    /**
+     * The content inside the accordion to be visible once the bar is clicked
+     */
     content: any;
+    /**
+     * The index of each accordion, must be unique for each usage of this component
+     */
+    index: any;
 };
 export declare const HawaAccordion: React.FunctionComponent<AccordionTypes>;
 export {};

package/lib/elements/HawaAlert.d.ts

@@ -1,11 +1,12 @@
 import React from "react";
 type AlertTypes = {
     severity: "info" | "warning" | "error" | "success";
+    /** The title of the alert placed above the text of the alert. Can be used alone */
     title?: any;
-    variant?: "normal" | "solid" | "top-accent" | "left-accent" | "right-accent" | "bottom-accent";
+    /** The text of the alert placed below the title of the alert. Can be used alone */
     text: any;
+    variant?: "normal" | "solid" | "top-accent" | "left-accent" | "right-accent" | "bottom-accent";
     direction?: "rtl" | "ltr";
-    hideIcon?: any;
     actions?: [
         {
             label: string;

package/lib/elements/index.d.ts

@@ -34,6 +34,7 @@ export * from "./UserFeedback";
 export * from "./ArrowCarousel";
 export * from "./FloatingComment";
 export * from "./FloatingCommentSlate";
+export * from "./BackToTop";
 export * from "./HawaTextField";
 export * from "./HawaCardInput";
 export * from "./HawaPinInput";