@nuskin/foundation-ui-components 1.0.0-develop.1 → 1.0.0-develop.11

package/src/common/modal/NsModal.tsx

@@ -0,0 +1,37 @@
+import React from 'react';
+import Dialog from '@mui/material/Dialog';
+import { useMediaQuery } from '@mui/material';
+import { useTheme } from '@mui/material/styles';
+import { ModalVariantMap } from './model/NsModalVariantMap';
+import { NsModalProps } from './types';
+
+const NsModal = (props: NsModalProps) => {
+    const { open, handleClose, header, body, additionalProps, footer, statusInfo, variant = 'default' } = props;
+
+    const { className, scrollType = 'paper', ariaLabel } = additionalProps || {};
+
+    const { ariaLabelledby = 'alert-dialog-title', ariaDescribedby = 'alert-dialog-description' } = ariaLabel || {};
+
+    const theme = useTheme();
+
+    const fullScreen: boolean = useMediaQuery(theme.breakpoints.down('md'));
+
+    const Component = ModalVariantMap[variant];
+
+    return (
+        <Dialog
+            data-testid="nsmodal-dialog"
+            fullScreen={fullScreen}
+            open={open}
+            scroll={scrollType}
+            onClose={handleClose}
+            aria-labelledby={ariaLabelledby}
+            aria-describedby={ariaDescribedby}
+            className={className}
+        >
+            <Component {...{ header, handleClose, body, footer, additionalProps, statusInfo, variant, open }} />
+        </Dialog>
+    );
+};
+
+export default NsModal;

package/src/common/modal/helper-component/NsModalContentBox.tsx

@@ -0,0 +1,32 @@
+import { useMemo } from 'react';
+import { DialogContent } from '@mui/material';
+import { NsModalComponentProps } from '../types';
+import NsModalTitle from './NsModalTitle';
+import { NsTypography } from '../..';
+
+const NsModalContentBox = ({ handleClose, statusInfo }: NsModalComponentProps) => {
+    const { title, description } = statusInfo || {};
+
+    const header = useMemo(() => {
+        return {
+            show: true,
+            children: (
+                <NsTypography variant="h5" weight="bold">
+                    {title}
+                </NsTypography>
+            ),
+            isCloseIcon: true,
+        };
+    }, [title]);
+
+    return (
+        <div>
+            <NsModalTitle header={header} handleClose={handleClose} />
+            <DialogContent>
+                <NsTypography variant="p-xs">{description}</NsTypography>
+            </DialogContent>
+        </div>
+    );
+};
+
+export default NsModalContentBox;

package/src/common/modal/helper-component/NsModalDefault.tsx

@@ -0,0 +1,25 @@
+import { DialogContent } from '@mui/material';
+import NsModalTitle from './NsModalTitle';
+import { NsModalComponentProps } from '../types';
+import { ModalFooter } from '../NsModal.styled';
+import { Show } from '../../utility';
+
+const NsDefaultModal = ({ header, handleClose, body, footer, additionalProps }: NsModalComponentProps) => {
+    const { dividers } = additionalProps || {};
+
+    return (
+        <div data-testid="modal-default">
+            <NsModalTitle header={header} handleClose={handleClose} />
+            <DialogContent dividers={dividers}>
+                <Show when={body?.show ?? false}>
+                    <div data-testid="modal-body-content">{body?.children}</div>
+                </Show>
+                <Show when={footer?.show ?? false}>
+                    <ModalFooter data-testid="modal-footer">{footer?.children}</ModalFooter>
+                </Show>
+            </DialogContent>
+        </div>
+    );
+};
+
+export default NsDefaultModal;

package/src/common/modal/helper-component/NsModalStatus.tsx

@@ -0,0 +1,15 @@
+import { NsInfoWrapper } from '../NsModal.styled';
+import { NsModalComponentProps } from '../types';
+import NsModalContentBox from './NsModalContentBox';
+import NsModalStatusIcon from './NsModalStatusIcon';
+
+const NsStatusModal = ({ handleClose, statusInfo, variant }: NsModalComponentProps) => {
+    return (
+        <NsInfoWrapper data-testid="modal-status">
+            <NsModalStatusIcon {...{ variant }} />
+            <NsModalContentBox {...{ handleClose, statusInfo }} />
+        </NsInfoWrapper>
+    );
+};
+
+export default NsStatusModal;

package/src/common/modal/helper-component/NsModalStatusIcon.tsx

@@ -0,0 +1,14 @@
+import { NsIcon, NsIconNameType } from '../../';
+import { StatusIconMap } from '../model/NsModalVariantMap';
+import { NsModalComponentProps, NsModalVariant } from '../types';
+
+const NsModalStatusIcon = ({ variant }: NsModalComponentProps) => {
+    const iconName = variant ? StatusIconMap[variant] : null;
+    return (
+        <div className="status-icon">
+            <NsIcon name={iconName as NsIconNameType} size="medium" color={variant as NsModalVariant} />
+        </div>
+    );
+};
+
+export default NsModalStatusIcon;

package/src/common/modal/helper-component/NsModalTitle.tsx

@@ -0,0 +1,26 @@
+import { NsIcon } from '../..';
+import { DialogTitle } from '@mui/material';
+import { CloseButton, NsInfoWrapper } from '../NsModal.styled';
+import { NsModalComponentProps } from '../types';
+import { Show } from '../../utility';
+
+const NsModalTitle = ({ header, handleClose }: NsModalComponentProps) => {
+    const { show, children, isCloseIcon, iconName } = header || {};
+    return (
+        <Show when={show}>
+            <DialogTitle data-testid="modal-title">
+                <NsInfoWrapper>
+                    {iconName ? <NsIcon name={iconName} className="title-icon" /> : null}
+                    {children}
+                </NsInfoWrapper>
+                <Show when={isCloseIcon}>
+                    <CloseButton aria-label="close" onClick={handleClose} data-testid="modal-close-button">
+                        <NsIcon name="close" size="small" />
+                    </CloseButton>
+                </Show>
+            </DialogTitle>
+        </Show>
+    );
+};
+
+export default NsModalTitle;

package/src/common/modal/index.ts

@@ -0,0 +1,2 @@
+export { default as NsModal } from './NsModal';
+export type { NsModalProps } from './types';

package/src/common/modal/model/NsModalVariantMap.tsx

@@ -0,0 +1,24 @@
+import { ElementType } from 'react';
+import NsDefaultModal from '../helper-component/NsModalDefault';
+import NsStatusModal from '../helper-component/NsModalStatus';
+import { StatusIconMapProps } from '../types';
+
+type ModalMapType = {
+    [key: string]: ElementType;
+};
+
+export const ModalVariantMap: ModalMapType = {
+    default: NsDefaultModal,
+    confirmation: NsDefaultModal,
+    success: NsStatusModal,
+    warning: NsStatusModal,
+    error: NsStatusModal,
+    info: NsStatusModal,
+};
+
+export const StatusIconMap: StatusIconMapProps = {
+    success: 'success',
+    warning: 'warning',
+    error: 'error',
+    info: 'infoFilled',
+};

package/src/common/modal/stories/NsModal.stories.tsx

@@ -0,0 +1,86 @@
+import type { StoryObj, Meta } from '@storybook/react';
+import { withCenterDecorator } from '@/stories/decorators/withCenterDecorator';
+import NsModal from '../NsModal';
+import { NsButton } from '../../button';
+import { Grid, Typography } from '@mui/material';
+import { useState } from 'react';
+import { NsModalProps } from '../types';
+import { NsModalData } from './mock';
+
+type ComponentType = typeof NsModal;
+type Story = StoryObj<ComponentType>;
+type MetaStory = Meta<ComponentType>;
+
+export default {
+    title: 'Components/NsModal',
+    component: NsModal,
+    decorators: [withCenterDecorator],
+    argTypes: {},
+    args: {
+        ...NsModalData,
+    },
+} as MetaStory;
+
+const RenderNsModal = (args: NsModalProps) => {
+    const [isOpen, setOpen] = useState(false);
+
+    const onModalHandler = () => {
+        setOpen(!isOpen);
+    };
+
+    return (
+        <>
+            <NsButton onClick={onModalHandler}>Open Modal</NsButton>
+            <NsModal {...args} open={isOpen} handleClose={onModalHandler} />
+        </>
+    );
+};
+
+export const Modal: Story = {
+    args: {
+        header: {
+            ...NsModalData?.header,
+            isCloseIcon: false,
+        },
+    } as NsModalProps,
+    render: RenderNsModal,
+};
+
+export const WithCloseIcon: Story = {
+    render: RenderNsModal,
+};
+
+export const ImageWidthText: Story = {
+    args: {
+        header: {
+            show: true,
+            isCloseIcon: true,
+        },
+        body: {
+            show: true,
+            children: (
+                <Grid container spacing={2}>
+                    <Grid xs={6}>
+                        <img
+                            src="https://www.nuskin.com/content/products/01/55/00/01550014/_jcr_content/fullImage.img.160.160.png.64.64.png"
+                            alt={'NsImage'}
+                        />
+                    </Grid>
+                    <Grid xs={6} className="p-5">
+                        <Typography gutterBottom variant="h5" component="div">
+                            Lizard
+                        </Typography>
+                        <Typography variant="body2" color="text.secondary">
+                            Lizards are a widespread group of squamate reptiles, with over 6,000 species, ranging across
+                            all continents except Antarctica
+                        </Typography>
+                    </Grid>
+                </Grid>
+            ),
+        },
+        footer: {
+            show: false,
+        },
+    },
+    render: RenderNsModal,
+};

package/src/common/modal/stories/mock.tsx

@@ -0,0 +1,46 @@
+import { NsButton } from '../../button';
+import { NsTypography } from '../../typography';
+
+export const NsModalData = {
+    open: true,
+    handleClose: () => {},
+    variant: 'default',
+    header: {
+        show: true,
+        children: (
+            <NsTypography variant="h4" weight="bold">
+                Dialog with hero icon
+            </NsTypography>
+        ),
+        isCloseIcon: true,
+        iconName: 'infoOutlined',
+    },
+    body: {
+        show: true,
+        children: (
+            <NsTypography variant="p-s">
+                Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquet sed odio donec tellus nibh dictum quis.
+                Dis tempus aliquam tristique auctor justo, lacus in pellentesque. Quam semper facilisi posuere hendrerit
+                scelerisque sed.
+            </NsTypography>
+        ),
+    },
+    statusInfo: {
+        title: 'Are you sure you want to delete your account?',
+        description: `Lorem ipsum dolor sit amet, consectetur adipiscing elit, 
+            sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.`,
+    },
+    footer: {
+        show: true,
+        children: (
+            <>
+                <NsButton onClick={() => {}} variant="outlined">
+                    Cancel
+                </NsButton>
+                <NsButton onClick={() => {}} variant="contained">
+                    Confirm
+                </NsButton>
+            </>
+        ),
+    },
+};

package/src/common/modal/types.ts

@@ -0,0 +1,56 @@
+import { ReactNode } from 'react';
+import { NsIconNameType } from '../icon';
+
+export interface DialogTitleProps {
+    id: string;
+    children?: ReactNode;
+    onClose: () => void;
+}
+
+export interface NsModalProps extends NsModalComponentProps {
+    open: boolean;
+}
+
+export interface NsModalComponentProps {
+    handleClose?: () => void;
+    additionalProps?: NsModalAdditionalProps;
+    variant?: NsModalVariant | 'default';
+    header?: NsModalContentProps;
+    body?: NsModalContentProps;
+    footer?: NsModalContentProps;
+    statusInfo?: NsModalStatusProps;
+}
+
+export interface NsModalContentProps {
+    show?: boolean;
+    children?: string | ReactNode;
+    isCloseIcon?: boolean;
+    iconName?: NsIconNameType;
+}
+
+export interface NsModalStatusProps {
+    title: string;
+    description: string;
+}
+
+export interface NsModalAdditionalProps {
+    className?: string;
+    scrollType?: 'paper' | 'body';
+    ariaLabel?: NsModalAriaLabelProps;
+    dividers?: boolean;
+}
+
+export interface NsModalAriaLabelProps {
+    ariaLabelledby?: string;
+    ariaDescribedby?: string;
+}
+
+export type NsModalVariant = 'success' | 'warning' | 'error' | 'info';
+
+export interface StatusIconMapProps {
+    success: string;
+    warning: string;
+    error: string;
+    info: string;
+    default?: string;
+}

package/src/common/nav-product-card/NsNavProductCard.spec.tsx

@@ -1,5 +1,5 @@
 import { NsNavProductCard } from '.';
-import { render } from '../../../test-utils';
+import { render } from '@/test-utils/index';
 
 const productImage = `
     https://media.nuskin.com/m/471880e8f6e689f4/Lumi-IO-normal-combo-cleansing-device-and-cleanser.png

package/src/common/nav-product-card/NsNavProductCard.stories.tsx

@@ -1,5 +1,5 @@
 import type { StoryObj, Meta } from '@storybook/react';
-import { withCenterDecorator } from '../../stories/decorators/withCenterDecorator';
+import { withCenterDecorator } from '@/stories/decorators/withCenterDecorator';
 import { NsNavProductCard } from './';
 
 type ComponentType = typeof NsNavProductCard;
@@ -7,7 +7,7 @@ type Story = StoryObj<ComponentType>;
 type MetaStory = Meta<ComponentType>;
 
 export default {
-    title: 'Components/NsNavProductCard',
+    title: 'Components/Navigation/NsNavProductCard',
     component: NsNavProductCard,
     decorators: [withCenterDecorator],
     args: {

package/src/common/nav-product-card/NsNavProductCard.tsx

@@ -2,7 +2,7 @@
 import React, { PropsWithChildren } from 'react';
 import { NsImage, NsTypography } from '../';
 import { ProductCardContainer } from './NsNavProductCard.styled';
-import { NsNavProductCardProps } from './types';
+import { NsNavProductCardProps } from './types.d';
 
 /* TODO: can we update NsImage with NsNextImage, once storybook 7 is in place */
 export const NsNavProductCard = ({

package/src/common/nav-product-card/index.ts

@@ -1,2 +1,2 @@
 export { NsNavProductCard as NsNavProductCard } from './NsNavProductCard';
-export type { NsNavProductCardProps } from './types';
+export type { NsNavProductCardProps } from './types.d';

package/src/common/nav-tab/NsNavTab.spec.tsx

@@ -1,10 +1,7 @@
 import { fireEvent } from '@testing-library/react';
-import nuskinTheme from '@nuskin/foundation-theme/src/themes/genome-foundation';
 import { NsNavTabComponent } from './NsNavTab';
-import { NavTabs } from './types';
-import { render } from '../../../test-utils';
-
-const { palette } = nuskinTheme;
+import { NavTabs } from './types.d';
+import { render } from '@/test-utils/index';
 
 const tabs: NavTabs[] = [
     {
@@ -54,7 +51,6 @@ describe('Nav Bar Component', () => {
         expect(li.length).toBe(4);
         li.forEach((list, i) => expect(list).toHaveTextContent(tabs[i].tabName));
         expect(container).toBeInTheDocument();
-        expect(getByTestId('Skin & Beauty-list').firstChild).toHaveStyle(`color: ${palette.primary.main}`);
         fireEvent.mouseOver(getByTestId('Skin & Beauty'));
         expect(getByTestId('nav-drawer')).toBeInTheDocument();
         fireEvent.mouseLeave(getByTestId('Skin & Beauty'));
@@ -65,6 +61,5 @@ describe('Nav Bar Component', () => {
         const { getByTestId } = render(<NsNavTabComponent showDrawer={false} className="mb-2" tabs={tabs} />);
         fireEvent.mouseOver(getByTestId('Skin & Beauty'));
         expect(getByTestId('underline')).toBeInTheDocument();
-        expect(getByTestId('underline')).toHaveStyle(`background-color: ${palette.success.main}`);
     });
 });

package/src/common/nav-tab/NsNavTab.stories.tsx

@@ -1,5 +1,5 @@
 import type { StoryObj, Meta } from '@storybook/react';
-import { withCenterDecorator } from '../../stories/decorators/withCenterDecorator';
+import { withCenterDecorator } from '@/stories/decorators/withCenterDecorator';
 import { NsNavTab } from './';
 
 type ComponentType = typeof NsNavTab;
@@ -7,7 +7,7 @@ type Story = StoryObj<ComponentType>;
 type MetaStory = Meta<ComponentType>;
 
 export default {
-    title: 'Components/NsNavTab',
+    title: 'Components/Navigation/NsNavTab',
     component: NsNavTab,
     decorators: [withCenterDecorator],
     argTypes: {

package/src/common/nav-tab/NsNavTab.styled.tsx

@@ -1,6 +1,9 @@
-import { FoundationTheme, styled } from '@nuskin/foundation-theme';
+import { FoundationTheme, styled, ColorUtils } from '@nuskin/foundation-theme';
 import { motion } from 'framer-motion';
 
+const { paletteColor } = ColorUtils;
+
+
 export const NavTabContainer = styled.div`
     .shadow {
         box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.15);
@@ -23,7 +26,7 @@ export const NavTabUnderLine = styled(motion.div)<{ color?: FoundationTheme.Pale
     position: absolute;
     bottom: -2px;
     height: 2px;
-    background-color: ${({ theme: { palette }, color = 'primary' }) => palette?.[color]?.main};
+    background-color: ${({ theme, color = 'primary' }) => paletteColor(color)({ theme })};
 `;
 
 export const NavDrawer = styled.div`
@@ -37,7 +40,7 @@ export const NavDrawer = styled.div`
     width: 100%;
     max-height: 590px;
 
-    background-color: ${({ theme }) => theme?.palette?.primary.contrastText};
+    background-color: ${paletteColor('primary', 'contrastText')};
     box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.15);
     transition: all 0.15s ease-in-out;
     overflow: hidden;
@@ -54,7 +57,7 @@ export const NavDrawerContainer = styled(motion.div)`
         z-index: 1;
     }
     box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.15);
-    background-color: ${({ theme }) => theme?.palette?.primary.contrastText};
+    background-color: ${paletteColor('primary', 'contrastText')};
     width: 100%;
     text-align: left;
     max-height: 590px;

package/src/common/nav-tab/NsNavTab.tsx

@@ -2,7 +2,7 @@ import React, { PropsWithChildren, useState } from 'react';
 import { LayoutGroup } from 'framer-motion';
 import { NsTypography } from '../typography';
 import { NavDrawerContainer, NavTabContainer, NavTabLine, NavTabUnderLine, NavDrawer } from './NsNavTab.styled';
-import { NSNavTabComponentProps } from './types';
+import { NSNavTabComponentProps } from './types.d';
 
 export const NsNavTabComponent = (props: PropsWithChildren<NSNavTabComponentProps>) => {
     const { tabs, className, tabTitleClassName, showDrawer = true } = props;

package/src/common/nav-tab/index.ts

@@ -1,2 +1,2 @@
 export { NsNavTabComponent as NsNavTab } from './NsNavTab';
-export type { NSNavTabComponentProps, NavTabs } from './types';
+export type { NSNavTabComponentProps, NavTabs } from './types.d';

package/src/common/nav-tab/types.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import { FoundationTheme } from '@nuskin/foundation-theme';
 import { Variants } from '../typography/types';
-import { AdditionalProps, ContentStackLiveTags } from '../common.types';
+import { AdditionalProps, CslpTag } from '../common.types';
 
 export type NavTabs = {
     tabName: string;
@@ -9,7 +9,7 @@ export type NavTabs = {
     activeColor: FoundationTheme.PaletteColors;
     color?: FoundationTheme.PaletteColors;
     textVariant: Variants;
-    liveTag?: ContentStackLiveTags;
+    liveTag?: CslpTag;
 };
 
 export type NSNavTabComponentProps = {

package/src/common/radiogroup/NsRadioGroup.spec.tsx

@@ -0,0 +1,63 @@
+import React from 'react';
+import { render, fireEvent, screen } from '@testing-library/react';
+import { NsRadioGroup } from './';
+import { FoundationTheme } from '@nuskin/foundation-theme';
+
+describe('NsRadioGroup', () => {
+    const options = [
+        { id: 'Option1', label: 'Option 1', value: 'Option1' },
+        { id: 'Option2', label: 'Option 2', value: 'Option2' },
+        { id: 'Option3', label: 'Option 3', value: 'Option3' },
+    ];
+
+    const props = {
+        disable: false,
+        items: options,
+        name: 'test',
+        label: 'I choose to signup as',
+        color: '#272525' as FoundationTheme.PaletteColors,
+        additionalSlot: 'An additional slot allows for more text',
+        size: 24,
+        labelFontSize: 16,
+        additionalProps: {
+            testid: 'radio-group',
+        },
+    };
+    const onChange = jest.fn();
+
+    it('1. renders options correctly', () => {
+        render(<NsRadioGroup {...props} onChange={onChange} />);
+
+        options.forEach((option) => {
+            const radioOption = screen.getByLabelText(option.label) as HTMLInputElement;
+            expect(radioOption).toBeInTheDocument();
+            expect(radioOption.value).toBe(option.value);
+        });
+    });
+    it('2. renders options correctly without additional slot', () => {
+        render(<NsRadioGroup {...props} onChange={onChange} additionalSlot={''} />);
+
+        options.forEach((option) => {
+            const radioOption = screen.getByLabelText(option.label) as HTMLInputElement;
+            expect(radioOption).toBeInTheDocument();
+            expect(radioOption.value).toBe(option.value);
+        });
+    });
+
+    it('3. calls OnChange when selecting option', () => {
+        render(<NsRadioGroup {...props} onChange={onChange} />);
+
+        const radioOption = screen.getByLabelText('Option 2') as HTMLInputElement;
+        fireEvent.click(radioOption);
+        expect(onChange).toHaveBeenCalledTimes(1);
+    });
+
+    it('4. does not call Onchange when the same option is clicked', () => {
+        const onChange = jest.fn();
+        render(<NsRadioGroup {...props} onChange={onChange} />);
+
+        const radioOption = screen.getByLabelText('Option 1') as HTMLInputElement;
+        fireEvent.click(radioOption);
+        expect(onChange).not.toHaveBeenCalled();
+    });
+});