@fluidattacks/design 3.1.4 → 3.1.5

package/types/components/tour/types.d.ts

@@ -0,0 +1,14 @@
+import type { Step } from "react-joyride";
+/**
+ * Tour component props.
+ * @interface ITourProps
+ * @property { Function } [onFinish] - The callback function to be executed when the tour finishes.
+ * @property { boolean } run - A flag indicating whether the tour should be run.
+ * @property { Step[] } steps - The steps to be included in the tour.
+ */
+interface ITourProps {
+    onFinish?: () => void;
+    run: boolean;
+    steps: Step[];
+}
+export type { ITourProps };

package/types/components/typography/heading/index.d.ts

@@ -0,0 +1,3 @@
+import type { PropsWithChildren } from "react";
+declare const Heading: import("react").ForwardRefExoticComponent<Readonly<PropsWithChildren<import("../types").ITypographyProps>> & import("react").RefAttributes<HTMLParagraphElement>>;
+export { Heading };

package/types/components/typography/index.d.ts

@@ -0,0 +1,4 @@
+import { Heading } from "./heading";
+import { Span } from "./span";
+import { Text } from "./text";
+export { Heading, Text, Span };

package/types/components/typography/span/index.d.ts

@@ -0,0 +1,3 @@
+import type { PropsWithChildren } from "react";
+declare const Span: import("react").ForwardRefExoticComponent<Readonly<PropsWithChildren<import("../types").ITypographyProps>> & import("react").RefAttributes<HTMLParagraphElement>>;
+export { Span };

package/types/components/typography/styles.d.ts

@@ -0,0 +1,26 @@
+import type { TTextProps } from "./types";
+interface IStyledTextProps {
+    $bgGradient?: TTextProps["bgGradient"];
+    $color?: TTextProps["color"];
+    $content?: TTextProps["content"];
+    $display?: TTextProps["display"];
+    $fontFamily?: TTextProps["fontFamily"];
+    $fontWeight?: TTextProps["fontWeight"];
+    $letterSpacing?: TTextProps["letterSpacing"];
+    $lineSpacing?: TTextProps["lineSpacing"];
+    $lineSpacingSm?: TTextProps["lineSpacingSm"];
+    $size: TTextProps["size"];
+    $sizeMd?: TTextProps["sizeMd"];
+    $sizeSm?: TTextProps["sizeSm"];
+    $textFill?: TTextProps["textFill"];
+    $wordBreak?: TTextProps["wordBreak"];
+}
+declare const StyledHeading: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("components/@core").IPaddingModifiable | keyof import("components/@core").IMarginModifiable | keyof import("components/@core").IPositionModifiable | keyof import("components/@core").IBorderModifiable | keyof import("components/@core").IDisplayModifiable | keyof import("components/@core").ITextModifiable | keyof import("components/@core").IInteractionModifiable> & import("components/@core").IBorderModifiable & import("components/@core").IDisplayModifiable & import("components/@core").IInteractionModifiable & import("components/@core").IMarginModifiable & import("components/@core").IPaddingModifiable & import("components/@core").IPositionModifiable & import("components/@core").ITextModifiable, "ref"> & {
+    ref?: ((instance: HTMLParagraphElement | null) => void) | import("react").RefObject<HTMLParagraphElement> | null | undefined;
+}, IStyledTextProps>> & string;
+declare const StyledText: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<Omit<import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, keyof import("components/@core").IPaddingModifiable | keyof import("components/@core").IMarginModifiable | keyof import("components/@core").IPositionModifiable | keyof import("components/@core").IBorderModifiable | keyof import("components/@core").IDisplayModifiable | keyof import("components/@core").ITextModifiable | keyof import("components/@core").IInteractionModifiable> & import("components/@core").IBorderModifiable & import("components/@core").IDisplayModifiable & import("components/@core").IInteractionModifiable & import("components/@core").IMarginModifiable & import("components/@core").IPaddingModifiable & import("components/@core").IPositionModifiable & import("components/@core").ITextModifiable, "ref"> & {
+    ref?: ((instance: HTMLParagraphElement | null) => void) | import("react").RefObject<HTMLParagraphElement> | null | undefined;
+}, IStyledTextProps>> & string;
+declare const StyledSpan: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components/dist/types").Substitute<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, IStyledTextProps>> & string;
+export type { IStyledTextProps };
+export { StyledHeading, StyledText, StyledSpan };

package/types/components/typography/text/index.d.ts

@@ -0,0 +1,3 @@
+import type { PropsWithChildren } from "react";
+declare const Text: import("react").ForwardRefExoticComponent<Readonly<PropsWithChildren<import("../types").ITypographyProps>> & import("react").RefAttributes<HTMLParagraphElement>>;
+export { Text };

package/types/components/typography/types.d.ts

@@ -0,0 +1,27 @@
+import type { Property } from "csstype";
+import { IMarginModifiable, IPaddingModifiable, ISizeModifiable, ITextModifiable } from "components/@core";
+/**
+ * Typography component props.
+ * @interface ITypographyProps
+ * @extends IMarginModifiable
+ * @extends IPaddingModifiable
+ * @extends ISizeModifiable
+ * @extends ITextModifiable
+ * @property {Property.Background} [bgGradient] - Background gradient.
+ * @property {string} [className] - Additional class names.
+ * @property {string} [content] - Text content.
+ * @property {Display} [display] - Text display layout.
+ * @property {LineHeight<number | string>} - Line height in mobile resolution.
+ * @property {Property.WebkitTextFillColor} [textFill] - Text fill color.
+ */
+interface ITypographyProps extends IMarginModifiable, ISizeModifiable, IPaddingModifiable, Omit<ITextModifiable, "fontSize"> {
+    bgGradient?: Property.Background;
+    className?: string;
+    content?: string;
+    display?: Property.Display;
+    lineSpacingSm?: Property.LineHeight<number | string>;
+    textFill?: Property.WebkitTextFillColor;
+}
+type THeadingProps = ITypographyProps;
+type TTextProps = ITypographyProps;
+export type { THeadingProps, TTextProps, ITypographyProps };

package/types/components/web-form/index.d.ts

@@ -0,0 +1,5 @@
+import { PropsWithChildren } from "react";
+import { FormItem } from "./styles";
+import { IFormProps } from "./types";
+declare const WebForm: ({ children, name, onSubmit, submitDisabled, submitLabel, }: Readonly<PropsWithChildren<IFormProps>>) => JSX.Element;
+export { WebForm, FormItem };

package/types/components/web-form/styles.d.ts

@@ -0,0 +1,4 @@
+declare const StyledForm: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>, never>> & string;
+declare const StyledInnerContainer: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
+declare const FormItem: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
+export { FormItem, StyledForm, StyledInnerContainer };

package/types/components/web-form/types.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Form component props.
+ * @interface IFormProps
+ * @property {string} name The name of the form.
+ * @property {Function} [onSubmit] Callback to be executed when form is submitted.
+ * @property {boolean} [submitDisabled] Whether the submit button should be disabled.
+ * @property {string} [submitLabel] The label to show on submit.
+ */
+interface IFormProps {
+    name: string;
+    onSubmit?: React.FormEventHandler<HTMLFormElement>;
+    submitDisabled?: boolean;
+    submitLabel?: string;
+}
+export type { IFormProps };

package/types/hooks/index.d.ts

@@ -0,0 +1,8 @@
+import { useCarousel } from "./use-carousel";
+import { useClickOutside } from "./use-click-outside";
+import { useCloudinaryImage } from "./use-cloudinary-image";
+import { useDebouncedCallback } from "./use-debounced-callback";
+import { type IUseModal, useModal } from "./use-modal";
+import { useSearch } from "./use-search";
+export type { IUseModal };
+export { useCarousel, useCloudinaryImage, useClickOutside, useDebouncedCallback, useModal, useSearch, };

package/types/hooks/use-carousel.d.ts

@@ -0,0 +1,6 @@
+export declare const useCarousel: (delay: number, numberOfCycles: number) => {
+    cycle: number;
+    progress: number;
+    setCycle: React.Dispatch<React.SetStateAction<number>>;
+    setProgress: React.Dispatch<React.SetStateAction<number>>;
+};

package/types/hooks/use-click-outside.d.ts

@@ -0,0 +1,2 @@
+declare const useClickOutside: (element: Readonly<HTMLElement | null>, onClickOutside: VoidFunction, addEventListenerToFullDocument?: boolean) => void;
+export { useClickOutside };

package/types/hooks/use-cloudinary-image.d.ts

@@ -0,0 +1,13 @@
+import type { CloudinaryImage } from "@cloudinary/url-gen";
+/**
+ * Cloudinary image hook props.
+ * @interface IUseCloudinaryImageProps
+ * @property {string} publicId The publicId location in cloudinary.
+ * @property {string} [format] The image format desired (e.g., png, jpg).
+ */
+interface IUseCloudinaryImageProps {
+    readonly publicId: string;
+    readonly format?: string;
+}
+export declare const useCloudinaryImage: ({ publicId, format, }: IUseCloudinaryImageProps) => CloudinaryImage;
+export {};

package/types/hooks/use-debounced-callback.d.ts

@@ -0,0 +1,4 @@
+import _ from "lodash";
+type TCallable = (...args: readonly any[]) => any;
+declare const useDebouncedCallback: <T extends TCallable>(callback: T, wait: number) => _.DebouncedFunc<T>;
+export { useDebouncedCallback };

package/types/hooks/use-modal.d.ts

@@ -0,0 +1,11 @@
+interface IUseModal {
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+    isOpen: boolean;
+    name: string;
+    setIsOpen: (value: boolean) => void;
+}
+declare const useModal: (name: string) => IUseModal;
+export type { IUseModal };
+export { useModal };

package/types/hooks/use-search.d.ts

@@ -0,0 +1,5 @@
+interface IUseSearchParams {
+    readonly debounceWait: number;
+}
+declare const useSearch: (params?: IUseSearchParams) => [string | undefined, (value: string) => void];
+export { useSearch };

package/types/index.d.ts

@@ -0,0 +1,67 @@
+import "./styles/global.css";
+export * from "components/@core";
+export * from "components/accordion";
+export * from "components/alert";
+export * from "components/button";
+export * from "components/card";
+export * from "components/carousel";
+export * from "components/checkbox";
+export * from "components/cloud-image";
+export * from "components/code-snippet";
+export * from "components/colors";
+export * from "components/confirm-dialog";
+export * from "components/container";
+export * from "components/content-card";
+export * from "components/content-card-carousel";
+export * from "components/divider";
+export * from "components/empty-state";
+export * from "components/file-preview";
+export * from "components/form";
+export * from "components/grid-container";
+export * from "components/group-selector";
+export * from "components/icon";
+export * from "components/icon-button";
+export * from "components/indicator-card";
+export * from "components/info-sidebar";
+export * from "components/inputs";
+export * from "components/interactive-card";
+export * from "components/language-selector";
+export * from "components/link";
+export * from "components/list-item";
+export * from "components/little-flag";
+export * from "components/loading";
+export * from "components/logo";
+export * from "components/logo-carousel";
+export * from "components/lottie";
+export * from "components/menu";
+export * from "components/message-banner";
+export * from "components/modal";
+export * from "components/notification";
+export * from "components/notification-sign";
+export * from "components/number-input";
+export * from "components/oauth-selector";
+export * from "components/premium-feature";
+export * from "components/priority-score";
+export * from "components/progress";
+export * from "components/pop-up";
+export * from "components/radio-button";
+export * from "components/scroll-button";
+export * from "components/search";
+export * from "components/search-bar";
+export * from "components/severity-badge";
+export * from "components/severity-overview";
+export * from "components/show-on-hover";
+export * from "components/slide-out-menu";
+export * from "components/slider";
+export * from "components/step-lapse";
+export * from "components/table-button";
+export * from "components/tabs";
+export * from "components/tag";
+export * from "components/timeline";
+export * from "components/toggle";
+export * from "components/toggle-buttons";
+export * from "components/tooltip";
+export * from "components/tour";
+export * from "components/typography";
+export * from "components/web-form";
+export * from "hooks";

package/types/utils/date.d.ts

@@ -0,0 +1,3 @@
+declare const formatDate: (value: string) => string;
+declare const formatDateTime: (value: string) => string;
+export { formatDate, formatDateTime };

package/types/utils/open-url.d.ts

@@ -0,0 +1 @@
+export declare const openUrl: (url: string, openANewTab?: boolean) => void;