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

package/src/common/button/NsButton.tsx

@@ -4,12 +4,11 @@ import { useTheme } from '@mui/material/styles';
 import StyledButton from './NsButton.styled';
 
 import { NsButtonProps } from './types.d';
-import { FoundationTheme } from '@nuskin/foundation-theme';
 
 const NsButton = ({ children, darkModeEnabled = true, ...props }: PropsWithChildren<NsButtonProps>) => {
     const { color } = props;
     const { palette } = useTheme();
-    const btnColor = (color && palette?.[color] ? color : 'primary') as FoundationTheme.PaletteColors;
+    const btnColor = color && palette?.[color] ? color : 'primary';
     return (
         <StyledButton {...props} color={btnColor} disableRipple darkModeEnabled={darkModeEnabled}>
             {children}

package/src/common/button/helper.ts

@@ -0,0 +1,82 @@
+type ContainedParams = {
+    backgroundColor: string;
+    textColor: string;
+    hovered: string;
+    pressed: string;
+    focused: string;
+};
+
+export function generateContainedStyle({
+    backgroundColor,
+    textColor,
+    hovered,
+    pressed,
+    focused,
+}: ContainedParams): string {
+    return `
+		background-color: ${backgroundColor};
+		color: ${textColor} !important;
+		&:hover {
+			background-color: ${hovered};
+		}
+		&:active {
+			background-color: ${pressed};
+		}
+		&:focus {
+			background-color: ${focused};
+		}
+	`;
+}
+type OutlinedParams = {
+    borderColor: string;
+    hovered: string;
+    pressed: string;
+    activeColor: string;
+};
+export function generateOutlinedStyle({ borderColor, hovered, pressed, activeColor }: OutlinedParams) {
+    return `
+		border-color: ${borderColor};
+		color: ${borderColor};
+		&:hover {
+				border-color: ${hovered};
+				color: ${borderColor};
+		}
+		&:active {
+				border-color: ${pressed};
+				color: ${activeColor};
+		}
+`;
+}
+
+type TextParams = {
+    underlineColor: string;
+    hovered: string;
+    pressed: string;
+};
+
+export function generateTextStyles({ underlineColor, hovered, pressed }: TextParams): string {
+    return `
+    text-decoration: underline 1px !important;
+    text-underline-offset: 4px;
+    padding: 0;
+    min-width: auto;
+    background-color: transparent !important;
+    text-decoration-color: ${underlineColor};
+    color: ${underlineColor};
+    &:hover {
+      color: ${hovered};
+      text-decoration-color: ${hovered};
+    }
+    &:active {
+      color: ${underlineColor};
+      text-decoration-color: ${pressed};
+    }
+  `;
+}
+
+export function generateIconOnlyStyles() {
+    return `
+			padding: 10px;
+	    min-width: unset;
+    `;
+}

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

@@ -14,6 +14,8 @@ export type NsButtonProps = Pick<
   | 'onFocus'
   | 'aria-label'
   | 'className'
+  | 'startIcon'
+  | 'endIcon'
 > & {
   iconOnly?: boolean;
   darkModeEnabled?: boolean;

package/src/common/card/stories/NsBgCard.stories.tsx

@@ -8,7 +8,7 @@ type MetaStory = Meta<ComponentType>;
 
 export default {
     component: NsBgCard,
-    title: 'Components/NsCard/NsBgCard',
+    title: 'Components/Containers/Card/NsBgCard',
     argTypes: {},
     args: {
         title: 'ageLOC LumiSpa',

package/src/common/card/stories/NsBrandProductCard.stories.tsx

@@ -8,7 +8,7 @@ type MetaStory = Meta<ComponentType>;
 
 export default {
     component: NsBrandProductCard,
-    title: 'Components/NsCard/NsBrandProductCard',
+    title: 'Components/Containers/Card/NsBrandProductCard',
     argTypes: {},
     decorators: [withCenterDecorator],
 } as MetaStory;

package/src/common/card/stories/NsFfgCard.stories.tsx

@@ -10,7 +10,7 @@ type MetaStory = Meta<ComponentType>;
 
 export default {
     component: NsFfgCard,
-    title: 'Components/NsCard/NsFfgCard',
+    title: 'Components/Containers/Card/NsFfgCard',
     argTypes: {},
     decorators: [withCenterDecorator],
 } as MetaStory;
@@ -19,8 +19,10 @@ export const Default: Story = {
     args: {
         actionText: 'LEARN MORE',
         actionLink: 'https://www.forceforgood.org/',
+        // eslint-disable-next-line max-len
         text: 'Every child deserves a chance to shine. Through our Nu Skin Force for Good Foundation, we’re empowering children around the world with hope for a brighter future.',
         topImageUrl:
+            // eslint-disable-next-line max-len
             'https://images.contentstack.io/v3/assets/blt594f30e2dc643eae/blt34cdb300dc9b93ff/645ccaa7520ba1a1af13a08a/nsffg-foundation.webp',
         topImageAlt: 'Force for Good Foundation',
         additionalProps: {
@@ -31,8 +33,9 @@ export const Default: Story = {
         const canvas = within(canvasElement);
         await userEvent.hover(canvas.getByTestId('ffg-card'));
         await userEvent.hover(canvas.getByRole('link'));
-        await expect(
+        expect(
             canvas.getByText(
+                // eslint-disable-next-line max-len
                 'Every child deserves a chance to shine. Through our Nu Skin Force for Good Foundation, we’re empowering children around the world with hope for a brighter future.'
             )
         ).toBeInTheDocument();

package/src/common/card/styled/NsFfgStyled.tsx

@@ -41,4 +41,4 @@ const Component = () => {
         },
     };
 };
-export const NsFfgStyled = styled(Box, options)<{}>(Component);
+export const NsFfgStyled = styled(Box, options)(Component);

package/src/common/carousal/stories/NSCarousal.stories.tsx

@@ -9,7 +9,7 @@ type Story = StoryObj<ComponentType>;
 type MetaStory = Meta<ComponentType>;
 
 export default {
-    title: 'Components/NsCarousal/Brand',
+    title: 'Components/Containers/NsCarousal/Brand',
     component: NsCarousal,
     argTypes: {},
 } as MetaStory;

package/src/common/carousal/stories/NsScrollingCarousal.stories.tsx

@@ -34,7 +34,7 @@ export const slides = [
     },
 ];
 export default {
-    title: 'Components/NsCarousal/NsScrollingCarousal',
+    title: 'Components/Containers/NsCarousal/NsScrollingCarousal',
     component: NsScrollingCarousal,
     decorators: [withCenterDecorator],
     argTypes: {},

package/src/common/cart-icon/NsCartIcon.stories.tsx

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

package/src/common/checkbox/NsCheckbox.stories.tsx

@@ -13,7 +13,7 @@ type MetaStory = Meta<ComponentType>;
 const labelText = 'Checkbox Label';
 // In this case, we're only passing the label prop.
 export default {
-    title: 'Components/NsCheckbox',
+    title: 'Components/Inputs/NsCheckbox',
     component: NsCheckbox,
     decorators: [withCenterDecorator],
     argTypes: {

package/src/common/checkbox/NsCheckbox.styled.tsx

@@ -1,19 +1,18 @@
 /**
  * @author [vijayaprathap Kumar] (vpkumar@nuskin.com)
- * checkbox.tsx
  * @description Styled Components for Checkbox
  */
 import DoneIcon from '@mui/icons-material/Done';
 
-import { styled } from '@nuskin/foundation-theme';
+import { styled, ColorUtils } from '@nuskin/foundation-theme';
 import { NsFlag } from '../flag';
-
+const { paletteColor, buttonColor } = ColorUtils;
 /**
  * Wrapper BpIcon for checkbox.tsx
  * @params ( theme: { palette }) / Provide the color's to contaier from @nuskin/foundation-theme
  */
 
-export const BpIcon = styled(DoneIcon)(({ theme: { palette } }) => ({
+export const BpIcon = styled(DoneIcon)(({ theme }) => ({
     border: '1px solid #8C8C8C',
     path: {
         display: 'none',
@@ -25,31 +24,31 @@ export const BpIcon = styled(DoneIcon)(({ theme: { palette } }) => ({
         outline: '3px solid #94D6E9',
     },
     'input:disabled ~ &': {
-        background: palette?.primary?.buttonState?.hovered,
+        background: buttonColor('primary', 'hovered')({ theme }),
     },
 }));
 
 /**
  * Wrapper BpCheckedIcon for checkbox.tsx
- * @params ( theme: { palette }) / Provide the color's to contaier from @nuskin/foundation-theme
+ * @params ( theme: { palette }) / Provide the color's to container from @nuskin/foundation-theme
  */
 
-export const BpCheckedIcon = styled(BpIcon)(({ theme: { palette } }) => ({
+export const BpCheckedIcon = styled(BpIcon)(({ theme }) => ({
     path: {
         display: 'block',
     },
-    background: palette?.primary?.main ?? '#fff',
-    color: palette?.primary?.contrastText ?? '#000',
+    background: paletteColor('primary', 'main')({ theme }),
+    color: paletteColor('primary', 'contrastText')({ theme }),
 }));
 
-export const StyledLabel = styled('span')<{ $hasDisabled: boolean }>`
-    ${({ $hasDisabled, theme: { palette } }) =>
-        $hasDisabled &&
-        `
-    color: ${palette?.primary?.buttonState?.hovered};
-`}
-`;
+const getLabelColor = (isDisabled: boolean, color: string) => (!isDisabled ? '' : `color: ${color}`);
 
+export const StyledLabel = styled('span')<{ isDisabled: boolean }>`
+    ${({ isDisabled, theme }) => {
+        const color = buttonColor('primary', 'hovered')({ theme });
+        return getLabelColor(isDisabled, color);
+    }}
+`;
 export const StyledFlagLabel = styled(NsFlag)`
     margin-right: 16px;
 `;

package/src/common/checkbox/NsCheckbox.tsx

@@ -54,7 +54,7 @@ const NsCheckbox = (props: PropsWithChildren<NsCheckboxProps>) => {
         () => (
             <NsTypography variant="p-l">
                 <StyledFlagLabel {...flag} size={size} testId={`${name}-flag-label`} />
-                <StyledLabel className="checkbox-label-text" $hasDisabled={disabled}>
+                <StyledLabel className="checkbox-label-text" isDisabled={disabled}>
                     {label}
                 </StyledLabel>
             </NsTypography>

package/src/common/column-control/stories/DivArray.stories.tsx

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

package/src/common/column-control/stories/NsColumnControl.stories.tsx

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

package/src/common/column-control/stories/NsFlexColumns.stories.tsx

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

package/src/common/column-control/stories/NsGridColumns.stories.tsx

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

package/src/common/column-control/styled/common.ts

@@ -21,7 +21,7 @@ export const commonStyles = {
    ['1','2'] => ['27%','53%']
  */
 export function getPercentArray(fractionArray?: string[] | number[]) {
-    let numbers = fractionArray?.map((numberString) => +numberString)?.filter((num) => 0 < num && num < 10) ?? [];
+    const numbers = fractionArray?.map((numberString) => +numberString)?.filter((num) => 0 < num && num < 10) ?? [];
     const sum = numbers.reduce((currentSum, currentNumber) => currentSum + currentNumber, 0);
     return numbers.map((currentNumber) => ((currentNumber / sum) * 80).toFixed(2) + '%');
 }

package/src/common/column-control/utils.ts

@@ -40,15 +40,15 @@ const sizeKeyMap: Record<ValueOf<typeof sizeKeyPrefix>, string> = {
  * @returns {fractions:['1','1','1'], tabletFractions:['1','1'], mobileFractions:['1'] }
  */
 export const getColumnSizes = (inputColumnClass: string): sizeObjectType => {
-    let columnClass = inputColumnClass.trim() as NsColumnControlProps['columnClass'];
+    const columnClass = inputColumnClass.trim();
     const validClasses = columnClass
         .split(' ')
         .filter((e) => Object.values(sizeKeyPrefix).some((prefix) => e.startsWith(prefix)));
     const sizeObject: sizeObjectType = validClasses.reduce((acc: any, current: string) => {
-        for (let key of Object.values(sizeKeyPrefix)) {
+        for (const key of Object.values(sizeKeyPrefix)) {
             if (current.startsWith(key)) {
-                let interClass = current.replace(key, '');
-                let sizes = interClass.split('-').filter((e) => /^[1-9]$/.test(e));
+                const interClass = current.replace(key, '');
+                const sizes = interClass.split('-').filter((e) => /^[1-9]$/.test(e));
                 acc[sizeKeyMap[key]] = sizes;
                 break;
             }

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

@@ -1,12 +1,22 @@
+import { FoundationTheme } from '@nuskin/foundation-theme';
+
 export type ContentStackLiveTags = {
     'data-cslp'?: string;
 };
 
 export type AdditionalProps = {
-    darkModeEnabled?: boolean;
     additionalProps?: {
         ariaLabel?: string;
         testid?: string;
         className?: string;
+        'data-testid'?: string;
     } & ContentStackLiveTags;
+} & DarkModeEnabledOption;
+
+export type Themed = {
+    theme: FoundationTheme.Theme;
+};
+
+export type DarkModeEnabledOption = {
+    darkModeEnabled?: boolean;
 };

package/src/common/dropdown/NsDropdown.styled.tsx

@@ -1,5 +1,6 @@
 import { styled, ColorUtils, FoundationTheme } from '@nuskin/foundation-theme';
-const { getPaletteColor, getAppColor } = ColorUtils;
+import { Themed } from '../common.types';
+const { color, paletteColor, isDarkMode } = ColorUtils;
 
 export const DropdownContainer = styled.div<{ disabled: boolean }>`
     position: relative;
@@ -7,15 +8,22 @@ export const DropdownContainer = styled.div<{ disabled: boolean }>`
     opacity: ${({ disabled }) => (disabled ? '0.5' : '1')};
 `;
 
+/** this function also used for SelectHead */
+export const getDropdownHeadBorder = ({ type, theme }: { type: string } & Themed) => {
+    if (type === 'outlined') {
+        const borderColor = color('primary', 'black')({ theme });
+        return `1px solid ${borderColor}`;
+    }
+    return 'none';
+};
 export const DropdownHead = styled.div<{ type: string; disabled: boolean }>`
     cursor: ${({ disabled }) => (disabled ? 'inherit' : 'pointer')};
     padding: 5px 10px;
     display: flex;
     justify-content: space-between;
     align-items: center;
-    border: ${({ type, theme }) =>
-        type === 'outlined' ? `1px solid ${getAppColor(theme, 'primary', 'black')}` : 'none'};
-    color: ${({ theme }) => getPaletteColor(theme, 'primary')};
+    border: ${getDropdownHeadBorder}
+    color: ${paletteColor('primary')};
 `;
 
 export const DropdownButton = styled.div`
@@ -25,27 +33,19 @@ export const DropdownButton = styled.div`
 export const DropdownList = styled.div<{ borderColor: FoundationTheme.PaletteColors }>`
     position: absolute;
     z-index: 100;
-    border: 1px solid ${({ borderColor, theme }) => getPaletteColor(theme, borderColor)};
+    border: 1px solid ${({ borderColor, theme }) => paletteColor(borderColor)({ theme })};
     padding: 0;
     margin: 0;
     width: 100%;
-    color: ${({ theme }) => getPaletteColor(theme, 'primary', 'main')};
-    background-color: ${({ theme }) => getPaletteColor(theme, 'primary', 'contrastText')};
+    color: ${paletteColor('primary', 'main')};
+    background-color: ${paletteColor('primary', 'contrastText')};
 `;
-const getIsLight = (theme: FoundationTheme.Theme) => {
-    const { palette = { primary: { main: '', contrastText: '' } } } = theme;
-    return palette.primary.main === getAppColor(theme, 'primary', 'black');
-};
 
 const getDividerColor = (theme: FoundationTheme.Theme) => {
-    const isLight = getIsLight(theme);
-    const dividerColor = isLight ? getAppColor(theme, 'neutral', '30') : getAppColor(theme, 'neutral', '20');
-    return dividerColor;
+    return color('neutral', isDarkMode({ theme }) ? '20' : '30')({ theme });
 };
 const getListBgColor = (theme: FoundationTheme.Theme) => {
-    const isLight = getIsLight(theme);
-    const bgColor = isLight ? getAppColor(theme, 'accentColorB', '10') : getAppColor(theme, 'accentColorB', '50');
-    return bgColor;
+    return color('accentColorB', isDarkMode({ theme }) ? '50' : '10')({ theme });
 };
 export const ListItemContainer = styled.div<{ showListDivider: boolean }>`
     cursor: pointer;
@@ -61,7 +61,12 @@ export const ListItemContainer = styled.div<{ showListDivider: boolean }>`
     }
 `;
 
+const getBorder = ({ isSelected, theme }: { isSelected: boolean } & Themed) => {
+    const borderColor = paletteColor('primary')({ theme });
+    return isSelected ? `2px solid ${borderColor}` : 'none';
+};
+
 export const ListItem = styled.span<{ isSelected: boolean }>`
     padding: 5px 10px;
-    border-left: ${({ isSelected, theme }) => (isSelected ? `2px solid ${getPaletteColor(theme, 'primary')}` : 'none')};
+    border-left: ${getBorder};
 `;

package/src/common/dropdown/stories/NsDropdown.stories.tsx

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

package/src/common/dropdown/stories/NsDropdownCountry.stories.tsx

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

package/src/common/flag/NsFlag.stories.tsx

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

package/src/common/hooks/index.ts

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

package/src/common/hooks/specs/useWindowSize.spec.tsx

@@ -0,0 +1,19 @@
+import { renderHook, act } from '@testing-library/react-hooks';
+import useWindowSize from '../useWindowSize';
+
+describe('useWindowSize', () => {
+    it('should return the window size', () => {
+        const { result } = renderHook(useWindowSize);
+        expect(result.current).toEqual({ width: window.innerWidth, height: window.innerHeight });
+    });
+
+    it('should update the window size when the window is resized', () => {
+        const { result } = renderHook(() => useWindowSize());
+        act(() => {
+            window.innerWidth = 500;
+            window.innerHeight = 500;
+            window.dispatchEvent(new Event('resize'));
+        });
+        expect(result.current).toEqual({ width: 500, height: 500 });
+    });
+});

package/src/common/hooks/useAccordionMap.tsx

@@ -0,0 +1,39 @@
+import { useState, useEffect, useCallback } from 'react';
+
+type ItemMap = Record<string, boolean>;
+type UseAccordionProp = {
+    allowMultipleExpanded?: boolean;
+    defaultOpenIds?: string[];
+};
+const reducer = (map: ItemMap, id: string) => {
+    map[id] = true;
+    return map;
+};
+
+const useAccordionMap = ({ allowMultipleExpanded, defaultOpenIds }: UseAccordionProp) => {
+    const mapSetter = useCallback(() => {
+        let ids = defaultOpenIds;
+        if (!allowMultipleExpanded) {
+            ids = ids?.slice(0, 1) ?? [];
+        }
+        return ids?.reduce(reducer, {}) ?? {};
+    }, [defaultOpenIds, allowMultipleExpanded]);
+
+    const [itemStateMap, setItemMap] = useState<ItemMap>(mapSetter);
+
+    const toggleOpen = (index: string | number) => {
+        const key = index + '';
+        if (allowMultipleExpanded) {
+            setItemMap((prevState) => ({ ...prevState, [key]: !prevState[key] }));
+        } else {
+            setItemMap({ [key]: !itemStateMap[index] });
+        }
+    };
+
+    useEffect(() => {
+        setItemMap(mapSetter);
+    }, [mapSetter]);
+    return { itemStateMap, toggleOpen };
+};
+
+export default useAccordionMap;

package/src/common/hooks/useWindowSize.tsx

@@ -0,0 +1,30 @@
+import { useState, useEffect } from 'react';
+
+const useWindowSize = () => {
+    const [windowSize, setWindowSize] = useState({
+        width: window.innerWidth,
+        height: window.innerHeight,
+    });
+
+    useEffect(() => {
+        function handleResize() {
+            setWindowSize({
+                width: window?.innerWidth || 300,
+                height: window?.innerHeight || 300,
+            });
+        }
+        if (typeof window !== 'undefined') {
+            window.addEventListener('resize', handleResize);
+        }
+
+        return () => {
+            if (typeof window !== 'undefined') {
+                window.removeEventListener('resize', handleResize);
+            }
+        };
+    }, []);
+
+    return windowSize;
+};
+
+export default useWindowSize;

package/src/common/icon/NsIcon.stories.tsx

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

package/src/common/icon/NsIconVariants.ts

@@ -45,3 +45,4 @@ const IconVariants = {
 };
 
 export default IconVariants;
+export const isValidIconName = (name: string) => Object.keys(IconVariants).includes(name);