@wavelengthusaf/components 2.3.0 → 2.3.2

package/dist/cjs/index.d.cts

@@ -0,0 +1,425 @@
+import * as React from 'react';
+import React__default, { ReactNode } from 'react';
+import { SxProps, Theme } from '@mui/material/styles';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { TextFieldVariants, SxProps as SxProps$1, Theme as Theme$1 } from '@mui/material';
+import { Mark } from '@mui/material/Slider/useSlider.types';
+
+/**
+ * Helper Functions
+ * @param a
+ * @param b
+ * @returns
+ */
+declare function add(a: number, b: number): number;
+
+/**
+ * Helper Functions
+ * @param a
+ * @param b
+ * @returns
+ */
+declare function concat(a: string, b: string): string;
+
+interface OutlinedButtonProps {
+    id?: string;
+    variant: "outlined" | "contained" | "text" | "custom";
+    colorOne?: string;
+    colorTwo?: string;
+    onClick?: any;
+    margin?: string;
+    padding?: string;
+    autoFocus?: boolean;
+    disabled?: boolean;
+    children?: ReactNode;
+    data_test?: string;
+    borderRadius?: string;
+    mySx?: SxProps<Theme> | undefined;
+}
+declare function WavelengthButton({ id, variant, colorOne, colorTwo, margin, padding, autoFocus, disabled, onClick, children, borderRadius, mySx }: OutlinedButtonProps): React__default.JSX.Element;
+
+interface ButtonProps {
+    onClick?: any;
+    children?: ReactNode;
+}
+interface IconProps {
+    text: string;
+    numIcon?: string;
+    children: ReactNode;
+    active?: boolean;
+    width: string;
+    height: number;
+    fontsize: number;
+}
+declare function ButtonIcon({ text, numIcon, children, active, width, height, fontsize }: IconProps): react_jsx_runtime.JSX.Element;
+interface ButtonMenuProps {
+    children: ReactNode;
+}
+declare function ButtonMenu({ children }: ButtonMenuProps): react_jsx_runtime.JSX.Element;
+declare function WavelengthDropdownButton({ children, onClick }: ButtonProps): React__default.JSX.Element;
+
+interface WavelengthAutocompleteProps {
+    id?: string;
+    label: string;
+    items?: any;
+    variant?: TextFieldVariants;
+    width?: number;
+    borderColor?: string;
+    hoverColor?: string;
+    textColor?: string;
+    onChange?: (selectedValue: string) => void;
+}
+/**
+ * Returns the Best Matching String from a List; Defaults to the first item if no good match is found
+ * @param searchString - the string we want to look for
+ * @param choices - the list of strings we get to choose from (must be greater than 0)
+ * @returns - a string with the "best" match, or "" if no match is found
+ */
+declare function findBestStringMatch(searchString: string, choices: string[]): string;
+declare function WavelengthAutocomplete({ label, width, variant, items, onChange, borderColor, textColor, hoverColor, id }: WavelengthAutocompleteProps): react_jsx_runtime.JSX.Element;
+
+interface DownloadProps {
+    fileLoc: "local" | "api";
+    fileURL: string;
+    fileName: string;
+    button?: ReactNode | React__default.JSX.Element;
+    id?: string;
+}
+declare function WavelengthFileDownloader({ fileLoc, fileURL, fileName, button, id }: DownloadProps): react_jsx_runtime.JSX.Element | undefined;
+
+interface WavelengthBoxProps {
+    width?: number;
+    height?: number;
+    children: ReactNode;
+    borderTopRadius?: string;
+    borderBottomRadius?: string;
+    id?: string;
+}
+declare function WavelengthBox({ width, height, children, borderBottomRadius, borderTopRadius, id }: WavelengthBoxProps): react_jsx_runtime.JSX.Element;
+
+interface WavelengthContentPlaceholderProps {
+    type?: "circle" | "rectangle";
+    width?: string | number;
+    height?: string | number;
+    txtcolor?: string;
+    bgcolor?: string;
+    children: ReactNode;
+    id?: string;
+}
+declare function WavelengthContentPlaceholder({ type, width, height, txtcolor, bgcolor, children, id }: WavelengthContentPlaceholderProps): react_jsx_runtime.JSX.Element;
+
+interface WavelengthExampleComponentProps {
+    width?: number;
+    height?: number;
+}
+declare function WavelengthExampleComponent({ width, height }: WavelengthExampleComponentProps): react_jsx_runtime.JSX.Element;
+
+interface SearchResult {
+    id: number | string;
+    title: string;
+    subtitle?: string;
+}
+interface SearchProps {
+    id?: string;
+    mode: "automatic" | "manual";
+    type?: "text-box" | "search-bar";
+    iconPos?: "start" | "end";
+    borderRadius?: number | string;
+    label?: string;
+    width?: string;
+    height?: string | number;
+    children?: ReactNode;
+    borderColor?: string;
+    hoverColor?: string;
+    textColor?: string;
+    backgroundColor?: string;
+    placeholder?: string;
+    onEnter?: (arg0?: any) => any;
+    size?: "small" | "medium";
+    fontSize?: string;
+    options: SearchResult[];
+    onChange?: React__default.ChangeEventHandler<HTMLInputElement | HTMLTextAreaElement>;
+    onSearchItemSelected?: (selectedItem: SearchResult | string) => void;
+}
+declare function WavelengthSearch({ id, mode, type, width, height, label, size, borderRadius, children, placeholder, onEnter, onSearchItemSelected, options, onChange, borderColor, hoverColor, textColor, fontSize, backgroundColor, iconPos, }: SearchProps): react_jsx_runtime.JSX.Element | undefined;
+
+declare function SearchTextField(): react_jsx_runtime.JSX.Element;
+
+interface NotAvailablePageProps {
+    appLogoName?: string;
+    errorMessage: string;
+    backgroundColor?: string;
+    buttonText: string;
+    redirectLink?: string;
+    buttonColorOne?: string;
+    buttonColorTwo?: string;
+    id?: string;
+}
+declare function NotAvailablePage({ appLogoName, errorMessage, backgroundColor, buttonText, redirectLink, buttonColorOne, buttonColorTwo, id }: NotAvailablePageProps): react_jsx_runtime.JSX.Element;
+
+interface SubSectionItem {
+    title?: string;
+    path?: string;
+    onClick?: () => void;
+    items?: SubSectionItem[];
+}
+interface SubSection {
+    title?: string;
+    items?: SubSectionItem[];
+}
+interface Section {
+    title: string;
+    subsections?: SubSection[];
+}
+interface SidebarProps {
+    id?: string;
+    sections: Section[];
+    bgColor?: string;
+    txtColor?: string;
+    labelColor?: string;
+    arrowColor?: string;
+    marginTop?: string;
+    marginLeft?: string;
+    width?: string | number;
+    height?: string | number;
+}
+declare function WavelengthSideBar({ sections, txtColor, bgColor, labelColor, arrowColor, marginTop, marginLeft, width, height, id }: SidebarProps): React__default.JSX.Element;
+
+interface ISpinningSvgProps {
+    size: number;
+    id: "outer-circle" | "middle-circle" | "inner-circle" | "spinning";
+    clip: string;
+    color: string;
+    gradient: boolean;
+    radius: number;
+}
+declare function WavelengthSpinningOuterCircle({ size, id, clip, color, gradient, radius }: ISpinningSvgProps): react_jsx_runtime.JSX.Element;
+
+interface spinningLogoProps {
+    svg?: React__default.ReactNode;
+    size?: number;
+    id?: string;
+}
+declare function WavelengthSpinningLogo({ svg, size, id }: spinningLogoProps): react_jsx_runtime.JSX.Element;
+
+interface WavelengthFooterProps {
+    text?: string;
+    textColor?: string;
+}
+declare function WavelengthFooter({ text, textColor }: WavelengthFooterProps): react_jsx_runtime.JSX.Element;
+
+interface titlebarProps {
+    id?: string;
+}
+declare function WavelengthTitleBar({ id }: titlebarProps): react_jsx_runtime.JSX.Element;
+
+interface WavelengthBannerProps {
+    classification?: "unclassified" | "controlled" | "controlled unclassified information" | "cui" | "u" | "confidential" | "c" | "secret" | "s" | "top secret" | "ts" | string;
+    control?: ("cui" | "sci" | "fouo" | "nf" | "propin" | "frd" | "gbr s" | "si" | "si-g" | "tk" | "relido" | "rd" | "rd-n" | "rel" | "fvey" | "hcs" | string)[];
+    headerColor?: string;
+    textColor?: string;
+    id?: string;
+}
+declare function WavelengthBanner({ classification, control, headerColor, textColor, id }: WavelengthBannerProps): react_jsx_runtime.JSX.Element;
+
+interface AppLogoProps {
+    width?: number;
+    height?: number;
+    name?: string;
+    grayscale?: boolean;
+    id?: string;
+}
+declare function AppLogo({ width, height, name, grayscale, id }: AppLogoProps): react_jsx_runtime.JSX.Element;
+
+interface HeaderProps {
+    numberOfPlanes?: number;
+    trailDir?: "right" | "left";
+    color?: string;
+    opacity?: number;
+    gradient?: boolean;
+}
+declare function ManyPlanesComponent({ numberOfPlanes, trailDir, color, opacity, gradient }: HeaderProps): react_jsx_runtime.JSX.Element;
+
+interface DefaultProps {
+    width?: string;
+    height?: number;
+}
+declare function DefaultIcon({ width, height }: DefaultProps): react_jsx_runtime.JSX.Element;
+
+interface WavelengthPlaneTrailProps {
+    trailDir?: "right" | "left";
+    id?: string;
+}
+declare function WavelengthPlaneTrail({ trailDir, id }: WavelengthPlaneTrailProps): react_jsx_runtime.JSX.Element;
+
+type ThemeProperties = {
+    name?: string;
+};
+declare const WavelengthAppTheme: React.Context<ThemeProperties>;
+declare const useThemeContext: () => ThemeProperties;
+
+interface WavelengthConfirmationModalProps {
+    show: boolean;
+    setShow: (show: boolean) => void;
+    textObj: Record<string, string>;
+    handleConfirmationModalOnConfirmProp: () => void;
+    id?: string;
+}
+declare function WavelengthConfirmationModal(props: WavelengthConfirmationModalProps): react_jsx_runtime.JSX.Element;
+
+interface WavelengthContentModalProps {
+    show: boolean;
+    setShow: (show: boolean) => void;
+    textObj: Record<string, string>;
+    handleContentModalOnConfirmProp: () => void;
+}
+declare function WavelengthContentModal(props: WavelengthContentModalProps): react_jsx_runtime.JSX.Element;
+
+interface menuItemProps {
+    itemType: "header" | "link" | "footer" | string;
+    label: string | number;
+    link?: string;
+    end?: boolean;
+    email?: string;
+}
+interface PopUPMenuProps {
+    menuItems: menuItemProps[];
+    customIcon?: React__default.ReactNode;
+    width?: string;
+    menuDirection?: "top" | "bottom";
+    color?: string;
+    emailHoverColor?: string;
+    id?: string;
+}
+declare function WavelengthPopUpMenu({ menuItems, customIcon, width, menuDirection, color, emailHoverColor, id }: PopUPMenuProps): react_jsx_runtime.JSX.Element;
+
+interface DropdownProps {
+    id?: string;
+    palette: "brewery" | "custom";
+    width: string;
+    options: menuOptions[];
+    buttonSx?: SxProps$1<Theme$1> | undefined;
+    menuSx?: MenuSxProps;
+    buttonText: string | ReactNode;
+}
+interface menuOptions {
+    option: React__default.ReactNode;
+    onClick?: React__default.MouseEventHandler<HTMLLIElement> | undefined;
+}
+interface MenuSxProps {
+    backgroundColor?: string;
+    borderColor?: string;
+    hoverColor?: string;
+    width?: string;
+    boxShadow?: string;
+}
+declare function WavelengthDropdown({ id, options, buttonSx, width, buttonText, menuSx, palette }: DropdownProps): react_jsx_runtime.JSX.Element;
+
+interface ConfirmationSnackbarProps {
+    show: boolean;
+    setShow: (show: boolean) => void;
+    closeIcon?: ReactNode | React__default.JSX.Element;
+    message?: string;
+    snackBarColor?: string;
+    textColor?: string;
+    horryAlign?: "left" | "right" | "center";
+    vertyAlign?: "top" | "bottom";
+    durationSb?: number;
+    id?: string;
+    width?: string | number;
+    icon?: ReactNode;
+}
+declare function WavelengthSnackbar({ show, setShow, closeIcon, message, snackBarColor, textColor, horryAlign, vertyAlign, durationSb, width, icon, id }: ConfirmationSnackbarProps): react_jsx_runtime.JSX.Element;
+
+interface StandardSnackbarProps {
+    type: "success" | "error" | "disabled";
+    show: boolean;
+    closeIcon: ReactNode | React__default.JSX.Element;
+    icon?: ReactNode;
+    toggleShow: (on: boolean) => void;
+    horryAlign?: "left" | "right" | "center";
+    vertyAlign?: "top" | "bottom";
+    durationSb?: number;
+    width?: string | number;
+    message?: string | ReactNode;
+    customVertyAlign?: string;
+    id?: string;
+}
+declare function WavelengthStandardSnackbar({ type, show, icon, horryAlign, vertyAlign, durationSb, width, message, customVertyAlign, toggleShow, closeIcon, id }: StandardSnackbarProps): react_jsx_runtime.JSX.Element;
+
+interface Testprops {
+    isPopUpOpen: boolean;
+    type: "success" | "error" | "disabled";
+    icon?: ReactNode;
+    width?: string | number;
+    message?: string | ReactNode;
+    img: React__default.JSX.Element | ReactNode;
+    toggleOpen: (value: React__default.SetStateAction<boolean>) => void;
+    customVertyAlign?: string;
+}
+declare const useOutsideClick: (callback: () => void) => React__default.RefObject<HTMLDivElement>;
+declare function TestSnackbar({ isPopUpOpen, toggleOpen, type, message, customVertyAlign, width, img }: Testprops): react_jsx_runtime.JSX.Element;
+
+interface sliderProps {
+    width?: string;
+    labelColor?: string;
+    color?: string;
+    value: number;
+    valueDisplayed?: boolean;
+    minVal: number;
+    maxVal: number;
+    step: number;
+    handleChange: (event: Event, newValue: number | number[]) => void;
+    labelFunc?(val: number): string;
+    marks?: Mark[];
+}
+declare function WavelengthSlider({ width, color, valueDisplayed, marks, labelColor, value, maxVal, minVal, step, labelFunc, handleChange }: sliderProps): react_jsx_runtime.JSX.Element;
+
+interface carouselItem$1 {
+    title?: string;
+    description?: string;
+    image: string;
+    path: string;
+}
+interface carouselConfigArray$1 {
+    items: carouselItem$1[];
+}
+interface adjustableDimensions {
+    buttonSize?: number;
+    imageHeight?: number;
+    imageWidth?: number;
+    cardWidth?: number;
+    cardHeight?: number;
+}
+declare const DefaultCarousel: React__default.FC<carouselConfigArray$1 & adjustableDimensions>;
+
+interface carouselItem {
+    title?: string;
+    description?: string;
+    image: string;
+    path: string;
+}
+interface carouselConfigArray {
+    items: carouselItem[];
+}
+interface adjustDimenforCarousel {
+    contHeight?: number;
+    contWidth?: number;
+    cardWidth?: number;
+    cardHeight?: number;
+}
+declare const SliderCardCarousel: React__default.FC<carouselConfigArray & adjustDimenforCarousel>;
+
+interface PaginationProps {
+    totalPages: number;
+    boundaryCount?: number;
+    siblingCount?: number;
+    currentPageNumber: number;
+    style?: "text" | "contained" | "outlined" | "circular";
+    onPageChange: (page: number) => void;
+}
+declare const range: (start: number, end: number) => number[];
+declare function ascendingRange(start: number, end: number): number[];
+declare function DefaultPagination({ totalPages, currentPageNumber, siblingCount, boundaryCount, style, onPageChange }: PaginationProps): react_jsx_runtime.JSX.Element;
+
+export { AppLogo, ButtonIcon, ButtonMenu, DefaultCarousel, DefaultIcon, DefaultPagination, ManyPlanesComponent, NotAvailablePage, type SearchResult, SearchTextField, SliderCardCarousel, TestSnackbar, type ThemeProperties, WavelengthAppTheme, WavelengthAutocomplete, WavelengthBanner, WavelengthBox, WavelengthButton, WavelengthConfirmationModal, WavelengthContentModal, WavelengthContentPlaceholder, WavelengthDropdown, WavelengthDropdownButton, WavelengthExampleComponent, WavelengthFileDownloader, WavelengthFooter, WavelengthPlaneTrail, WavelengthPopUpMenu, WavelengthSearch, WavelengthSideBar, WavelengthSlider, WavelengthSnackbar, WavelengthSpinningLogo, WavelengthSpinningOuterCircle, WavelengthStandardSnackbar, WavelengthTitleBar, add, ascendingRange, concat, findBestStringMatch, type menuItemProps, range, useOutsideClick, useThemeContext };