@basic-ui/material 1.0.0-alpha.5 → 1.0.0-alpha.8

package/src/NavRail/NavRail.story.tsx

@@ -0,0 +1,189 @@
+import { rem } from 'polished';
+import React, { forwardRef, useState } from 'react';
+
+import { Box } from '../Box';
+import { NavRailItem, NavRailIndicator, NavRailLabel } from './';
+import type { NavRailLabelProps } from './';
+// import './styles.css';
+
+export default {
+  title: 'components/NavRail',
+};
+
+const ListIcon = (props) => (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    height={16}
+    width={16}
+    viewBox="0 0 24 24"
+    {...props}
+  >
+    <path
+      fill="currentColor"
+      d="M8 17q.425 0 .713-.288Q9 16.425 9 16t-.287-.713Q8.425 15 8 15t-.713.287Q7 15.575 7 16t.287.712Q7.575 17 8 17Zm0-4q.425 0 .713-.288Q9 12.425 9 12t-.287-.713Q8.425 11 8 11t-.713.287Q7 11.575 7 12t.287.712Q7.575 13 8 13Zm0-4q.425 0 .713-.288Q9 8.425 9 8t-.287-.713Q8.425 7 8 7t-.713.287Q7 7.575 7 8t.287.712Q7.575 9 8 9Zm3 8h6v-2h-6Zm0-4h6v-2h-6Zm0-4h6V7h-6ZM5 21q-.825 0-1.413-.587Q3 19.825 3 19V5q0-.825.587-1.413Q4.175 3 5 3h14q.825 0 1.413.587Q21 4.175 21 5v14q0 .825-.587 1.413Q19.825 21 19 21Zm0-2h14V5H5v14ZM5 5v14V5Z"
+    />
+  </svg>
+);
+
+const KitchenIcon = (props) => (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    height={16}
+    width={16}
+    viewBox="0 0 24 24"
+    {...props}
+  >
+    <path
+      fill="currentColor"
+      d="M8 8V5h2v3Zm0 9v-5h2v5Zm-2 5q-.825 0-1.412-.587Q4 20.825 4 20V4q0-.825.588-1.413Q5.175 2 6 2h12q.825 0 1.413.587Q20 3.175 20 4v16q0 .825-.587 1.413Q18.825 22 18 22Zm0-2h12v-9H6v9ZM6 9h12V4H6Z"
+    />
+  </svg>
+);
+
+const MenuIcon = (props) => (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    height={16}
+    width={16}
+    viewBox="0 0 24 24"
+    {...props}
+  >
+    <path
+      fill="currentColor"
+      d="M17 22v-8h-3V7q0-2.075 1.463-3.537Q16.925 2 19 2v20ZM7 22v-9.15q-1.275-.35-2.137-1.4Q4 10.4 4 9V2h2v7h1V2h2v7h1V2h2v7q0 1.4-.863 2.45-.862 1.05-2.137 1.4V22Z"
+    />
+  </svg>
+);
+
+export const Default = () => {
+  const [selectedItem, setSelectedItem] = useState('0');
+
+  return (
+    <Box
+      bg="surface"
+      width="80px"
+      position="fixed"
+      top="0"
+      bottom="0"
+      left="0"
+      py={rem(80)}
+      display="flex"
+      flexDirection="column"
+    >
+      <NavRailItem
+        selected={selectedItem === '0'}
+        onClick={() => setSelectedItem('0')}
+      >
+        <NavRailIndicator>
+          <MenuIcon />
+        </NavRailIndicator>
+        <NavRailLabel>Menu</NavRailLabel>
+      </NavRailItem>
+      <NavRailItem
+        selected={selectedItem === '1'}
+        onClick={() => setSelectedItem('1')}
+      >
+        <NavRailIndicator>
+          <KitchenIcon />
+        </NavRailIndicator>
+        <NavRailLabel>Kitchen</NavRailLabel>
+      </NavRailItem>
+      <NavRailItem
+        selected={selectedItem === '2'}
+        onClick={() => setSelectedItem('2')}
+      >
+        <NavRailIndicator>
+          <ListIcon />
+        </NavRailIndicator>
+        <NavRailLabel>Orders</NavRailLabel>
+      </NavRailItem>
+    </Box>
+  );
+};
+
+const DisappearingNavRailLabel = forwardRef<
+  HTMLDivElement,
+  NavRailLabelProps & { selected: boolean }
+>(function AnimatedNavRailLabel({ selected, height = '28px', ...props }, ref) {
+  const transitionDuration = '0.2s';
+  const transitionTimingFunction = 'cubic-bezier(0.4, 0, 0.2, 1)';
+  return (
+    <Box
+      ref={ref}
+      style={{
+        height: selected ? height : '0px',
+      }}
+      sx={{
+        transition: `height ${transitionDuration} ${transitionTimingFunction}`,
+      }}
+    >
+      <NavRailLabel
+        style={{
+          transform: selected
+            ? 'scale(1) translateY(0)'
+            : `scale(0.8, 0.64) translateY(calc(${height} * -0.5 * 0.64))`,
+          opacity: selected ? '1' : '0',
+        }}
+        sx={{
+          transformOrigin: 'center top',
+          transition:
+            `transform ${transitionDuration} ${transitionTimingFunction}, ` +
+            `opacity ${transitionDuration} ${transitionTimingFunction}`,
+        }}
+        {...props}
+      />
+    </Box>
+  );
+});
+
+export const WithHiddenLabels = () => {
+  const [selectedItem, setSelectedItem] = useState('0');
+
+  return (
+    <Box
+      bg="surface"
+      width="80px"
+      position="fixed"
+      top="0"
+      bottom="0"
+      left="0"
+      py={rem(80)}
+      display="flex"
+      flexDirection="column"
+    >
+      <NavRailItem
+        selected={selectedItem === '0'}
+        onClick={() => setSelectedItem('0')}
+      >
+        <NavRailIndicator>
+          <MenuIcon />
+        </NavRailIndicator>
+        <DisappearingNavRailLabel selected={selectedItem === '0'}>
+          Menu
+        </DisappearingNavRailLabel>
+      </NavRailItem>
+      <NavRailItem
+        selected={selectedItem === '1'}
+        onClick={() => setSelectedItem('1')}
+      >
+        <NavRailIndicator>
+          <KitchenIcon />
+        </NavRailIndicator>
+        <DisappearingNavRailLabel selected={selectedItem === '1'}>
+          Kitchen
+        </DisappearingNavRailLabel>
+      </NavRailItem>
+      <NavRailItem
+        selected={selectedItem === '2'}
+        onClick={() => setSelectedItem('2')}
+      >
+        <NavRailIndicator>
+          <ListIcon />
+        </NavRailIndicator>
+        <DisappearingNavRailLabel selected={selectedItem === '2'}>
+          Orders
+        </DisappearingNavRailLabel>
+      </NavRailItem>
+    </Box>
+  );
+};

package/src/NavRail/NavRailItem.tsx

@@ -0,0 +1,174 @@
+import React, { forwardRef, useMemo } from 'react';
+import { rem } from 'polished';
+import { get } from 'styled-system';
+
+import type { BoxProps, SxStyleProp } from '../Box';
+import { Box } from '../Box';
+import { useTheme } from '../theme';
+import { Text } from '../Text';
+import type { TextProps } from '../Text';
+import { useRippleSurface } from '../Ripple';
+
+export interface NavRailItemProps extends Omit<BoxProps, 'color'> {
+  as?: React.ElementType<any>;
+  children?: React.ReactNode;
+  disabled?: boolean;
+  selected?: boolean;
+  color?: string;
+}
+
+export type NavRailIndicatorProps = BoxProps;
+
+export const NavRailIndicator = forwardRef<
+  HTMLDivElement,
+  NavRailIndicatorProps
+>(function NavRailIndicator(props, forwardedRef) {
+  const { as = 'div', children, __css, ...otherProps } = props;
+
+  return (
+    <Box
+      color="currentColor"
+      ref={forwardedRef}
+      as={as}
+      data-nav-rail-item-indicator=""
+      {...otherProps}
+      __css={{
+        width: '100%',
+        height: '100%',
+        maxWidth: rem(56),
+        maxHeight: rem(56),
+        borderRadius: 'full',
+        bg: 'var(--indicator-background-color)',
+        display: 'flex',
+        alignItems: 'center',
+        justifyContent: 'center',
+        minHeight: rem(32),
+        transition: 'background-color .2s cubic-bezier(.4,0,.2,1)',
+        pointerEvents: 'none',
+        ...__css,
+      }}
+    >
+      {children}
+    </Box>
+  );
+});
+
+export type NavRailLabelProps = TextProps;
+
+export const NavRailLabel = forwardRef<HTMLDivElement, NavRailLabelProps>(
+  function NavRailLabel(props, forwardedRef) {
+    const { as = 'div', children, __css, ...otherProps } = props;
+
+    return (
+      <Text
+        ref={forwardedRef}
+        as={as}
+        variant="caption"
+        lineHeight={1}
+        {...otherProps}
+        __css={{
+          pt: rem(4),
+          pb: rem(12),
+          color: 'inherit',
+          pointerEvents: 'none',
+          ...__css,
+        }}
+      >
+        {children}
+      </Text>
+    );
+  }
+);
+
+export const NavRailItem = forwardRef<HTMLDivElement, NavRailItemProps>(
+  function NavRailItem(props, forwardedRef) {
+    const {
+      as = 'button',
+      children,
+      color = 'primary-container',
+      selected = false,
+      disabled = false,
+      style,
+      onKeyDown,
+      onPointerDown,
+      __css,
+      ...otherProps
+    } = props;
+    const theme = useTheme();
+    const baseOpacity = 0,
+      hoverOpacity = 0.04,
+      focusOpacity = 0.12,
+      pressedOpacity = 0.12;
+    const ripple = useRippleSurface({
+      rippleColor: 'currentColor',
+      onKeyDown,
+      onPointerDown,
+      baseOpacity,
+      hoverOpacity,
+      focusOpacity,
+      pressedOpacity,
+    });
+
+    // Apply ripple from nav item to nav indicator
+    const rippleCss = useMemo(() => {
+      const ret: SxStyleProp = {};
+      const keys = Object.keys(ripple.__css);
+      for (const key of keys) {
+        if (!key.startsWith('&')) {
+          ret['& [data-nav-rail-item-indicator]'] =
+            ret['& [data-nav-rail-item-indicator]'] || {};
+          ret['& [data-nav-rail-item-indicator]'][key] = ripple.__css[key];
+          continue;
+        }
+
+        const newKey = key.replace(
+          /(.+?)::(before|after)/g,
+          '$1 [data-nav-rail-item-indicator]::$2'
+        );
+        ret[newKey] = ripple.__css[key];
+      }
+      return ret;
+    }, [ripple.__css]);
+
+    return (
+      <Box
+        ref={forwardedRef}
+        as={as}
+        {...otherProps}
+        onPointerDown={ripple.onPointerDown}
+        onKeyDown={ripple.onKeyDown}
+        aria-pressed={selected}
+        type="button"
+        style={{ ...ripple.style, ...style }}
+        disabled={disabled}
+        __css={{
+          display: 'flex',
+          flexDirection: 'column',
+          alignItems: 'center',
+          transition: 'color .2s cubic-bezier(.4,0,.2,1)',
+          color: selected ? `on.${color}` : 'on.surface-variant',
+          '--indicator-background-color': selected
+            ? get(theme, `colors.${color}`)
+            : 'transparent',
+          border: 'none',
+          ':focus': {
+            outline: 'none',
+          },
+          backgroundColor: 'transparent',
+          margin: 0,
+          padding: 0,
+          px: rem(12),
+          minHeight: rem(60),
+          height: rem(60),
+          cursor: 'pointer',
+          textDecoration: 'none',
+          WebkitTapHighlightColor: 'transparent',
+          ...rippleCss,
+          ...__css,
+        }}
+      >
+        {children}
+      </Box>
+    );
+  }
+);

package/src/NavRail/index.ts

@@ -0,0 +1 @@
+export * from './NavRailItem';

package/src/Ripple/useRippleSurface.ts

@@ -1,4 +1,5 @@
 import type { CSSProperties } from 'react';
+import { useMemo } from 'react';
 import { get } from '@styled-system/css';
 import { wrapEvent } from '@basic-ui/core';
 
@@ -22,7 +23,7 @@ export interface UseRippleSurfaceOptions<T extends HTMLElement> {
 }
 
 export function useRippleSurface<T extends HTMLElement>(
-  opts: UseRippleSurfaceOptions<T>
+  opts: UseRippleSurfaceOptions<T> = {}
 ) {
   let {
     // eslint-disable-next-line prefer-const
@@ -62,67 +63,78 @@ export function useRippleSurface<T extends HTMLElement>(
     ...rippleProps,
   });
 
-  const css: SxStyleProp = {
-    overflow: 'hidden',
-    position: 'relative',
-    cursor: 'pointer',
-    // fix overflow: hidden + borderRadius in Safari
-    // https://gist.github.com/ayamflow/b602ab436ac9f05660d9c15190f4fd7b#gistcomment-2359479
-    willChange: 'transform,opacity',
-    WebkitTapHighlightColor: 'transparent',
-    // ripple overlay
-    '&::before': {
-      backgroundColor: rippleColor,
-      boxSizing: 'content-box',
-      position: 'absolute',
-      content: '""',
-      opacity: baseOpacity,
-      pointerEvents: 'none',
-      top: '0',
-      left: '0',
-      width: '100%',
-      height: '100%',
-      transition: 'opacity 75ms linear',
-    },
-    '&:hover::before': {
-      opacity: hoverOpacity,
-    },
-    '&:focus-visible::before': {
-      opacity: focusOpacity,
-    },
-    ...(!rippleEnabled && {
-      '&:active::before': {
-        opacity: pressedOpacity,
+  const css: SxStyleProp = useMemo(
+    () => ({
+      overflow: 'hidden',
+      position: 'relative',
+      cursor: 'pointer',
+      // fix overflow: hidden + borderRadius in Safari
+      // https://gist.github.com/ayamflow/b602ab436ac9f05660d9c15190f4fd7b#gistcomment-2359479
+      willChange: 'transform,opacity',
+      WebkitTapHighlightColor: 'transparent',
+      // ripple overlay
+      '&::before': {
+        backgroundColor: rippleColor,
+        boxSizing: 'content-box',
+        position: 'absolute',
+        content: '""',
+        opacity: baseOpacity,
+        pointerEvents: 'none',
+        top: '0',
+        left: '0',
+        width: '100%',
+        height: '100%',
+        transition: 'opacity 75ms linear',
       },
-    }),
-    '&[aria-pressed="true"]::before': {
-      opacity: baseOpacity + pressedOpacity,
-    },
-    '&[aria-pressed="true"]:hover::before': {
-      opacity: pressedOpacity + hoverOpacity,
-    },
-    '&[aria-pressed="true"]:focus-visible::before': {
-      opacity: pressedOpacity + focusOpacity,
-    },
-    ...(!rippleEnabled && {
-      '&[aria-pressed="true"]:active::before': {
-        opacity: pressedOpacity + pressedOpacity,
+      '&:hover::before': {
+        opacity: hoverOpacity,
       },
-    }),
-    ['&:disabled::before,&:disabled:hover::before,&:disabled:focus::before,&:disabled:active::before,' +
-    '&[data-disabled]::before,&[data-disabled]:hover::before,&[data-disabled]:focus::before,' +
-    '&[data-disabled]:active::before,&:disabled[aria-pressed="true"]::before']:
-      {
-        opacity: 0,
+      '&:focus-visible::before': {
+        opacity: focusOpacity,
+      },
+      ...(!rippleEnabled && {
+        '&:active::before': {
+          opacity: pressedOpacity,
+        },
+      }),
+      '&[aria-pressed="true"]::before': {
+        opacity: baseOpacity + pressedOpacity,
+      },
+      '&[aria-pressed="true"]:hover::before': {
+        opacity: pressedOpacity + hoverOpacity,
       },
-    '&:disabled,&[data-disabled]': {
-      cursor: 'default',
-    },
-    // ripple
-    ...(rippleEnabled && {
-      '&::after': { ...rippleStyle({ animation }) },
+      '&[aria-pressed="true"]:focus-visible::before': {
+        opacity: pressedOpacity + focusOpacity,
+      },
+      ...(!rippleEnabled && {
+        '&[aria-pressed="true"]:active::before': {
+          opacity: pressedOpacity + pressedOpacity,
+        },
+      }),
+      ['&:disabled::before,&:disabled:hover::before,&:disabled:focus::before,&:disabled:active::before,' +
+      '&[data-disabled]::before,&[data-disabled]:hover::before,&[data-disabled]:focus::before,' +
+      '&[data-disabled]:active::before,&:disabled[aria-pressed="true"]::before']:
+        {
+          opacity: 0,
+        },
+      '&:disabled,&[data-disabled]': {
+        cursor: 'default',
+      },
+      // ripple
+      ...(rippleEnabled && {
+        '&::after': { ...rippleStyle({ animation }) },
+      }),
     }),
-  };
+    [
+      animation,
+      baseOpacity,
+      focusOpacity,
+      hoverOpacity,
+      pressedOpacity,
+      rippleColor,
+      rippleEnabled,
+    ]
+  );
 
   return {
     style: { ...animationStyle, ...style },

package/src/ThemeExplorer/ThemeBuilder.story.tsx

@@ -68,6 +68,8 @@ const ThemeBuilder = () => {
         sx={{ gap: 3 }}
         flexDirection="column"
         width="300px"
+        position="fixed"
+        top="0"
       >
         <Box display="flex">
           <TextFieldColorPicker
@@ -131,31 +133,33 @@ const ThemeBuilder = () => {
           </Button>
         </Box>
       </Box>
-      <Box width="600px" mx="auto">
-        <Box display="flex" flexDirection="column" sx={{ gap: 4 }}>
-          <Box flex="1">
-            <Text variant="h5" as="h1" pb={'0.3em'}>
-              Light theme
-            </Text>
-            <ThemeColors scheme={scheme} />
+      <Box width="100%" pl="300px">
+        <Box width="600px" mx="auto">
+          <Box display="flex" flexDirection="column" sx={{ gap: 4 }}>
+            <Box flex="1">
+              <Text variant="h5" as="h1" pb={'0.3em'}>
+                Light theme
+              </Text>
+              <ThemeColors scheme={scheme} />
+            </Box>
+            <Box flex="1">
+              <Text variant="h5" as="h1" pb={'0.3em'}>
+                Dark theme
+              </Text>
+              <ThemeColors scheme={scheme.modes.dark} />
+            </Box>
           </Box>
-          <Box flex="1">
-            <Text variant="h5" as="h1" pb={'0.3em'}>
-              Dark theme
-            </Text>
-            <ThemeColors scheme={scheme.modes.dark} />
+          <Box my={4} display="flex" sx={{ gap: 3 }} flexDirection="column">
+            <TonalColors palette={a1} />
+            <TonalColors palette={secondaryColorTonal} />
+            <TonalColors palette={tertiaryColorTonal} />
+            <TonalColors palette={error} />
+            <TonalColors palette={neutralColorTonal} />
+            <TonalColors palette={n2} />
+          </Box>
+          <Box as="pre" fontFamily="monospace" fontSize="12px">
+            {JSON.stringify({ colors: scheme }, null, 2)}
           </Box>
-        </Box>
-        <Box my={4} display="flex" sx={{ gap: 3 }} flexDirection="column">
-          <TonalColors palette={a1} />
-          <TonalColors palette={secondaryColorTonal} />
-          <TonalColors palette={tertiaryColorTonal} />
-          <TonalColors palette={error} />
-          <TonalColors palette={neutralColorTonal} />
-          <TonalColors palette={n2} />
-        </Box>
-        <Box as="pre" fontFamily="monospace" fontSize="12px">
-          {JSON.stringify({ colors: scheme }, null, 2)}
         </Box>
       </Box>
     </Box>

package/src/color.ts

@@ -17,17 +17,38 @@ export const alpha =
     return `rgba(${rgb.red},${rgb.green},${rgb.blue},${alphaValue})`;
   };
 
+export function mixColor(
+  baseColor: string,
+  overlayColor: string
+): (theme: any) => string;
+export function mixColor(
+  baseColor: string,
+  overlayColor: string,
+  overlayOpacity: number
+): (theme: any) => string;
+export function mixColor(
+  baseColor: string,
+  overlayColor: string,
+  overlayOpacity?: number
+): (theme: any) => string {
+  return (theme) => {
+    baseColor = get(theme, `colors.${baseColor}`, baseColor);
+    overlayColor = overlayOpacity
+      ? alpha(overlayColor, overlayOpacity)(theme)
+      : get(theme, `colors.${overlayColor}`, overlayColor);
+
+    return `linear-gradient(${overlayColor}, ${overlayColor}), ${baseColor}`;
+  };
+}
+
 export function getColorOverlay(
   theme: Theme,
   baseColor: string,
   overlayColor: string,
   overlayOpacity: number
 ): SystemStyleObject {
-  baseColor = get(theme, `colors.${baseColor}`) || baseColor;
-  overlayColor = alpha(overlayColor, overlayOpacity)(theme);
-
   return {
-    background: `linear-gradient(${overlayColor}, ${overlayColor}), ${baseColor}`,
+    background: mixColor(baseColor, overlayColor, overlayOpacity)(theme),
   };
 }
 

package/src/index.ts

@@ -17,6 +17,7 @@ export * from './Link';
 export * from './List';
 export * from './ListItem';
 export * from './Menu';
+export * from './NavRail';
 export * from './NotchedOutline';
 export * from './Paper';
 export * from './ProgressSpinner';

package/src/ThemeExplorer/ThemeExplorer.story.tsx

@@ -1,43 +0,0 @@
-import React from 'react';
-import { useTheme } from '@emotion/react';
-
-import { ThemeColors } from './ThemeColors';
-import { DARK_THEME_CLASS, DEFAULT_THEME_CLASS, Box } from '../';
-
-export default {
-  title: 'components/ThemeExplorer',
-};
-
-const ThemeExplorer = () => {
-  const theme = useTheme();
-  return (
-    <>
-      <Box
-        flex="1"
-        p={3}
-        borderRadius="extra-large"
-        overflow="hidden"
-        border="1px solid #fff"
-        borderColor="outline"
-        bg="surface"
-        className={DEFAULT_THEME_CLASS}
-      >
-        <ThemeColors scheme={theme.colors as any} />
-      </Box>
-      <Box
-        flex="1"
-        p={3}
-        borderRadius="extra-large"
-        overflow="hidden"
-        border="1px solid #fff"
-        borderColor="outline"
-        bg="surface"
-        className={DARK_THEME_CLASS}
-      >
-        <ThemeColors scheme={theme.colors.modes.dark as any} />
-      </Box>
-    </>
-  );
-};
-
-export const Explorer = () => <ThemeExplorer />;