@nuskin/foundation-ui-components 1.0.0-develop.6 → 1.0.0-develop.8

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.stories.tsx

@@ -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-tab/NsNavTab.stories.tsx

@@ -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/radiogroup/NsRadioGroup.spec.tsx

@@ -3,14 +3,12 @@ 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,
@@ -27,38 +25,39 @@ describe('NsRadioGroup', () => {
     };
     const onChange = jest.fn();
 
-    it('renders options correctly', () => {
-        render(
-            <NsRadioGroup  {...props} onChange={onChange}
-            />,
-        );
+    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)
-        })
-
-    })
+            expect(radioOption.value).toBe(option.value);
+        });
+    });
+    it('2. renders options correctly without additional slot', () => {
+        render(<NsRadioGroup {...props} onChange={onChange} additionalSlot={''} />);
 
-    it('calls OnChange when selecting option', () => {
+        options.forEach((option) => {
+            const radioOption = screen.getByLabelText(option.label) as HTMLInputElement;
+            expect(radioOption).toBeInTheDocument();
+            expect(radioOption.value).toBe(option.value);
+        });
+    });
 
-        render(<NsRadioGroup {...props} onChange={onChange} />)
+    it('3. calls OnChange when selecting option', () => {
+        render(<NsRadioGroup {...props} onChange={onChange} />);
 
-        const radioOption = screen.getByLabelText('Option 2') as HTMLInputElement
+        const radioOption = screen.getByLabelText('Option 2') as HTMLInputElement;
         fireEvent.click(radioOption);
         expect(onChange).toHaveBeenCalledTimes(1);
+    });
 
-    })
-
-    it('does not call Onchange when the same option is clicked', () => {
+    it('4. does not call Onchange when the same option is clicked', () => {
         const onChange = jest.fn();
-        render(<NsRadioGroup {...props} onChange={onChange} />)
+        render(<NsRadioGroup {...props} onChange={onChange} />);
 
-        const radioOption = screen.getByLabelText('Option 1') as HTMLInputElement
-        fireEvent.click(radioOption)
+        const radioOption = screen.getByLabelText('Option 1') as HTMLInputElement;
+        fireEvent.click(radioOption);
         expect(onChange).not.toHaveBeenCalled();
-    })
-
-
-})
+    });
+});

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

@@ -1,8 +1,7 @@
-
 import type { StoryObj, Meta } from '@storybook/react';
 import { within, userEvent } from '@storybook/testing-library';
 import { expect } from '@storybook/jest';
-import { NsRadioGroup } from './'
+import { NsRadioGroup } from './';
 import { FoundationTheme } from '@nuskin/foundation-theme';
 
 type ComponentType = typeof NsRadioGroup;
@@ -11,46 +10,32 @@ type MetaStory = Meta<ComponentType>;
 
 export default {
     component: NsRadioGroup,
-    title: 'Components/NsRadioGroup',
+    title: 'Components/Inputs/NsRadioGroup',
     argTypes: {
         disable: {
-            description:
-                'Indicates whether the radio button is enabled/disabled',
-
+            description: 'Indicates whether the radio button is enabled/disabled',
         },
         items: {
-            description:
-                'Value of the component to be emitted when selected.',
+            description: 'Value of the component to be emitted when selected.',
         },
         name: {
-            description:
-                'Name of the component',
-
+            description: 'Name of the component',
         },
         label: {
-            description:
-                'Label of the radio group',
-
+            description: 'Label of the radio group',
         },
         color: {
-            description:
-                'Color of the radio button',
-
+            description: 'Color of the radio button',
         },
         size: {
-            description:
-                'Margin Left for Additional Slot text',
-
+            description: 'Margin Left for Additional Slot text',
         },
         labelFontSize: {
-            description:
-                'Used to change font-size of the label'
+            description: 'Used to change font-size of the label',
         },
         additionalSlot: {
-            description:
-                'An additional slot allows for more text',
-
-        }
+            description: 'An additional slot allows for more text',
+        },
     },
 } as MetaStory;
 
@@ -61,7 +46,7 @@ export const RadioGroup: Story = {
             {
                 id: 'individual',
                 label: `Vendeur à domicile indépendant mandataire (The VDI mandataire
-                     enters into sales or service agreements 
+                     enters into sales or service agreements
                     with customers in the name and on behalf of the company.
                      His remuneration will be based on commissions made
                      on the sales of products to customers.)`,
@@ -70,7 +55,7 @@ export const RadioGroup: Story = {
             {
                 id: ' retailer',
                 label: `Vendeur à domicile indépendant acheteur-revendeur
-                 (The VDI acheteur-revendeur sells the company's products in his own name and behalf. 
+                 (The VDI acheteur-revendeur sells the company's products in his own name and behalf.
                  His remuneration will be based on commissions and on the margins made on the sales of
                   products to customers.)`,
                 value: 'retailer',
@@ -91,12 +76,9 @@ export const RadioGroup: Story = {
         await userEvent.hover(canvas.getByTestId('radio-group'));
         await expect(
             canvas.getByText(
+                // eslint-disable-next-line max-len
                 'Vendeur à domicile indépendant mandataire (The VDI mandataire enters into sales or service agreements with customers in the name and on behalf of the company. His remuneration will be based on commissions made on the sales of products to customers.)'
             )
         ).toBeInTheDocument();
     },
 };
-
-
-
-

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

@@ -1,5 +1,6 @@
 import { Radio, FormControlLabel, FormLabel, RadioGroup } from '@mui/material';
 import { ColorUtils, FoundationTheme, styled } from '@nuskin/foundation-theme';
+import { skipDarkModeEnabled } from '../util';
 
 const { paletteColor, isDarkMode, color } = ColorUtils;
 
@@ -23,7 +24,7 @@ export const StyledLabel = styled(FormLabel)`
 `;
 
 export const StyledRadio = styled(Radio)`
-    color: ${(props) => !isDarkMode(props) ? color('primary', 'black')(props) : color('primary', 'white')(props)}
+    color: ${(props) => color('primary', !isDarkMode(props) ? 'black' : 'white')(props)};
 `;
 
 export const StyledFormControlLabel = styled(FormControlLabel)<{ darkModeEnabled?: boolean }>((props) => {
@@ -31,20 +32,21 @@ export const StyledFormControlLabel = styled(FormControlLabel)<{ darkModeEnabled
         color: paletteColor('primary')(props),
         marginBottom: '10px',
         '.MuiFormControlLabel-label.Mui-disabled': {
-            color: `${!isDarkMode(props) ? color('neutral', 60)(props) : color('neutral', 20)(props)}`
+            color: `${color('neutral', !isDarkMode(props) ? 60 : 20)(props)}`,
+        },
+    };
+});
+const options = {
+    shouldForwardProp: skipDarkModeEnabled,
+};
+export const StyledRadioGroup = styled(
+    RadioGroup,
+    options
+)<{ color: FoundationTheme.PaletteColors; darkModeEnabled?: boolean }>(({ theme, color, darkModeEnabled }) => {
+    return {
+        marginTop: '10px',
+        '.MuiRadio-root.custom-radio.Mui-checked': {
+            color: paletteColor(color)({ theme, darkModeEnabled }),
         },
     };
 });
-
-export const StyledRadioGroup = styled(RadioGroup)<
-    { color: FoundationTheme.PaletteColors; darkModeEnabled?: boolean }
->(
-    ({ theme, color, darkModeEnabled }) => {
-        return {
-            marginTop: '10px',
-            '.MuiRadio-root.custom-radio.Mui-checked': {
-                color: paletteColor(color)({ theme, darkModeEnabled })
-            },
-        };
-    }
-);

package/src/common/radiogroup/NsRadioGroup.tsx

@@ -22,7 +22,7 @@ const NsRadioGroup = (props: NsRadioGroupProps) => {
         size,
         additionalProps,
         labelFontSize,
-        darkModeEnabled = true
+        darkModeEnabled = true,
     } = props;
 
     return (
@@ -50,10 +50,11 @@ const NsRadioGroup = (props: NsRadioGroupProps) => {
                     ))}
                 </StyledRadioGroup>
             </FormControl>
-            {additionalSlot ? <StyledHelperText className={`ml-${size}`}>
-                <StyledSpan className="text-sm">{additionalSlot}</StyledSpan>
-            </StyledHelperText> : null}
-
+            {additionalSlot ? (
+                <StyledHelperText className={`ml-${size}`}>
+                    <StyledSpan className="text-sm">{additionalSlot}</StyledSpan>
+                </StyledHelperText>
+            ) : null}
         </>
     );
 };

package/src/common/search-bar/NsSearchBar.tsx

@@ -2,8 +2,6 @@ import React from 'react';
 import InputBase from '@mui/material/InputBase';
 import { styled } from '@nuskin/foundation-theme';
 
-interface NsSearchBarProps {}
-
 const Search = styled('div')`
     position: relative;
     borderRadius: 0;
@@ -31,7 +29,7 @@ const StyledInputBase = styled(InputBase)(() => ({
     },
 }));
 
-const NsSearchBar: React.FC<NsSearchBarProps> = () => {
+const NsSearchBar: React.FC = () => {
     return (
         <div>
             <Search>