@windstream/react-shared-components 0.0.1

package/dist/core.d.ts

@@ -0,0 +1,389 @@
+import * as React$1 from 'react';
+import React__default, { InputHTMLAttributes, ReactNode, ForwardRefRenderFunction, AnchorHTMLAttributes, MouseEvent, CSSProperties, HTMLAttributes, LiHTMLAttributes, ButtonHTMLAttributes, LabelHTMLAttributes, FC } from 'react';
+export { ButtonHTMLAttributes, CSSProperties, ReactNode } from 'react';
+import { ButtonProps as ButtonProps$1 } from '@shared/components/button/types';
+export { ButtonProps } from '@shared/components/button/types';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CallButtonProps } from '@shared/components/call-button/types';
+export { CallButtonProps } from '@shared/components/call-button/types';
+import { Props } from 'react-modal';
+import { AccordionProps } from '@shared/components/accordion/types';
+export { AccordionProps } from '@shared/components/accordion/types';
+import { Props as Props$1 } from 'react-select';
+import { TextVariant as TextVariant$1 } from '@shared/components/text';
+import * as _shared_components_brand_button_types from '@shared/components/brand-button/types';
+import { ChecklistProps } from '@shared/components/checklist/types';
+export { ChecklistProps } from '@shared/components/checklist/types';
+import { SeeMoreProps } from '@shared/components/see-more/types';
+export { SeeMoreProps } from '@shared/components/see-more/types';
+import { ClassValue } from 'clsx';
+export { ClassValue, clsx } from 'clsx';
+
+declare const Button: React$1.ForwardRefExoticComponent<ButtonProps$1 & React$1.RefAttributes<HTMLButtonElement>>;
+
+type InputProps = Omit<InputHTMLAttributes<HTMLInputElement>, "size"> & {
+    loading?: boolean;
+    iconLeft?: ReactNode;
+    size?: "sm" | "md";
+    hasError?: boolean;
+    label?: string;
+    labelClassName?: string;
+    containerClassName?: string;
+    mapPinIcon?: boolean;
+    isLightMapPinIcon?: boolean;
+    passwordToggle?: boolean;
+    helperText?: string;
+    error?: string;
+    variant?: "default" | "unstyled";
+};
+type InputFieldProps = Omit<InputHTMLAttributes<HTMLInputElement>, "size"> & {
+    state?: "default" | "focus" | "active" | "hover" | "filled" | "error";
+    size?: "slim" | "medium" | "large";
+    label?: string;
+    errorText?: string;
+    prefixIconName?: "location_on" | "search";
+    prefixIconSize?: 20 | 24 | 40 | 48;
+    prefixIconFill?: boolean;
+    suffixIconFill?: boolean;
+    suffixIconName?: "visibility" | "visibility_off" | "lock";
+    suffixIconSize?: 20 | 24 | 40 | 48;
+    containerClassName?: string;
+    prefixIconClassName?: string;
+    loading?: boolean;
+    hasError?: boolean;
+};
+
+declare const InputField: ForwardRefRenderFunction<HTMLInputElement, InputFieldProps>;
+declare const Input: React$1.ForwardRefExoticComponent<Omit<React$1.InputHTMLAttributes<HTMLInputElement>, "size"> & {
+    state?: "default" | "error" | "filled" | "active" | "focus" | "hover" | undefined;
+    size?: "medium" | "large" | "slim" | undefined;
+    label?: string | undefined;
+    errorText?: string | undefined;
+    prefixIconName?: "search" | "location_on" | undefined;
+    prefixIconSize?: 24 | 20 | 40 | 48 | undefined;
+    prefixIconFill?: boolean | undefined;
+    suffixIconFill?: boolean | undefined;
+    suffixIconName?: "visibility" | "lock" | "visibility_off" | undefined;
+    suffixIconSize?: 24 | 20 | 40 | 48 | undefined;
+    containerClassName?: string | undefined;
+    prefixIconClassName?: string | undefined;
+    loading?: boolean | undefined;
+    hasError?: boolean | undefined;
+} & React$1.RefAttributes<HTMLInputElement>>;
+
+interface LinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
+    /** Content to render inside the link */
+    children: ReactNode;
+    /** URL to navigate to */
+    href?: string;
+    /** Custom className for the link */
+    className?: string;
+    /** Click handler function */
+    onClick?: (event: MouseEvent<HTMLAnchorElement>) => void;
+    /** Additional styling options */
+    variant?: "default" | "unstyled";
+    /** Custom styles */
+    style?: CSSProperties;
+    /** External link behavior - opens in new tab */
+    external?: boolean;
+    /** Disable the link */
+    disabled?: boolean;
+}
+
+declare const Link: React__default.ForwardRefExoticComponent<LinkProps & React__default.RefAttributes<HTMLAnchorElement>>;
+
+type ListType = "ul" | "ol";
+type ListVariant = "default" | "unstyled";
+type ListItem$1 = {
+    id: string | number;
+    content: ReactNode;
+    className?: string;
+    [key: string]: any;
+};
+interface ListProps extends Omit<HTMLAttributes<HTMLUListElement | HTMLOListElement>, "type"> {
+    /** List type - unordered (ul) or ordered (ol) */
+    type?: ListType;
+    /** Array of items to render */
+    items?: ListItem$1[];
+    /** Custom className for the list */
+    className?: string;
+    /** Custom item renderer function */
+    renderItem?: (item: ListItem$1, index: number) => ReactNode;
+    /** Children to render instead of items */
+    children?: ReactNode;
+    /** Additional styling options */
+    variant?: ListVariant;
+    /** Custom styles */
+    style?: CSSProperties;
+}
+
+interface ListItemProps extends LiHTMLAttributes<HTMLLIElement> {
+    /** Content to render inside the list item */
+    children: ReactNode;
+    /** Custom className for the list item */
+    className?: string;
+    /** Additional styling options */
+    variant?: ListVariant;
+    /** Custom styles */
+    style?: CSSProperties;
+}
+
+declare const ListItem: React$1.ForwardRefExoticComponent<ListItemProps & React$1.RefAttributes<HTMLLIElement>>;
+
+declare const List: React__default.ForwardRefExoticComponent<ListProps & React__default.RefAttributes<HTMLUListElement | HTMLOListElement>>;
+
+declare const iconNameList: readonly ["info", "download", "featured_seasonal_and_gifts", "visibility", "paid", "check_box", "check_box_outline_blank", "radio_button_unchecked", "radio_button_checked", "counter_1", "counter_2", "counter_3", "error", "search", "cancel", "router", "broadcast_on_home", "check", "check_circle", "lock", "shield_lock", "phone_in_talk", "call", "chevron_left", "chevron_right", "keyboard_arrow_down", "keyboard_arrow_up", "arrow_back", "arrow_forward", "help", "home_pin", "location_on", "timer", "schedule", "add", "remove", "bolt", "rocket", "cloud_sync", "close", "groups", "speed", "mail", "credit_card", "language", "forum", "contract", "local_atm", "headset_mic", "sensors", "wifi", "settings", "home", "devices", "build", "thumb_up", "desktop_windows", "block", "all_inclusive", "verified_user", "extension", "stadia_controller", "visibility_off", "close_fullscreen", "progress_activity", "travel_explore", "share", "business_center", "upload", "videocam", "expand_circle_right", "add_circle", "do_not_disturb_on", "expand_circle_up", "expand_circle_down", "replay", "fiber_manual_record", "menu", "dangerous"];
+declare const OpticalSizes: readonly ["20dp", "24dp", "40dp", "48dp"];
+declare const weights: readonly ["100", "200", "300", "400", "500", "600", "700"];
+declare const emphasis: readonly [-25, 0, 200];
+declare const sizes: readonly [20, 24, 32, 40, 48, 52];
+
+type Fill = 1 | 0;
+type IconName = (typeof iconNameList)[number];
+type OpticalSize = (typeof OpticalSizes)[number];
+type Weight = (typeof weights)[number];
+type Emphasis = (typeof emphasis)[number];
+type Size$1 = (typeof sizes)[number];
+type IconProps = {
+    name: IconName;
+    fill?: Fill;
+    opticalSize?: OpticalSize;
+    weight?: Weight;
+    emphasis?: Emphasis;
+    size?: Size$1;
+    color?: string;
+    style?: CSSProperties;
+    className?: string;
+    onClick?: () => void;
+    dataTestId?: string;
+};
+
+declare const MaterialIcon: React__default.FC<IconProps>;
+
+type SpinnerProps = {
+    size?: "small" | "medium" | "large" | "xlarge";
+    color?: string;
+    className?: string;
+} & React.HTMLAttributes<HTMLDivElement>;
+
+declare const Spinner: React__default.FunctionComponent<SpinnerProps>;
+
+type TextVariant = "heading1" | "heading2" | "heading3" | "heading4" | "heading5" | "heading6" | "subheading1" | "subheading2" | "subheading3" | "subheading4" | "subheading5" | "subheading6" | "body1" | "body2" | "body3" | "footnote" | "micro" | "label1" | "label2" | "label3" | "label4" | "error" | "unstyled";
+interface TextProps extends HTMLAttributes<HTMLElement> {
+    /** Content to render inside the text element */
+    children?: ReactNode;
+    /** Custom HTML element to render as */
+    as?: keyof React$1.JSX.IntrinsicElements;
+    /** Custom className for the text */
+    className?: string;
+    /** Custom styles */
+    style?: CSSProperties;
+}
+
+declare const Text: React__default.ForwardRefExoticComponent<TextProps & React__default.RefAttributes<HTMLElement>>;
+
+declare const CallButton: {
+    (props: CallButtonProps): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+type Size = "xl" | "lg" | "md" | "sm" | "xs";
+type Shape = "rounded" | "default";
+type Animation = "popper" | "bottomSheet";
+type OwnProps$2 = {
+    size?: Size;
+    shape?: Shape;
+    title?: string;
+    bodyClassName?: string | null | undefined;
+    closeWrapperClassName?: string | null | undefined;
+    closeButtonClassName?: string | null | undefined;
+    bodyStyle?: React.CSSProperties;
+    centered?: boolean;
+    hideScrollOnIsOpenFalse?: boolean;
+    parentSelector?: string;
+    animation?: Animation;
+    hideCloseButton?: boolean;
+    ["data-testid"]?: string;
+    ["data-cy"]?: string;
+};
+type ModalProps = OwnProps$2 & Props;
+
+declare const Modal: React__default.FC<ModalProps>;
+
+declare const Accordion: React.FC<AccordionProps>;
+
+type InfoIconProps = {
+    onClick?: () => void;
+    dataTestId?: string;
+};
+type CheckboxProps = {
+    checked?: boolean;
+    onChange?: ((isChecked: boolean) => void) | (() => void);
+    state?: "default" | "focus" | "disabled";
+    className?: string;
+    containerClassName?: string;
+    label?: string | ReactNode;
+    labelClassName?: string;
+    name?: string;
+    value?: string | number | boolean;
+    id?: string;
+    disabled?: boolean;
+    required?: boolean;
+    error?: boolean;
+    "data-cy"?: string;
+    renderInfoIcon?: InfoIconProps;
+} & Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'checked' | 'onChange'>;
+
+declare const Checkbox: React__default.FC<CheckboxProps>;
+
+interface SelectOption<T = any> {
+    label: string;
+    value: string;
+    data?: T;
+}
+type FilterOptions = {
+    ignoreCase?: boolean;
+    ignoreAccents?: boolean;
+    trim?: boolean;
+    matchFrom?: "start" | "any";
+};
+type OwnProps$1 = {
+    options: SelectOption[];
+    value?: SelectOption;
+    className?: string;
+    isCustomStyle?: boolean;
+    controlClassName?: string;
+    filterOptions?: FilterOptions;
+    hasError?: boolean;
+    error?: string;
+    helperText?: string;
+    label?: string;
+    labelClassName?: string;
+    size?: "sm" | "md";
+    variant?: "default" | "unstyled";
+    "data-cy"?: string;
+    "data-testid"?: string;
+};
+type SelectProps = OwnProps$1 & Omit<Props$1<SelectOption>, "options" | "value" | "className">;
+
+declare const Select: React__default.FC<SelectProps>;
+
+type AlertCardProps = {
+    errorMessage?: string | ReactNode;
+    className?: string;
+    textVariant?: TextVariant$1;
+};
+
+declare const AlertCard: React__default.FC<AlertCardProps>;
+
+type ButtonVariantsT = "primary_brand" | "primary_inverse" | "secondary";
+type ButtonSizeT = "small" | "medium" | "large" | "x-large";
+type ResponsiveSize = {
+    base?: ButtonSizeT;
+    md?: ButtonSizeT;
+    lg?: ButtonSizeT;
+};
+type ButtonCustomProps = {
+    /** Button styling variant */
+    variant?: ButtonVariantsT;
+    /** Loading state - shows spinner and disables button */
+    isLoading?: boolean;
+    label?: string;
+    text?: string;
+    fullWidth?: boolean;
+    size?: ResponsiveSize;
+};
+type ButtonProps = ButtonCustomProps & Omit<ButtonHTMLAttributes<HTMLButtonElement>, "children" | "className">;
+
+declare const BrandButton: React$1.ForwardRefExoticComponent<_shared_components_brand_button_types.ButtonCustomProps & Omit<React$1.ButtonHTMLAttributes<HTMLButtonElement>, "children" | "className"> & React$1.RefAttributes<HTMLButtonElement>>;
+
+declare const Checklist: React__default.FC<ChecklistProps>;
+
+type CollapsibleProps = {
+    open: boolean;
+    children: React__default.ReactNode;
+};
+
+declare const Collapse: {
+    (props: CollapsibleProps): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+
+type DividerProps = {
+    className?: string;
+} & React.HTMLAttributes<HTMLDivElement>;
+
+declare const Divider: React__default.FC<DividerProps>;
+
+type OwnProps = {
+    name: string;
+    value?: string | number;
+    checked?: boolean;
+    onChange?: (newVal?: string | number) => void;
+    label?: string | ReactNode;
+    subText?: string;
+    className?: string;
+    labelProps?: LabelHTMLAttributes<HTMLLabelElement>;
+    variant?: "circle";
+    hasError?: boolean;
+    "data-cy"?: string;
+    labelClassName?: string;
+};
+type RadioButtonProps = OwnProps & Omit<InputHTMLAttributes<HTMLInputElement>, "onChange" | "value" | "name" | "checked">;
+
+declare const RadioButton: React__default.FC<RadioButtonProps>;
+
+declare const SeeMore: React.FC<SeeMoreProps>;
+
+type SelectPlanButtonProps = {
+    onSelect: () => void;
+    speed: string;
+};
+
+declare const SelectPlanButton: React.FC<SelectPlanButtonProps>;
+
+type SkeletonProps = {
+    className?: string;
+    count?: number;
+};
+
+declare const Skeleton: FC<SkeletonProps>;
+
+declare const PageSkeleton: FC;
+
+type ToolTipProps = {
+    tooltipMsg: string;
+    children: ReactNode;
+    className?: string;
+};
+
+declare function Tooltip({ tooltipMsg, className, children, }: ToolTipProps): react_jsx_runtime.JSX.Element;
+declare namespace Tooltip {
+    var displayName: string;
+}
+
+type ViewCartButtonProps = {
+    cartTotalText: string;
+    onClick: () => void;
+    isOpen: boolean;
+} & React.ButtonHTMLAttributes<HTMLButtonElement>;
+
+declare const ViewCartButton: React.FC<ViewCartButtonProps>;
+
+/**
+ * A custom hook that locks the body scroll based on the `isOpen` and `hideScrollOnIsOpenFalse` flags.
+ *
+ * @param {boolean} isOpen - Determines if the scroll should be locked (hidden).
+ * @param {boolean} hideScrollOnIsOpenFalse - Determines if the scroll should be reset when `isOpen` is false.
+ */
+declare function useBodyScrollLock(isOpen: boolean, hideScrollOnIsOpenFalse: boolean): void;
+
+/**
+ * Utility function to combine class names using clsx
+ * @param inputs - Class values to combine
+ * @returns Combined class string
+ */
+declare const cx: (...val: ClassValue[]) => string;
+
+export { Accordion, AlertCard, BrandButton, Button, CallButton, Checkbox, Checklist, Collapse, Divider, Input, InputField, Link, List, ListItem, MaterialIcon, Modal, PageSkeleton, RadioButton, SeeMore, Select, SelectPlanButton, Skeleton, Spinner, Text, Input as TextInput, Tooltip, ViewCartButton, cx, useBodyScrollLock };
+export type { AlertCardProps, Animation, ButtonProps as BrandButtonProps, ButtonSizeT, ButtonVariantsT, CheckboxProps, CollapsibleProps, DividerProps, FilterOptions, IconName, IconProps, InputFieldProps, InputProps, LinkProps, ListItemProps, ListProps, ModalProps, RadioButtonProps, ResponsiveSize, SelectOption, SelectPlanButtonProps, SelectProps, Shape, Size, SkeletonProps, SpinnerProps, TextProps, TextVariant, ToolTipProps, ViewCartButtonProps };