playbook_ui 13.1.0 → 13.2.0

data/app/pb_kits/playbook/pb_nav/_item.tsx

@@ -1,42 +1,64 @@
-import React from 'react'
-import classnames from 'classnames'
+import React from "react";
+import classnames from "classnames";
 
-import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
-import { globalProps, GlobalProps } from '../utilities/globalProps'
+import { buildAriaProps, buildCss, buildDataProps } from "../utilities/props";
+import { globalProps, GlobalProps } from "../utilities/globalProps";
 
-import Icon from '../pb_icon/_icon'
-import Image from '../pb_image/_image'
-import Collapsible from '../pb_collapsible/_collapsible'
+import Icon from "../pb_icon/_icon";
+import Image from "../pb_image/_image";
+import Collapsible from "../pb_collapsible/_collapsible";
+import { NavChildProps } from "./navTypes";
+import { Spacing } from "../types";
 
 type NavItemProps = {
-  active?: boolean,
-  aria?: { [key: string]: string },
-  fontWeight?: "regular" | "bold" | "bolder",
-  children?: React.ReactNode[] | React.ReactNode,
-  className?: string,
-  collapsible?: boolean,
-  data?: object,
-  dark?: boolean,
-  fontSize?: "normal" | "small",
-  iconLeft?: string,
-  iconRight?: string | string[],
-  onIconRightClick?: () => void,
-  onIconLeftClick?: () => void,
-  id?: string,
-  imageUrl?: string,
-  link?: string,
-  onClick?: () => void,
-  target?: '_blank' | '_self' | '_parent' | '_top',
-  text: string,
-  collapsibleTrail?: boolean,
-  collapsed?: boolean
-} & GlobalProps
+  active?: boolean;
+  aria?: { [key: string]: string };
+  fontWeight?: "regular" | "bold" | "bolder";
+  children?: React.ReactNode[] | React.ReactNode;
+  className?: string;
+  collapsible?: boolean;
+  data?: object;
+  dark?: boolean;
+  fontSize?: "normal" | "small";
+  iconLeft?: string;
+  iconRight?: string | string[];
+  onIconRightClick?: () => void;
+  onIconLeftClick?: () => void;
+  id?: string;
+  imageUrl?: string;
+  link?: string;
+  onClick?: () => void;
+  target?: "_blank" | "_self" | "_parent" | "_top";
+  text: string;
+  collapsibleTrail?: boolean;
+  collapsed?: boolean;
+  orientation?: "vertical" | "horizontal";
+  variant?: "normal" | "subtle";
+  margin?: Spacing;
+  marginBottom?: Spacing;
+  marginTop?: Spacing;
+  marginRight?: Spacing;
+  marginLeft?: Spacing;
+  marginX?: Spacing;
+  marginY?: Spacing;
+} & GlobalProps;
 
 const NavItem = (props: NavItemProps) => {
+  
+  const fontWeightDefault = (orientation: string, variant: string) => {
+    return orientation === "horizontal" && variant === "subtle"
+      ? "regular"
+      : orientation === "horizontal" && variant === "normal"
+      ? "bold"
+      : "regular";
+  };
+
   const {
     active = false,
     aria = {},
-    fontWeight = "regular",
+    orientation,
+    variant,
+    fontWeight = fontWeightDefault(orientation, variant),
     children,
     className,
     collapsible,
@@ -50,129 +72,212 @@ const NavItem = (props: NavItemProps) => {
     id,
     imageUrl,
     link,
-    onClick = () => { },
-    target = '_self',
-    text = '',
+    onClick = () => {},
+    target = "_self",
+    text = "",
     collapsibleTrail,
-    collapsed
-  } = props
-
-  const Tag = link ? 'a' : 'div'
-  const activeClass = active === true ? 'active' : ''
-  const collapsibleTrailClass = collapsible && collapsibleTrail ? 'collapsible_trail' : ''
-  const fontSizeClass = fontSize === 'small' ? "font_size_small" : "font_size_normal"
-  const fontWeightClass = fontWeight === 'bold' ? "font_bold" : fontWeight === 'bolder' ? "font_bolder" : "font_regular"
-  const ariaProps = buildAriaProps(aria)
-  const dataProps = buildDataProps(data)
-  const classes = classnames(buildCss('pb_nav_list_kit_item', activeClass), 
-                  collapsible ? buildCss('pb_collapsible_nav_item', activeClass, collapsibleTrailClass) : '', 
-                  fontSizeClass,
-                  fontWeightClass,
-                  globalProps(props), 
-                  className)
-
-
-  const handleIconClick = (e:any) => {
-    if (onIconLeftClick) {
-    e.stopPropagation();
-    onIconLeftClick()
+    collapsed,
+    itemSpacing,
+    margin,
+    marginBottom,
+    marginTop,
+    marginRight,
+    marginLeft,
+    marginX,
+    marginY,
+  } = props;
+
+  const spacingMarginProps = {
+    margin,
+    marginBottom,
+    marginTop,
+    marginRight,
+    marginLeft,
+    marginX,
+    marginY,
+  };
+
+//separate margin props and padding props  in itemSpacing object 
+const filterItemSpacing = (obj: { [key: string]: string }) => {
+  const filteredPadding: { [key: string]: string } = {};
+  const filteredMargin: { [key: string]: string } = {};
+  for (const key in obj) {
+    if (key.startsWith('padding')) {
+      filteredPadding[key] = obj[key];
+    } else if (key.startsWith('margin')) {
+      filteredMargin[key] = obj[key];
     }
   }
+  return { filteredPadding, filteredMargin };
+};
+
+//deconstruct itemSpacing
+const { filteredPadding, filteredMargin } = filterItemSpacing(itemSpacing);
+
+//if itemSpacing has margin props, apply those, if margin global props passed to navItem itself, navItem props take precendence 
+  const finalItemSpacing = {
+    ...(filteredMargin || {}),
+    ...Object.entries(spacingMarginProps).reduce((acc: any, [prop, value]) => {
+      if (value) {
+        acc[prop] = value;
+      }
+      return acc;
+    }, {}),
+  };
+
+  //custom for collapsible only, to apply margin to correct div
+  const filteredProps = { ...props };
+  delete filteredProps?.margin;
+  delete filteredProps?.marginX;
+  delete filteredProps?.marginY;
+  delete filteredProps?.marginBottom;
+  delete filteredProps?.marginTop;
+  delete filteredProps?.marginRight;
+  delete filteredProps?.marginLeft;
+
+
+  const Tag = link ? "a" : "div";
+  const activeClass = active === true ? "active" : "";
+  const collapsibleTrailClass = collapsible && collapsibleTrail ? "collapsible_trail" : "";
+
+  const fontSizeMapping = {
+    "small": "font_size_small",
+    "normal": "font_size_normal"
+  };
+    
+  const fontWeightMapping = {
+    "bold": "font_bold",
+    "bolder": "font_bolder",
+    "regular": "font_regular"
+  };
+    
+  const fontSizeClass = fontSizeMapping[fontSize];
+  const fontWeightClass = fontWeightMapping[fontWeight];
+
+  const ariaProps = buildAriaProps(aria);
+  const dataProps = buildDataProps(data);
+
+  const tagClasses = classnames(
+    collapsible ? "pb_nav_list_item_link_collapsible" : "pb_nav_list_item_link",
+  );
+
+  const classes = classnames(
+    buildCss("pb_nav_list_kit_item", activeClass),
+    collapsible
+      ? buildCss("pb_collapsible_nav_item", activeClass)
+      : "",
+    fontSizeClass,
+    fontWeightClass,
+    tagClasses,
+    collapsible ? globalProps(filteredProps, {...filteredPadding}) : globalProps(props, {...itemSpacing}),
+    className
+  );
+
+  const handleIconClick = (e: any) => {
+    if (onIconLeftClick) {
+      e.stopPropagation();
+      onIconLeftClick();
+    }
+  };
+
+
+  // Map over the children and clone them with itemSpacing prop so nested navItems all get itemSpacing
+  const childrenWithProps = React.Children.map(children, (child) => {
+    if (React.isValidElement(child)) {
+      const childProps: NavChildProps = {
+        itemSpacing: itemSpacing,
+      };
+      return React.cloneElement(child, childProps);
+    }
+    return child;
+  });
+
+  const collapsibleClasses = buildCss("collapsible_nav_wrapper", activeClass, collapsibleTrailClass)
 
   return (
-    <li
-      {...ariaProps}
-      {...dataProps}
-      className={classes}
-      id={id}
-    >
-      {
-        collapsible ? (
-          <Collapsible icon={iconRight ? iconRight : ['plus','minus']} 
-            iconSize="xs" 
+    <>
+      {collapsible ? (
+        <>
+          <Collapsible
+            className={collapsibleClasses}
+            icon={iconRight && iconRight}
+            iconSize="xs"
             id={id}
             collapsed={collapsed}
             onIconClick={onIconRightClick}
             onClick={onClick}
           >
-          <Collapsible.Main dark={dark}>
-          <Tag
-          className="pb_nav_list_item_link_collapsible"
-          href={link}
-          target={target}
-        >
-          {imageUrl &&
-            <div
-              className="pb_nav_list_item_icon_section_collapsible"
-              key={imageUrl}
-              onClick={(e)=>handleIconClick(e)}
-            >
-              <Image
-                className="pb_nav_img_wrapper"
-                url={imageUrl}
-              />
-            </div>
-          }
-  
-          {iconLeft &&
-            <div
-              className="pb_nav_list_item_icon_section_collapsible"
-              key={iconLeft}
-              onClick={(e)=>handleIconClick(e)}
-            >
-              <Icon
-                className="pb_nav_list_item_icon_left_collapsible"
-                fixedWidth
-                icon={iconLeft}
-              />
-            </div>
-          }
-           <span className="pb_nav_list_item_text_collapsible">
-            {text}
-          </span>
-        </Tag>
-        </Collapsible.Main>
-        <Collapsible.Content>
-        {children}
-        </Collapsible.Content>
-        </Collapsible>
-        ) : (
+            <Collapsible.Main 
+            className={globalProps({ ...finalItemSpacing })}
+            dark={dark}>
+              <Tag
+                {...ariaProps}
+                {...dataProps}
+                className={classes}
+                id={id}
+                href={link}
+                target={target}
+              >
+                {imageUrl && (
+                  <div
+                    className="pb_nav_list_item_icon_section_collapsible"
+                    key={imageUrl}
+                    onClick={(e) => handleIconClick(e)}
+                  >
+                    <Image className="pb_nav_img_wrapper" url={imageUrl} />
+                  </div>
+                )}
+
+                {iconLeft && (
+                  <div
+                    className="pb_nav_list_item_icon_section_collapsible"
+                    key={iconLeft}
+                    onClick={(e) => handleIconClick(e)}
+                  >
+                    <Icon
+                      className="pb_nav_list_item_icon_left_collapsible"
+                      fixedWidth
+                      icon={iconLeft}
+                    />
+                  </div>
+                )}
+                <span className="pb_nav_list_item_text_collapsible">
+                  {text}
+                </span>
+              </Tag>
+            </Collapsible.Main>
+            <Collapsible.Content>{childrenWithProps}</Collapsible.Content>
+          </Collapsible>
+        </>
+      ) : (
         <Tag
-          className="pb_nav_list_item_link"
+          {...ariaProps}
+          {...dataProps}
+          className={classes}
+          id={id}
           href={link}
           onClick={onClick}
           target={target}
         >
-          {imageUrl &&
-            <div
-              className="pb_nav_list_item_icon_section"
-              key={imageUrl}
-            >
-              <Image
-                className="pb_nav_img_wrapper"
-                url={imageUrl}
-              />
+          {imageUrl && (
+            <div className="pb_nav_list_item_icon_section" key={imageUrl}>
+              <Image className="pb_nav_img_wrapper" url={imageUrl} />
             </div>
-          }
-  
-          {iconLeft &&
-            <div
-              className="pb_nav_list_item_icon_section"
-              key={iconLeft}
-            >
+          )}
+
+          {iconLeft && (
+            <div className="pb_nav_list_item_icon_section" key={iconLeft}>
               <Icon
                 className="pb_nav_list_item_icon_left"
                 fixedWidth
                 icon={iconLeft}
               />
             </div>
-          }
-  
-          <span className="pb_nav_list_item_text">
-            {text || children}
-          </span>
-  
-          {iconRight &&
+          )}
+
+          <span className="pb_nav_list_item_text">{text || children}</span>
+
+          {iconRight && (
             <div
               className="pb_nav_list_item_icon_section"
               key={iconRight as string}
@@ -183,12 +288,11 @@ const NavItem = (props: NavItemProps) => {
                 icon={iconRight as string}
               />
             </div>
-          }
+          )}
         </Tag>
-        )
-      }
-    </li>
-  )
-}
+      )}
+    </>
+  );
+};
 
-export default NavItem
+export default NavItem;

data/app/pb_kits/playbook/pb_nav/_nav.scss

@@ -5,3 +5,41 @@
 @import "./vertical_nav";
 @import "./horizontal_nav";
 @import "./collapsible_nav";
+
+[class^="pb_nav_list"] {
+  //classes for fontSize and fontWeight props
+  .font_size_small {
+    .pb_nav_list_item_text,
+    .pb_nav_list_item_text_collapsible {
+      font-size: $font_small;
+    }
+  }
+
+  .font_size_normal {
+    .pb_nav_list_item_text,
+    .pb_nav_list_item_text_collapsible {
+      font-size: $font_normal;
+    }
+  }
+
+  .font_bolder {
+    .pb_nav_list_item_text,
+    .pb_nav_list_item_text_collapsible {
+      font-weight: $bolder !important;
+    }
+  }
+
+  .font_bold {
+    .pb_nav_list_item_text,
+    .pb_nav_list_item_text_collapsible {
+      font-weight: $bold !important;
+    }
+  }
+
+  .font_regular {
+    .pb_nav_list_item_text,
+    .pb_nav_list_item_text_collapsible {
+      font-weight: $regular;
+    }
+  }
+}

data/app/pb_kits/playbook/pb_nav/_nav.tsx

@@ -5,6 +5,7 @@ import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
 import { globalProps, GlobalProps } from '../utilities/globalProps'
 
 import Caption from '../pb_caption/_caption'
+import { SpacingObject, NavChildProps } from './navTypes'
 
 type NavProps = {
   aria?: { [key: string]: string },
@@ -20,6 +21,7 @@ type NavProps = {
   link?: string,
   title?: string,
   variant?: "normal" | "subtle",
+  itemSpacing?: SpacingObject
 } & GlobalProps
 
 const Nav = (props: NavProps) => {
@@ -37,6 +39,7 @@ const Nav = (props: NavProps) => {
     orientation = 'vertical',
     title = '',
     variant = 'normal',
+    itemSpacing,
   } = props
 
   const ariaProps = buildAriaProps(aria)
@@ -50,6 +53,19 @@ const Nav = (props: NavProps) => {
     className
   )
 
+// Map over the children and clone them with orientation, variant and itemSpacing props to gain access to them in navItem
+const childrenWithProps = React.Children.map(children, (child) => {
+  if (React.isValidElement(child)) {
+    const childProps: NavChildProps = {
+      orientation: orientation,
+      variant: variant,
+      itemSpacing: itemSpacing
+    };
+    return React.cloneElement(child, childProps);
+  }
+  return child;
+});
+
   return (
     <nav
       {...ariaProps}
@@ -72,7 +88,7 @@ const Nav = (props: NavProps) => {
           </a>
         </div>
       }
-      <ul>{children}</ul>
+      <div className='pb_nav_wrapper'>{childrenWithProps}</div>
     </nav>
   )
 }

data/app/pb_kits/playbook/pb_nav/_subtle_mixin.scss

@@ -1,12 +1,11 @@
 @import "tokens/typography";
 
 @mixin subtle {
-  [class*=pb_nav_list_kit_item] {
-    list-style: none;
+  [class*="pb_nav_list_kit_item"][class*="pb_nav_list_item"] {
     border-radius: $border_rad_heavier;
     border-bottom: 0;
     margin: $space_xs ($space_sm - 2px);
-    [class*=_link] {
+    &[class*="_link"] {
       text-decoration: none;
       display: flex;
       align-items: center;
@@ -17,31 +16,30 @@
       transition-timing-function: $bezier;
       border-radius: $border_rad_heavier;
       @include pb_body($text_lt_default);
-      [class*=_icon_left] {
+      [class*="_icon_left"] {
         margin-right: ($space_xs + 2px);
         color: $text_lt_lighter;
       }
-      [class*=_icon_right] {
+      [class*="_icon_right"] {
         margin-left: ($space_xs + 2px);
         color: $text_lt_default;
       }
-      [class*=_text] {
+      [class*="_text"] {
         flex: 1;
       }
       &:hover {
         background-color: rgba($primary, 0.03);
-        [class*=_icon] {
+        [class*="_icon"] {
           color: $primary;
         }
-        [class*=_text] {
+        [class*="_text"] {
           color: $primary;
         }
       }
     }
-    &[class*=_active] [class*=_link] {
-      @include pb_title_4;
+    &[class*="_active"] {
       color: $primary;
       letter-spacing: normal;
     }
   }
-}
+}