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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nuskin/foundation-ui-components",
-    "version": "1.0.0-develop.7",
+    "version": "1.0.0-develop.8",
     "description": "It is a foundation library written in react, that provides common components to all UI pages",
     "private": false,
     "main": "src/common/index.ts",

package/src/common/accordion/NsAccordion.tsx

@@ -8,7 +8,7 @@ import { StyledAccordionWrapper } from './ToggleSection.styled';
  * multiple sections of accordion can remain open at a time
  *
  * we can define certain section to remain open by default using `isDefaultOpen` in the
- * contentArray item
+ * items
  * if there are multiple items available for default open, but `allowMultipleExpanded`
  * is false then only first item of default open is made open
  */

package/src/common/accordion/NsAccordionHeader.tsx

@@ -2,26 +2,31 @@ import { NsTypography, NsIcon, NsAccordionHeaderProps, AccordionVariant, NsIconP
 import { styled } from '@nuskin/foundation-theme';
 import { isValidIconName } from '../icon/NsIconVariants';
 import { getAccordionColor } from './colorMap';
+const options = {
+    shouldForwardProp: (propKey: string) => !['variant', 'invert'].includes(propKey),
+};
+type StyledType = { variant: AccordionVariantType; invert: boolean };
 
-const StyledHeader = styled('header')<{ variant: AccordionVariantType; invert: boolean }>(
-    ({ theme, variant, invert }) => {
-        const { headBg, headText } = getAccordionColor({ theme, variant, invert, keys: ['headBg', 'headText'] });
-        let borderBottom = 'none';
-        if (variant === AccordionVariant.Compact) {
-            borderBottom = '1px solid rgb(0,0,0,0.125)';
-        }
-        return {
-            backgroundColor: headBg,
-            color: headText,
-            cursor: 'pointer',
-            display: 'grid',
-            gap: '4px',
-            gridTemplateColumns: 'auto 1fr 24px',
-            padding: '9px 16px',
-            borderBottom,
-        } as any;
+const StyledHeader = styled(
+    'header',
+    options
+)<StyledType>(({ theme, variant, invert }) => {
+    const { headBg, headText } = getAccordionColor({ theme, variant, invert, keys: ['headBg', 'headText'] });
+    let borderBottom = 'none';
+    if (variant === AccordionVariant.Compact) {
+        borderBottom = '1px solid rgb(0,0,0,0.125)';
     }
-);
+    return {
+        backgroundColor: headBg,
+        color: headText,
+        cursor: 'pointer',
+        display: 'grid',
+        gap: '4px',
+        gridTemplateColumns: 'auto 1fr 24px',
+        padding: '9px 16px',
+        borderBottom,
+    } as any;
+});
 
 /**
  * NsAccordionHeader is primarily used by NsToggleSection and NsAccordionItem

package/src/common/accordion/NsCollapse.tsx

@@ -57,24 +57,22 @@ const NsCollapse = ({ isOpen, content, additionalProps, variant, level, invert,
         if (isValidElement(content)) {
             return content as ReactElement;
         }
-        if (content?.type === 'html') {
+        const contentVar = content as unknown as ItemContent;
+        if (contentVar?.type === 'html') {
             return (
-                <div
-                    className="nsa-content-padded"
-                    dangerouslySetInnerHTML={{ __html: (content as ItemContent)?.data as string }}
-                />
+                <div className="nsa-content-padded" dangerouslySetInnerHTML={{ __html: contentVar?.data as string }} />
             );
-        } else if (content?.type === 'text') {
-            return <div className="p-4">{(content as ItemContent)?.data as string}</div>;
-        } else if (content?.type === 'accordion') {
+        } else if (contentVar?.type === 'text') {
+            return <div className="p-4">{contentVar?.data as string}</div>;
+        } else if (contentVar?.type === 'accordion') {
             return (
                 <NsAccordion
                     isChild={true}
                     invert={invert}
                     level={level}
                     variant={AccordionVariant.Gray}
-                    items={(content as ItemContent)?.data as AccordionItem[]}
-                    allowMultipleExpanded={(content as ItemContent)?.allowMultipleExpanded ?? false}
+                    items={contentVar?.data as AccordionItem[]}
+                    allowMultipleExpanded={contentVar?.allowMultipleExpanded ?? false}
                 />
             );
         }

package/src/common/accordion/ToggleSection.styled.tsx

@@ -2,7 +2,10 @@ import { styled } from '@nuskin/foundation-theme';
 import { AccordionVariant, AccordionVariantType } from '../';
 
 const border = '1px solid rgb(0,0,0,0.125)';
-export const StyledToggleSection = styled('section')<{ variant: AccordionVariantType }>(({ variant }) => {
+
+type StyledType = { variant: AccordionVariantType };
+
+export const StyledToggleSection = styled('section')<StyledType>(({ variant }) => {
     if (variant === AccordionVariant.Compact) {
         return { borderRight: border };
     }
@@ -11,7 +14,7 @@ export const StyledToggleSection = styled('section')<{ variant: AccordionVariant
     };
 });
 
-export const StyledAccordionWrapper = styled('div')<{ variant: AccordionVariantType }>(({ variant }) => {
+export const StyledAccordionWrapper = styled('div')<StyledType>(({ variant }) => {
     if (variant === AccordionVariant.Compact) {
         return {
             display: 'flex',

package/src/common/accordion/enums.ts

@@ -1,10 +1,3 @@
-/* eslint-disable no-unused-vars */
-// export enum AccordionVariant {
-//     Basic = 'basic', // basic is as per figma
-//     Compact = 'compact', // compact is as per test.nuskin.com
-//     Gray = 'gray',
-//     Stripe = 'stripe',
-// }
 export const AccordionVariant = {
     Basic: 'basic',
     Compact: 'compact',

package/src/common/accordion/stories/NsAccordion.stories.tsx

@@ -22,6 +22,11 @@ const meta = {
             control: 'select',
             options: [...Object.values(AccordionVariant)],
         },
+        level: {
+            control: 'number',
+            description: `level = 1 means no padding on left from parent to child,
+            level = 2 means padding of 16px, level = 3 means padding of 32px and so on ..`,
+        },
     },
     args: {
         variant: AccordionVariant.Basic,

package/src/common/index.ts

@@ -13,6 +13,7 @@ export * from './column-control';
 export * from './checkbox';
 export * from './common.types.d';
 export * from './dropdown';
+export * from './email-simple';
 export * from './flag';
 export * from './hooks';
 export * from './icon';
@@ -20,11 +21,12 @@ export * from './image';
 export * from './input';
 export * from './label';
 export * from './link';
+export * from './modal';
 export * from './nav-tab';
 export * from './nav-product-card';
+export * from './radiogroup';
+export * from './spinner';
 export * from './text-strip';
 export * from './table';
 export * from './typography';
-export * from './email-simple';
-export * from './radiogroup';
-export * from './spinner';
+export * from './utility';

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

@@ -0,0 +1,46 @@
+import React from 'react';
+import { render } from '@/test-utils/index';
+import NsModal from './NsModal';
+import { NsModalData } from './stories/mock';
+import { NsModalProps } from './types';
+
+describe('NsModal', () => {
+    const onHandleClose = jest.fn();
+
+    const NsModalProp = NsModalData as NsModalProps;
+
+    test('1. check NsModal component open', () => {
+        const { getByTestId } = render(<NsModal {...NsModalProp} handleClose={onHandleClose} />);
+        expect(getByTestId('nsmodal-dialog')).toBeInTheDocument();
+    });
+
+    test('2. should render NsModal default component', () => {
+        const { getByTestId } = render(<NsModal {...NsModalProp} handleClose={onHandleClose} />);
+        expect(getByTestId('modal-default')).toBeInTheDocument();
+    });
+
+    test('3. should render NsModal status component', () => {
+        const VariantProps: NsModalProps = {
+            ...NsModalProp,
+            variant: 'info',
+        };
+        const { getByTestId } = render(<NsModal {...VariantProps} handleClose={onHandleClose} />);
+        expect(getByTestId('modal-status')).toBeInTheDocument();
+    });
+
+    test('4. should render NsModal title with close button', () => {
+        const { getByTestId } = render(<NsModal {...NsModalProp} handleClose={onHandleClose} />);
+        expect(getByTestId('modal-title')).toBeInTheDocument();
+        expect(getByTestId('modal-close-button')).toBeInTheDocument();
+    });
+
+    test('5. should render NsModal body content', () => {
+        const { getByTestId } = render(<NsModal {...NsModalProp} handleClose={onHandleClose} />);
+        expect(getByTestId('modal-body-content')).toBeInTheDocument();
+    });
+
+    test('6. should render NsModal footer', () => {
+        const { getByTestId } = render(<NsModal {...NsModalProp} handleClose={onHandleClose} />);
+        expect(getByTestId('modal-footer')).toBeInTheDocument();
+    });
+});

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

@@ -0,0 +1,28 @@
+import { styled } from '@nuskin/foundation-theme';
+import { NsButton } from '../button';
+import { DialogActions } from '@mui/material';
+
+export const NsInfoWrapper = styled.div`
+    display: flex;
+    .status-icon {
+        padding: 16px 0px 0px 24px;
+    }
+    .title-icon {
+        padding-right: 10px;
+    }
+`;
+
+export const CloseButton = styled(NsButton)`
+    position: absolute;
+    right: 8px;
+    top: 8px;
+`;
+
+export const ModalFooter = styled(DialogActions)`
+    display: flex;
+    justify-content: space-around;
+    padding: 20px 0px 10px 0px;
+    button {
+        width: 100%;
+    }
+`;

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/utility/Show.tsx

@@ -0,0 +1,13 @@
+import { PropsWithChildren, ReactElement } from 'react';
+
+type ShowType = PropsWithChildren & {
+    when?: boolean;
+    elseContent?: ReactElement;
+};
+const Show = ({ when, children, elseContent }: ShowType): ReactElement => {
+    if (when) {
+        return <>{children}</>;
+    }
+    return <>{elseContent}</>;
+};
+export default Show;

package/src/common/utility/index.ts

@@ -0,0 +1 @@
+export { default as Show } from './Show';