@windstream/react-shared-components 0.0.18 → 0.0.20

package/dist/core.d.ts

@@ -1,8 +1,9 @@
 import * as React$1 from 'react';
-import React__default, { InputHTMLAttributes, ReactNode, ForwardRefRenderFunction, AnchorHTMLAttributes, MouseEvent, CSSProperties, HTMLAttributes, LiHTMLAttributes, ButtonHTMLAttributes, LabelHTMLAttributes, FC } from 'react';
+import React__default, { InputHTMLAttributes, ReactNode, ForwardRefRenderFunction, ImgHTMLAttributes, ComponentType, 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 { ImageProps as ImageProps$1 } from '@shared/components/image/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';
@@ -55,15 +56,15 @@ type InputFieldProps = Omit<InputHTMLAttributes<HTMLInputElement>, "size"> & {
 
 declare const InputField: ForwardRefRenderFunction<HTMLInputElement, InputFieldProps>;
 declare const Input: React$1.ForwardRefExoticComponent<Omit<React$1.InputHTMLAttributes<HTMLInputElement>, "size"> & {
-    state?: "default" | "focus" | "active" | "hover" | "filled" | "error" | undefined;
-    size?: "slim" | "medium" | "large" | undefined;
+    state?: "error" | "default" | "filled" | "active" | "focus" | "hover" | undefined;
+    size?: "medium" | "large" | "slim" | undefined;
     label?: string | undefined;
     errorText?: string | undefined;
-    prefixIconName?: "location_on" | "search" | undefined;
+    prefixIconName?: "search" | "location_on" | undefined;
     prefixIconSize?: 20 | 24 | 40 | 48 | undefined;
     prefixIconFill?: boolean | undefined;
     suffixIconFill?: boolean | undefined;
-    suffixIconName?: "visibility" | "visibility_off" | "lock" | undefined;
+    suffixIconName?: "visibility" | "lock" | "visibility_off" | undefined;
     suffixIconSize?: 20 | 24 | 40 | 48 | undefined;
     containerClassName?: string | undefined;
     prefixIconClassName?: string | undefined;
@@ -71,6 +72,33 @@ declare const Input: React$1.ForwardRefExoticComponent<Omit<React$1.InputHTMLAtt
     hasError?: boolean | undefined;
 } & React$1.RefAttributes<HTMLInputElement>>;
 
+/**
+ * Props passed to the custom image component when using the `as` prop.
+ * Covers native img attributes plus optional Next.js Image props (fill, sizes, priority, etc.).
+ */
+interface ImageComponentProps extends Omit<ImgHTMLAttributes<HTMLImageElement>, "alt"> {
+    /** Image source URL */
+    src: string;
+    /** Alt text (required for accessibility; use "" for decorative images) */
+    alt: string;
+    /** Optional; used by Next.js Image when using fill layout */
+    fill?: boolean;
+    /** Optional; used by Next.js Image for responsive sizes */
+    sizes?: string;
+    /** Optional; used by Next.js Image for priority loading */
+    priority?: boolean;
+    /** Optional; used by Next.js Image for blur placeholder */
+    placeholder?: "blur" | "empty";
+    /** Optional; used by Next.js Image for quality (1–100) */
+    quality?: number;
+}
+interface ImageProps extends ImageComponentProps {
+    /** Custom component to render instead of native img (e.g. next/image) */
+    as?: ComponentType<ImageComponentProps>;
+}
+
+declare const Image: React$1.ForwardRefExoticComponent<ImageProps$1 & React$1.RefAttributes<HTMLImageElement>>;
+
 interface LinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
     /** Content to render inside the link */
     children: ReactNode;
@@ -232,7 +260,7 @@ type CheckboxProps = {
     error?: boolean;
     "data-cy"?: string;
     renderInfoIcon?: InfoIconProps;
-} & Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'checked' | 'onChange'>;
+} & Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "checked" | "onChange">;
 
 declare const Checkbox: React__default.FC<CheckboxProps>;
 
@@ -295,7 +323,7 @@ type ButtonCustomProps = {
 };
 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>, "className" | "children"> & React$1.RefAttributes<HTMLButtonElement>>;
+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>;
 
@@ -357,7 +385,7 @@ type ToolTipProps = {
     className?: string;
 };
 
-declare function Tooltip({ tooltipMsg, className, children, }: ToolTipProps): react_jsx_runtime.JSX.Element;
+declare function Tooltip({ tooltipMsg, className, children }: ToolTipProps): react_jsx_runtime.JSX.Element;
 declare namespace Tooltip {
     var displayName: string;
 }
@@ -385,5 +413,5 @@ declare function useBodyScrollLock(isOpen: boolean, hideScrollOnIsOpenFalse: boo
  */
 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 };
+export { Accordion, AlertCard, BrandButton, Button, CallButton, Checkbox, Checklist, Collapse, Divider, Image, 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, ImageComponentProps, ImageProps, InputFieldProps, InputProps, LinkProps, ListItemProps, ListProps, ModalProps, RadioButtonProps, ResponsiveSize, SelectOption, SelectPlanButtonProps, SelectProps, Shape, Size, SkeletonProps, SpinnerProps, TextProps, TextVariant, ToolTipProps, ViewCartButtonProps };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import * as React$1 from 'react';
-import React__default, { InputHTMLAttributes, ReactNode, ForwardRefRenderFunction, AnchorHTMLAttributes, MouseEvent, CSSProperties, HTMLAttributes, LiHTMLAttributes, ButtonHTMLAttributes, LabelHTMLAttributes, FC } from 'react';
+import React__default, { InputHTMLAttributes, ReactNode, ForwardRefRenderFunction, ImgHTMLAttributes, ComponentType, 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 { ImageProps as ImageProps$1 } from '@shared/components/image/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';
@@ -59,7 +60,7 @@ declare const Input: React$1.ForwardRefExoticComponent<Omit<React$1.InputHTMLAtt
     size?: "slim" | "medium" | "large" | undefined;
     label?: string | undefined;
     errorText?: string | undefined;
-    prefixIconName?: "search" | "location_on" | undefined;
+    prefixIconName?: "location_on" | "search" | undefined;
     prefixIconSize?: 20 | 24 | 40 | 48 | undefined;
     prefixIconFill?: boolean | undefined;
     suffixIconFill?: boolean | undefined;
@@ -71,6 +72,33 @@ declare const Input: React$1.ForwardRefExoticComponent<Omit<React$1.InputHTMLAtt
     hasError?: boolean | undefined;
 } & React$1.RefAttributes<HTMLInputElement>>;
 
+/**
+ * Props passed to the custom image component when using the `as` prop.
+ * Covers native img attributes plus optional Next.js Image props (fill, sizes, priority, etc.).
+ */
+interface ImageComponentProps extends Omit<ImgHTMLAttributes<HTMLImageElement>, "alt"> {
+    /** Image source URL */
+    src: string;
+    /** Alt text (required for accessibility; use "" for decorative images) */
+    alt: string;
+    /** Optional; used by Next.js Image when using fill layout */
+    fill?: boolean;
+    /** Optional; used by Next.js Image for responsive sizes */
+    sizes?: string;
+    /** Optional; used by Next.js Image for priority loading */
+    priority?: boolean;
+    /** Optional; used by Next.js Image for blur placeholder */
+    placeholder?: "blur" | "empty";
+    /** Optional; used by Next.js Image for quality (1–100) */
+    quality?: number;
+}
+interface ImageProps extends ImageComponentProps {
+    /** Custom component to render instead of native img (e.g. next/image) */
+    as?: ComponentType<ImageComponentProps>;
+}
+
+declare const Image: React$1.ForwardRefExoticComponent<ImageProps$1 & React$1.RefAttributes<HTMLImageElement>>;
+
 interface LinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
     /** Content to render inside the link */
     children: ReactNode;
@@ -232,7 +260,7 @@ type CheckboxProps = {
     error?: boolean;
     "data-cy"?: string;
     renderInfoIcon?: InfoIconProps;
-} & Omit<InputHTMLAttributes<HTMLInputElement>, 'type' | 'checked' | 'onChange'>;
+} & Omit<InputHTMLAttributes<HTMLInputElement>, "type" | "checked" | "onChange">;
 
 declare const Checkbox: React__default.FC<CheckboxProps>;
 
@@ -295,7 +323,7 @@ type ButtonCustomProps = {
 };
 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 BrandButton: React$1.ForwardRefExoticComponent<_shared_components_brand_button_types.ButtonCustomProps & Omit<React$1.ButtonHTMLAttributes<HTMLButtonElement>, "className" | "children"> & React$1.RefAttributes<HTMLButtonElement>>;
 
 declare const Checklist: React__default.FC<ChecklistProps>;
 
@@ -357,7 +385,7 @@ type ToolTipProps = {
     className?: string;
 };
 
-declare function Tooltip({ tooltipMsg, className, children, }: ToolTipProps): react_jsx_runtime.JSX.Element;
+declare function Tooltip({ tooltipMsg, className, children }: ToolTipProps): react_jsx_runtime.JSX.Element;
 declare namespace Tooltip {
     var displayName: string;
 }
@@ -385,5 +413,5 @@ declare function useBodyScrollLock(isOpen: boolean, hideScrollOnIsOpenFalse: boo
  */
 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 };
+export { Accordion, AlertCard, BrandButton, Button, CallButton, Checkbox, Checklist, Collapse, Divider, Image, 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, ImageComponentProps, ImageProps, InputFieldProps, InputProps, LinkProps, ListItemProps, ListProps, ModalProps, RadioButtonProps, ResponsiveSize, SelectOption, SelectPlanButtonProps, SelectProps, Shape, Size, SkeletonProps, SpinnerProps, TextProps, TextVariant, ToolTipProps, ViewCartButtonProps };