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

package/src/common/autocomplete/NsAutocomplete.tsx

@@ -1,4 +1,4 @@
-import React, { useState, PropsWithChildren, useRef } from 'react';
+import React, { PropsWithChildren, useCallback } from 'react';
 import { Autocomplete, AutocompleteRenderGroupParams, List, AutocompleteRenderInputParams } from '@mui/material';
 import { NsTypography, NsButton } from '../';
 import { NsAutocompleteProps, OptionsProps, ComponentBoxProps } from './types.d';
@@ -6,7 +6,7 @@ import { StyledTextField } from './NsAutocomplete.styled';
 
 const NsAutocomplete = ({
     id = 'custom_autocomplete_dropdown',
-    options = [],
+    options,
     renderOptions,
     loading,
     noOptionsText,
@@ -18,23 +18,33 @@ const NsAutocomplete = ({
     className,
     iconStart,
     iconEnd,
+    inputValue,
+    value,
 }: PropsWithChildren<NsAutocompleteProps>) => {
-    const inputRef = useRef(null);
-
-    const [selectedOption, setSelectedOption] = useState<OptionsProps | null>(null);
     const OptionUI = renderOptions;
 
-    const handleSelect = (event: React.SyntheticEvent<Element, Event>, value: OptionsProps | null) => {
-        setSelectedOption(value);
-        onSelect ? onSelect(value) : null;
-    };
+    const handleSelect = useCallback(
+        (event: React.SyntheticEvent, value: string | OptionsProps | null) => {
+            if (typeof onSelect === 'function') {
+                onSelect(value);
+            }
+        },
+        [onSelect]
+    );
+
+    const handleInputChange = useCallback(
+        (event: React.SyntheticEvent, newInputValue: string) => {
+            if (typeof onChange === 'function') {
+                onChange(newInputValue);
+            }
+        },
+        [onChange]
+    );
 
     const renderInput = (params: AutocompleteRenderInputParams) => (
         <StyledTextField
             {...params}
-            onChange={onChange}
             placeholder={placeholder}
-            inputRef={inputRef}
             InputProps={{
                 ...params.InputProps,
                 startAdornment: iconStart,
@@ -61,23 +71,23 @@ const NsAutocomplete = ({
                     {group}
                 </NsTypography>
             ) : null}
-            <span>{children}</span>
+            <ul className="p-0">{children}</ul>
         </li>
     );
 
     const renderClearButton = () => {
-        const { show, onClear, text = 'See More Results' } = clear || {};
+        const { show, onClear, text = 'Clear Search' } = clear || {};
         if (!show) {
             return null;
         }
         return (
-            <div className="text-right p-3">
+            <li className="text-right p-3">
                 <NsButton onClick={onClear} data-testid="autocomplete-clear-id">
                     <NsTypography variant={'p-xs'} weight="bold">
                         {text}
                     </NsTypography>
                 </NsButton>
-            </div>
+            </li>
         );
     };
 
@@ -87,13 +97,13 @@ const NsAutocomplete = ({
             return null;
         }
         return (
-            <div className="text-center p-3">
+            <li className="text-center p-3">
                 <NsButton onClick={onSeeMore} data-testid="autocomplete-loadmore-id">
                     <NsTypography variant="p-xs" weight="bold">
                         {text}
                     </NsTypography>
                 </NsButton>
-            </div>
+            </li>
         );
     };
 
@@ -120,7 +130,10 @@ const NsAutocomplete = ({
             ListboxComponent={renderListBoxComponent}
             renderGroup={renderGroupName}
             onChange={handleSelect}
-            value={selectedOption}
+            onInputChange={handleInputChange}
+            value={value}
+            inputValue={inputValue}
+            freeSolo
         />
     );
 };

package/src/common/autocomplete/mock/MockUI.tsx

@@ -1,3 +1,4 @@
+/* eslint-disable @next/next/no-img-element */
 import { ListStyled } from './Mock.styled';
 import { NsTypography } from '../../typography';
 import { NsIcon } from '../../icon';

package/src/common/autocomplete/types.d.ts

@@ -6,27 +6,29 @@ import { ComponentsProps } from '@mui/material';
 export type NsAutocompleteProps = {
     id?: string;
     options: OptionsProps[];
-    loading?:boolean;
+    loading?: boolean;
     renderOptions: React.ComponentType<any>;
-    noOptionsText ?:string;
+    noOptionsText?: string;
     // eslint-disable-next-line no-unused-vars
-    onSelect?: (params: OptionsProps | null) => void;
+    onSelect?: (params: string | OptionsProps | null) => void;
     // eslint-disable-next-line no-unused-vars
-    onChange?: (params) => void;
+    onChange?: (params: string) => void;
     clear?: {
         text: string;
         show?: boolean; //default to false
-        onClear: () => {};
+        onClear: () => void;
     };
     seeMore?: {
         text: string;
         show?: boolean; //default to false
-        onSeeMore: () => {};
+        onSeeMore: () => void;
     };
     placeholder?: string;
     className?: string;
     iconStart?: string | React.ReactNode;
     iconEnd?: string | React.ReactNode;
+    inputValue: string;
+    value: string | OptionsProps | null;
 } & AdditionalProps;
 
 export type ListUiProps = {

package/src/common/banner/NsBanner.spec.tsx

@@ -3,9 +3,9 @@ import { render } from '@testing-library/react';
 import { NsBanner } from '@/common/';
 
 describe('Hero component', () => {
-    it('renders banner image and title', () => {
-        const childText = 'Welcome to My Website';
-        const imageURL = 'https://example.com/banner.jpg';
+    const childText = 'Welcome to My Website';
+    const imageURL = 'https://example.com/banner.jpg';
+    it('1. renders banner image and title', () => {
         const { getByAltText, getByText } = render(
             <NsBanner imageUrl={imageURL} altText="Banner image">
                 <h1>{childText}</h1>
@@ -16,4 +16,13 @@ describe('Hero component', () => {
         expect(childElement).toBeInTheDocument();
         expect(imageElement).toBeInTheDocument();
     });
+    it('2. renders banner image and title without altText', () => {
+        const { getByAltText } = render(
+            <NsBanner imageUrl={imageURL}>
+                <h1>{childText}</h1>
+            </NsBanner>
+        );
+        const imageElement = getByAltText('NsBanner');
+        expect(imageElement).toBeInTheDocument();
+    });
 });

package/src/common/banner/NsBanner.stories.tsx

@@ -14,7 +14,7 @@ type Story = StoryObj<ComponentType>;
 type MetaStory = Meta<ComponentType>;
 
 export default {
-    title: 'Components/NsBanner',
+    title: 'Components/Data Display/NsBanner',
     component: NsBanner,
     decorators: [withCenterDecorator],
     argTypes: {

package/src/common/brand-components/NsBrand.stories.tsx

@@ -7,7 +7,7 @@ type Story = StoryObj<ComponentType>;
 type MetaStory = Meta<ComponentType>;
 
 export default {
-    title: 'Components/NsBrandComponent',
+    title: 'Components/Data Display/NsBrandComponent',
     component: NsBrandComponent,
     decorators: [withCenterDecorator],
     argTypes: {

package/src/common/brand-components/NsBrandComponent.tsx

@@ -5,7 +5,7 @@ import NSLogoMark from './icons/NSLogoMark';
 import NSLogoPoweredBy from './icons/NSLogoPoweredBy';
 import NSLogoStacked from './icons/NSLogoStacked';
 import NSLogoWordMark from './icons/NSWordMark';
-import LogoContainer from './NsBrandContanier.styled';
+import LogoContainer from './NsBrandContainer.styled';
 
 import { NsBrandComponentProps } from './types.d';
 
@@ -20,7 +20,7 @@ const VariantMap = {
 const NsBrandComponent = (props: PropsWithChildren<NsBrandComponentProps>) => {
     const { variant = 'stacked', size = '108px', color = 'primary' } = props;
     const renderBrand = useCallback(() => {
-        const BrandComponent = VariantMap[variant || 'stacked'];
+        const BrandComponent = VariantMap[variant];
         // [Todo - Add neutral as FoundationTheme.PaletteColor]
         return <BrandComponent color={color as any} />;
     }, [color, variant]);

package/src/common/breadcrumb/NsBreadcrumb.spec.tsx

@@ -1,11 +1,11 @@
 import React from 'react';
 import { render, screen } from '@testing-library/react';
 import { NsBreadcrumb } from './';
-import { breadcrumbItems } from './data';
+import { breadcrumbItems, dummyItems } from './data';
 const { getByText } = screen;
 
 describe('Breadcrumb', () => {
-    it('renders breadcrumb items', () => {
+    it('1. renders breadcrumb items', () => {
         render(<NsBreadcrumb items={breadcrumbItems} />);
         expect(getByText('Home')).toBeInTheDocument();
         expect(getByText('Products')).toBeInTheDocument();
@@ -13,11 +13,16 @@ describe('Breadcrumb', () => {
         expect(getByText('Blue shirt')).toBeInTheDocument();
     });
 
-    it('renders breadcrumb items with navigation icons', () => {
+    it('2. renders breadcrumb items with navigation icons', () => {
         render(<NsBreadcrumb items={breadcrumbItems} iconVisibility />);
         expect(getByText('Home')).toBeInTheDocument();
         expect(getByText('Products')).toBeInTheDocument();
         expect(getByText('Shirts')).toBeInTheDocument();
         expect(getByText('Blue shirt')).toBeInTheDocument();
     });
+
+    it('3. renders breadcrumb items with navigation icons', () => {
+        render(<NsBreadcrumb items={dummyItems} iconVisibility />);
+        expect(getByText('Home')).toBeInTheDocument();
+    });
 });

package/src/common/breadcrumb/NsBreadcrumb.stories.tsx

@@ -13,7 +13,7 @@ type Story = StoryObj<ComponentType>;
 type MetaStory = Meta<ComponentType>;
 
 export default {
-    title: 'Components/NsBreadcrumb',
+    title: 'Components/Navigation/NsBreadcrumb',
     component: NsBreadcrumb,
     decorators: [withCenterDecorator],
     argTypes: {

package/src/common/breadcrumb/NsBreadcrumb.tsx

@@ -18,8 +18,8 @@ const NsBreadcrumb = (props: PropsWithChildren<NsBreadcrumbProps>) => {
     const { items, iconVisibility } = props;
 
     const theme = useTheme();
-    const neutral80 = color('neutral', '80')(theme);
-    const neutral60 = color('neutral', '60')(theme);
+    const neutral80 = color('neutral', '80')({ theme });
+    const neutral60 = color('neutral', '60')({ theme });
 
     const getLabel = (item: ItemProps) => {
         if (item?.href) {

package/src/common/breadcrumb/data.ts

@@ -1,7 +1,10 @@
-import { ItemProps } from './types';
+import {ItemProps} from './types';
 export const breadcrumbItems: ItemProps[] = [
-    { label: 'Home', href: '/', icon: 'home' },
-    { label: 'Products', href: '/products' },
-    { label: 'Shirts', href: '/products/shirts' },
-    { label: 'Blue shirt', href: '/products/shirts/blue' },
+    {label: 'Home', href: '/', icon: 'home'},
+    {label: 'Products', href: '/products'},
+    {label: 'Shirts', href: '/products/shirts'},
+    {label: 'Blue shirt', href: '/products/shirts/blue'},
 ];
+export const dummyItems: ItemProps[] = [
+    {label: 'Home', icon: 'home'}
+]

package/src/common/button/NsButton.spec.tsx

@@ -1,68 +1,84 @@
 import React from 'react';
 import { render, screen } from '@/test-utils/index';
+import { NsButton } from '../';
 import { nuskinTheme } from '@nuskin/foundation-theme';
-import Button from './NsButton';
 
 const { palette } = nuskinTheme;
 
 describe('<Button />', () => {
-    describe(' button primary', () => {
-        test('should render default button styles', () => {
-            const text = 'Click Me';
-            render(
-                <Button color="primary" variant="contained">
-                    {text}
-                </Button>
-            );
+    it('1. should render default primary button styles ', () => {
+        const text = 'Click Me';
+        render(
+            <NsButton color="primary" variant="contained">
+                {text}
+            </NsButton>
+        );
 
-            const button = screen.getByText(text);
-            expect(button).toBeInTheDocument();
-            expect(button).toHaveStyle(`color: ${palette?.primary?.contrastText ?? ''}`);
-            expect(button).toHaveStyle(`background-color: ${palette?.primary?.main ?? ''}`);
-        });
+        const button = screen.getByText(text);
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette?.primary?.contrastText}`);
+        expect(button).toHaveStyle(`background-color: ${palette?.primary?.buttonState?.pressed}`);
     });
-    describe('button secondary', () => {
-        test('should render default button styles', () => {
-            const text = 'Click Me';
-            render(
-                <Button color="success" variant="contained" size="large">
-                    {text}
-                </Button>
-            );
+    it('2. should render default secondary button styles', () => {
+        const text = 'Click Me';
+        render(
+            <NsButton color="success" variant="contained" size="large">
+                {text}
+            </NsButton>
+        );
 
-            const button = screen.getByText(text);
+        const button = screen.getByText(text);
 
-            expect(button).toBeInTheDocument();
-            expect(button).toHaveStyle(`color: ${palette.success.contrastText}`);
-            expect(button).toHaveStyle(`background-color: ${palette.success.main}`);
-        });
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette.success.contrastText}`);
+        expect(button).toHaveStyle(`background-color: ${palette.success.buttonState?.pressed}`);
     });
-    describe('button outline success', () => {
-        test('should render outlined success button', () => {
-            render(
-                <Button color="success" variant="outlined" size="large">
-                    Click Me
-                </Button>
-            );
+    it('3. should render outlined success button', () => {
+        render(
+            <NsButton color="success" variant="outlined" size="large">
+                Click Me
+            </NsButton>
+        );
 
-            const button = screen.getByText('Click Me');
+        const button = screen.getByText('Click Me');
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette.success.main}`);
+    });
+    it('4. should render outlined accentColorA button', () => {
+        render(
+            <NsButton color="accentColorA" variant="outlined" size="large">
+                Click Me
+            </NsButton>
+        );
+
+        const button = screen.getByText('Click Me');
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette?.accentColorA?.main}`);
+    });
+    it('5. should render text button styles', () => {
+        const text = 'Click Me';
+        render(
+            <NsButton color="success" variant="text" size="large">
+                {text}
+            </NsButton>
+        );
+
+        const button = screen.getByText(text);
 
-            expect(button).toBeInTheDocument();
-            expect(button).toHaveStyle(`color: ${palette.success.main}`);
-        });
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette.success.main}`);
     });
-    describe('button outline accentColorA', () => {
-        test('should render outlined success button', () => {
-            render(
-                <Button color="accentColorA" variant="outlined" size="large">
-                    Click Me
-                </Button>
-            );
+    it('6. iconOnly variant', () => {
+        const text = 'Click Me';
+        render(
+            <NsButton color="success" variant="text" size="large" iconOnly>
+                {text}
+            </NsButton>
+        );
 
-            const button = screen.getByText('Click Me');
+        const button = screen.getByText(text);
 
-            expect(button).toBeInTheDocument();
-            expect(button).toHaveStyle(`color: ${palette?.accentColorA?.main}`);
-        });
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette.success.main}`);
     });
 });

package/src/common/button/NsButton.stories.tsx

@@ -3,13 +3,18 @@ import type { StoryObj, Meta } from '@storybook/react';
 import { NsButton } from './';
 import { ShoppingCart } from '@mui/icons-material';
 import { withCenterDecorator } from '@/stories/decorators/withCenterDecorator';
+import { within } from '@storybook/testing-library';
+import { expect } from '@storybook/jest';
+import { nuskinTheme } from '@nuskin/foundation-theme';
+
+const { palette } = nuskinTheme;
 
 type ComponentType = typeof NsButton;
 type Story = StoryObj<ComponentType>;
 type MetaStory = Meta<ComponentType>;
 
 export default {
-    title: 'Components/NsButton',
+    title: 'Components/Inputs/NsButton',
     component: NsButton,
     decorators: [withCenterDecorator],
     argTypes: {
@@ -21,6 +26,7 @@ export default {
         color: { name: 'Color Variants' },
         disabled: { control: 'boolean' },
         fullWidth: { control: 'boolean' },
+
         iconOnly: { control: 'hide' },
     },
     args: {
@@ -30,13 +36,15 @@ export default {
         disabled: false,
         variant: 'contained',
         fullWidth: false,
+        startIcon: '',
+        endIcon: '',
     },
 } as MetaStory;
 
 export const button: Story = {};
 
 export const IconOnlyButton: Story = {
-    render: (args) => (
+    render: (args: any) => (
         <NsButton {...args} iconOnly darkModeEnabled={false}>
             <ShoppingCart />
         </NsButton>
@@ -53,3 +61,52 @@ export const IconOnlyButton: Story = {
         iconOnly: { control: 'hide' },
     },
 };
+export const ButtonWithIcon: Story = {
+    render: (args: any) => (
+        <NsButton {...args} darkModeEnabled={false} startIcon={<ShoppingCart />}>
+            Add to Cart
+        </NsButton>
+    ),
+    argTypes: {
+        children: {
+            control: 'hide',
+        },
+        color: { name: 'Color Variants' },
+        disabled: { control: 'boolean' },
+        fullWidth: { control: 'boolean' },
+        iconOnly: { control: 'hide' },
+    },
+};
+
+export const TextVariant: Story = {
+    args: {
+        color: 'success',
+        variant: 'text',
+        size: 'large',
+        children: 'click me! icon',
+    },
+    play: ({ canvasElement }) => {
+        const canvas = within(canvasElement);
+        const button = canvas.getByText('click me! icon');
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette.success.main}`);
+        expect(button).toHaveStyle('background-color: rgba(0, 0, 0, 0);');
+    },
+};
+
+export const IconOnly: Story = {
+    args: {
+        iconOnly: true,
+        color: 'success',
+        variant: 'text',
+        size: 'large',
+        children: 'click me! icon',
+    },
+    play: ({ canvasElement }) => {
+        const canvas = within(canvasElement);
+        const button = canvas.getByText('click me! icon');
+        expect(button).toBeInTheDocument();
+        expect(button).toHaveStyle(`color: ${palette.success.main}`);
+        expect(button).toHaveStyle('background-color: rgba(0, 0, 0, 0);');
+    },
+};

package/src/common/button/NsButton.styled.tsx

@@ -4,6 +4,8 @@ import { styled, ColorUtils, FoundationTheme } from '@nuskin/foundation-theme';
 import { ButtonConfig } from '@nuskin/foundation-theme/src/common/themes/types/button';
 
 import { NsButtonProps } from './types.d';
+import { generateContainedStyle, generateIconOnlyStyles, generateOutlinedStyle, generateTextStyles } from './helper';
+import { skipDarkModeEnabled } from '../util';
 
 const { buttonColor, paletteColor } = ColorUtils;
 
@@ -11,79 +13,60 @@ const getButtonConfig = (theme: FoundationTheme.Theme, attribute: keyof ButtonCo
     const { config } = theme || {};
     return config?.components?.button?.[attribute] || '';
 };
-
-const StyledButton = styled(MUIButton)<NsButtonProps>`
+const options = {
+    shouldForwardProp: skipDarkModeEnabled,
+};
+const StyledButton = styled(MUIButton, options)<NsButtonProps>`
     gap: 10px;
-    border-radius: ${({ theme }) => getButtonConfig(theme, 'borderRadius')} || 0;
-    :focus {
+    border-radius: ${({ theme }) => {
+        const borderRadius = getButtonConfig(theme, 'borderRadius');
+        return borderRadius || 0;
+    }};
+
+    &:focus {
         border: 1px solid ${({ theme }) => getButtonConfig(theme, 'focusColor')} !important;
     }
-    :disabled {
-        background-color: ${(btnProps) => buttonColor(btnProps?.color, 'disabled')};
-        color: ${(btnProps) => buttonColor(btnProps?.color, 'disabledText')};
+
+    &:disabled {
+        background-color: ${({ color }) => buttonColor(color, 'disabled')};
+        color: ${({ color }) => buttonColor(color, 'disabledText')};
     }
+
     ${({ theme: { config }, size }) => {
-        return size === 'medium' ? config?.components?.button?.size?.medium?.padding : '';
-    }}
-    ${({ theme: { config }, size }) => {
-        return size === 'large' ? config?.components?.button?.size?.large?.padding : '';
+        if (size === 'medium') {
+            return config?.components?.button?.size?.medium?.padding;
+        } else if (size === 'large') {
+            return config?.components?.button?.size?.large?.padding;
+        } else {
+            return '';
+        }
     }}
-    ${({ variant, theme, color = 'primary', darkModeEnabled }) => {
-        return variant === 'contained'
-            ? `
-                background-color: ${paletteColor(color)({ theme, darkModeEnabled })};
-                color: ${paletteColor(color, 'contrastText')({ theme, darkModeEnabled })} !important;
-                :hover {
-                    background-color: ${buttonColor(color, 'hovered')({ theme })};
-                }
-                :active {
-                    background-color: ${buttonColor(color, 'pressed')({ theme })};
-                }
-                :focus {
-                    background-color: ${buttonColor(color, 'focused')({ theme })};
-                }
-            `
-            : '';
+
+    ${({ variant, theme, color = 'primary', darkModeEnabled, iconOnly }) => {
+        if (variant === 'contained') {
+            const hovered = buttonColor(color, 'hovered')({ theme });
+            const pressed = buttonColor(color, 'pressed')({ theme });
+            const focused = buttonColor(color, 'focused')({ theme });
+            const textColor = paletteColor(color, 'contrastText')({ theme, darkModeEnabled });
+            const backgroundColor = paletteColor(color)({ theme, darkModeEnabled });
+            return generateContainedStyle({ backgroundColor, textColor, hovered, pressed, focused });
+        } else if (variant === 'outlined') {
+            const borderColor = paletteColor(color)({ theme, darkModeEnabled });
+            const activeColor = paletteColor(color)({ theme });
+            const hovered = buttonColor(color, 'hovered')({ theme });
+            const pressed = buttonColor(color, 'pressed')({ theme });
+            return generateOutlinedStyle({ borderColor, hovered, pressed, activeColor });
+        } else if (variant === 'text') {
+            const underlineColor = paletteColor(color)({ theme, darkModeEnabled });
+            const hovered = buttonColor(color, 'hovered')({ theme });
+            const pressed = buttonColor(color, 'pressed')({ theme });
+            return generateTextStyles({ underlineColor, hovered, pressed });
+        } else if (iconOnly) {
+            return generateIconOnlyStyles();
+        } else {
+            return '';
+        }
     }}
-  ${({ variant, theme, color = 'primary', darkModeEnabled }) =>
-        variant === 'outlined' &&
-        `
-            border-color: ${paletteColor(color)({ theme, darkModeEnabled })};
-            color: ${paletteColor(color)({ theme, darkModeEnabled })};
-            :hover {
-                border-color: ${buttonColor(color, 'hovered')({ theme })};
-                color: ${paletteColor(color)({ theme, darkModeEnabled })};
-            }
-            :active {
-                border-color: ${buttonColor(color, 'pressed')({ theme })};
-                color: ${paletteColor(color)({ theme })};
-            }
-        `}
-  ${({ variant, theme, color = 'primary', darkModeEnabled }) =>
-        variant === 'text' &&
-        `
-            text-decoration: underline 1px !important;
-            text-underline-offset: 4px;
-            padding: 0;
-            min-width: auto;
-            background-color: transparent !important;
-            text-decoration-color: ${paletteColor(color)({ theme, darkModeEnabled })};
-            color: ${paletteColor(color)({ theme, darkModeEnabled })};
-            :hover {
-                color:  ${buttonColor(color, 'hovered')({ theme })};
-                text-decoration-color:  ${buttonColor(color, 'hovered')({ theme })};
-            }
-            :active {
-                color: ${paletteColor(color)};
-                text-decoration-color:  ${buttonColor(color, 'pressed')({ theme })};
-            }
-        `}
-  ${({ iconOnly }) =>
-        iconOnly &&
-        `
-            padding: 10px;
-            min-width: unset;
-        `}
 `;
 
 export default StyledButton;