@nuskin/foundation-ui-components 3.0.0-fixpackage.1 → 3.0.0

package/dist/index.d.ts

@@ -2,10 +2,13 @@ import * as react from 'react';
 import react__default, { ReactElement, HTMLProps, PropsWithChildren, ReactNode, SyntheticEvent, HTMLAttributes } from 'react';
 import { FoundationTheme } from '@nuskin/foundation-theme';
 import * as _mui_material from '@mui/material';
-import { SvgIconProps, AutocompleteChangeReason, AutocompleteChangeDetails, ComponentsProps, ButtonProps, TextFieldProps, InputLabelProps, RadioGroupProps } from '@mui/material';
+import { SvgIconProps as SvgIconProps$1, AutocompleteChangeReason, AutocompleteChangeDetails, ComponentsProps, ButtonProps, TextFieldProps, InputLabelProps, RadioGroupProps } from '@mui/material';
+import { SvgIconProps } from '@mui/material/SvgIcon';
 import * as _emotion_styled from '@emotion/styled';
 import * as _emotion_react from '@emotion/react';
 import * as _mui_material_OverridableComponent from '@mui/material/OverridableComponent';
+import * as _mui_material_Card from '@mui/material/Card';
+import * as _mui_material_CardMedia from '@mui/material/CardMedia';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { CheckboxProps } from '@material-ui/core/Checkbox';
 import { React as React$1 } from 'React';
@@ -147,7 +150,7 @@ declare const IconVariants: {
     chevronRight: (props: _mui_material.SvgIconProps) => react.ReactElement;
 };
 
-declare const Check: (props: SvgIconProps) => ReactElement;
+declare const Check: (props: SvgIconProps$1) => ReactElement;
 
 declare const iconSize: Record<NsIconSizeType, string>;
 type IconWrapperType = {
@@ -467,6 +470,10 @@ type NsBrandComponentProps = {
     variant?: 'stacked' | 'horizontal' | 'poweredBy' | 'logomark' | 'wordmark';
     size?: string;
     color?: FoundationTheme.PaletteColors;
+    /** When set (valid non-empty string), renders this SVG URL instead of the variant logo. Variant and color are ignored. */
+    logoUrl?: string;
+    /** Alt text for the logo image when logoUrl is used. Defaults to "Logo". */
+    logoAlt?: string;
 };
 
 declare const NsBrandComponent: (props: PropsWithChildren<NsBrandComponentProps>) => ReactElement;
@@ -522,13 +529,13 @@ declare function NsBrandWrapper({ children }: PropsWithChildren): ReactElement;
 type NsBgCardProps = {
     backgroundImageUrl: string;
 };
-declare const NsBgCard: _emotion_styled.StyledComponent<_mui_material.CardOwnProps & _mui_material_OverridableComponent.CommonProps & Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+declare const NsBgCard: _emotion_styled.StyledComponent<_mui_material_Card.CardOwnProps & _mui_material_OverridableComponent.CommonProps & Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
     ref?: ((instance: HTMLDivElement | null) => void | react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | react.RefObject<HTMLDivElement> | null | undefined;
 }, "variant" | "style" | "children" | "className" | "classes" | "sx" | "elevation" | "square" | "raised"> & {
     theme?: _emotion_react.Theme;
 } & NsBgCardProps, {}, {}>;
 
-declare const NsBrandLogo: _emotion_styled.StyledComponent<_mui_material.CardMediaOwnProps & _mui_material_OverridableComponent.CommonProps & Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+declare const NsBrandLogo: _emotion_styled.StyledComponent<_mui_material_CardMedia.CardMediaOwnProps & _mui_material_OverridableComponent.CommonProps & Omit<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
     ref?: ((instance: HTMLDivElement | null) => void | react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof react.DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | react.RefObject<HTMLDivElement> | null | undefined;
 }, "style" | "image" | "children" | "className" | "classes" | "sx" | "src"> & {
     theme?: _emotion_react.Theme;
@@ -674,19 +681,36 @@ type NsAwardCardProps = {
 };
 declare function NsAwardCard({ title, awardName, mediaOutlet, backgroundImageDetail, className, fontColor, }: NsAwardCardProps): ReactElement;
 
-interface CarousalProps<T = any> {
+type NsCarouselProps<T = any> = {
     entries: T[];
+    // eslint-disable-next-line no-unused-vars
     renderEntry(entry: T, index: number): ReactNode;
     allEntryLink?: string;
     allEntryLabel?: string;
     settings: any;
     showControlButtons?: boolean;
-}
-declare function NsCarousal({ entries, renderEntry, allEntryLink, settings, allEntryLabel, showControlButtons, }: CarousalProps): ReactElement;
+    ariaLabel?: string;
+    ariaLabelledBy?: string;
+};
+
+type NsScrollingCarouselProps<T = any> = {
+    slides: T;
+    // eslint-disable-next-line no-unused-vars
+    renderSlide(slide: T, index: number): ReactNode;
+    /* time it takes while scrolling */
+    scrollSeconds: number;
+    /* time for which slide stays still before scrolling */
+    stillSeconds: number;
+    settings: any;
+    /* value in number, specifying how much the dots should be from bottom of slides container */
+    dotsBottomPixel?: number;
+} & AdditionalProps;
 
-declare const NsScrollingCarousal: ({ slides, scrollSeconds, stillSeconds, renderSlide, settings, dotsBottomPixel, additionalProps, }: NsScrollingCarousalProps) => ReactElement;
+declare function NsCarousel<T = any>({ entries, renderEntry, allEntryLink, settings, allEntryLabel, showControlButtons, ariaLabel, ariaLabelledBy, }: NsCarouselProps<T>): ReactElement;
 
-declare const settings: {
+declare const NsScrollingCarousel: ({ slides, scrollSeconds, stillSeconds, renderSlide, settings, dotsBottomPixel, additionalProps, }: NsScrollingCarouselProps) => ReactElement;
+
+declare const defaultCarouselSettings: {
     dots: boolean;
     infinite: boolean;
     speed: number;
@@ -723,26 +747,16 @@ declare const settings: {
     })[];
 };
 
-type NsCarousalProps<T = any> = {
-    entries: T[];
-    // eslint-disable-next-line no-unused-vars
-    renderEntry(entry: T, index: number): ReactNode;
-    allEntryLink: string;
-    settings: any;
-};
-
-type NsScrollingCarousalProps<T = any> = {
-    slides: T;
-    // eslint-disable-next-line no-unused-vars
-    renderSlide(slide: T, index: number): ReactNode;
-    /* time it takes while scrolling */
-    scrollSeconds: number;
-    /* time for which slide stays still before scrolling */
-    stillSeconds: number;
-    settings: any;
-    /* value in number, specifying how much the dots should be from bottom of slides container */
-    dotsBottomPixel?: number;
-} & AdditionalProps;
+interface CarouselControlProps {
+    next(): void;
+    prev(): void;
+    viewAllLabel: string;
+    viewAllUrl: string;
+    showNavigationButtons?: boolean;
+    prevAriaLabel?: string;
+    nextAriaLabel?: string;
+}
+declare const CarouselControl: ({ next, prev, viewAllUrl, viewAllLabel, showNavigationButtons, prevAriaLabel, nextAriaLabel, }: CarouselControlProps) => ReactElement;
 
 type NsCartIconProps = {
     itemCount?: number;
@@ -1242,4 +1256,4 @@ type NsVideoProps = {
 
 declare const NsVideo: (props: PropsWithChildren<NsVideoProps>) => ReactElement;
 
-export { type AccordionContentType, AccordionContentTypeObject, type AccordionItem, AccordionVariant, type AccordionVariantType, type AdditionalProps, type BynderImageDataType, Check, type ComponentBoxProps, type CslpTag, type DarkModeEnabledOption, type DropdownOptionProps, type DropdownProps, GlobalFontInter, type HtmlTagVariant, HtmlTagVariantMapping, IconWrapper, type ItemProps, type LabelValueType, LineLoader, type ListUiProps, type NavTabs, NsAccordion, NsAccordionHeader, type NsAccordionHeaderProps, NsAccordionItem, type NsAccordionItemProps, type NsAccordionProps, NsAlert, type NsAlertProps, NsAuthDropdown, type NsAuthDropdownProps, NsAutocomplete, type NsAutocompleteProps, NsAwardCard, NsBanner, type NsBannerProps, NsBgCard, NsBrandCard, NsBrandComponent, type NsBrandComponentProps, NsBrandLogo, NsBrandWrapper, NsBreadcrumb, type NsBreadcrumbProps, NsButton, type NsButtonProps, type NsCardButton, NsCarousal, type NsCarousalProps, NsCartIcon, type NsCartIconProps, NsCheckbox, type NsCheckboxProps, NsCheckoutCard, NsCollapse, type NsCollapseProps, NsColumnControl, type NsColumnControlProps, settings as NsDefaultCarousalSettings, NsDropdown, NsDropdownOption, NsEmailSimple, type NsEmailSimpleProps, type NsFfgCardProps, NsFlag, type NsFlagProps, type NsFlagSize, NsFlexColumns, NsGridColumns, NsHeroCardLevel1, NsHeroCardLevel2, NsIcon, type NsIconNameType, type NsIconProps, type NsIconSizeType, NsIconText, IconVariants as NsIconVariants, NsImage, NsInputField, type NsInputFieldProps, NsLabel, type NsLabelProps, NsLargeCard, NsLink, type NsLinkProps, NsMediumCard, NsModal, type NsModalProps, type NsModalVariant, NsNavProductCard, type NsNavProductCardProps, NsNavTabComponent as NsNavTab, type NsNavTabComponentProps, NsPost, NsProgress, type NsProgressProps, NsRadioGroup, type NsRadioGroupProps, NsScrollingCarousal, type NsScrollingCarousalProps, NsSelect, NsSelectOption, NsSmallFullCard, NsSpinner, type NsSpinnerProps, NsTable, type NsTableProps, NsTextStrip, type NsTextStripProps, NsToastProvider, NsToggleSection, type NsToggleSectionProps, NsTypography, type NsTypographyProps, NsVideo, type NsVideoProps, NsXLargeCard, type OptionsProps, type RenderSelectOptionArgType, type SelectOptionProps, type SelectProps, Show, type Themed, type ToastOptions, type Variants, getBasicDATWidthHeight, iconSize, useAccordionMap, useToast, useWindowSize };
+export { type AccordionContentType, AccordionContentTypeObject, type AccordionItem, AccordionVariant, type AccordionVariantType, type AdditionalProps, type BynderImageDataType, Check, type ComponentBoxProps, type CslpTag, type DarkModeEnabledOption, type DropdownOptionProps, type DropdownProps, GlobalFontInter, type HtmlTagVariant, HtmlTagVariantMapping, IconWrapper, type ItemProps, type LabelValueType, LineLoader, type ListUiProps, type NavTabs, NsAccordion, NsAccordionHeader, type NsAccordionHeaderProps, NsAccordionItem, type NsAccordionItemProps, type NsAccordionProps, NsAlert, type NsAlertProps, NsAuthDropdown, type NsAuthDropdownProps, NsAutocomplete, type NsAutocompleteProps, NsAwardCard, NsBanner, type NsBannerProps, NsBgCard, NsBrandCard, NsBrandComponent, type NsBrandComponentProps, NsBrandLogo, NsBrandWrapper, NsBreadcrumb, type NsBreadcrumbProps, NsButton, type NsButtonProps, type NsCardButton, NsCarousel, CarouselControl as NsCarouselControl, type NsCarouselProps, NsCartIcon, type NsCartIconProps, NsCheckbox, type NsCheckboxProps, NsCheckoutCard, NsCollapse, type NsCollapseProps, NsColumnControl, type NsColumnControlProps, defaultCarouselSettings as NsDefaultCarouselSettings, NsDropdown, NsDropdownOption, NsEmailSimple, type NsEmailSimpleProps, type NsFfgCardProps, NsFlag, type NsFlagProps, type NsFlagSize, NsFlexColumns, NsGridColumns, NsHeroCardLevel1, NsHeroCardLevel2, NsIcon, type NsIconNameType, type NsIconProps, type NsIconSizeType, NsIconText, IconVariants as NsIconVariants, NsImage, NsInputField, type NsInputFieldProps, NsLabel, type NsLabelProps, NsLargeCard, NsLink, type NsLinkProps, NsMediumCard, NsModal, type NsModalProps, type NsModalVariant, NsNavProductCard, type NsNavProductCardProps, NsNavTabComponent as NsNavTab, type NsNavTabComponentProps, NsPost, NsProgress, type NsProgressProps, NsRadioGroup, type NsRadioGroupProps, NsScrollingCarousel, type NsScrollingCarouselProps, NsSelect, NsSelectOption, NsSmallFullCard, NsSpinner, type NsSpinnerProps, NsTable, type NsTableProps, NsTextStrip, type NsTextStripProps, NsToastProvider, NsToggleSection, type NsToggleSectionProps, NsTypography, type NsTypographyProps, NsVideo, type NsVideoProps, NsXLargeCard, type OptionsProps, type RenderSelectOptionArgType, type SelectOptionProps, type SelectProps, Show, type Themed, type ToastOptions, type Variants, getBasicDATWidthHeight, iconSize, useAccordionMap, useToast, useWindowSize };