@primer/components 0.0.0-20219184953 → 0.0.0-2021919182815

package/lib-esm/ActionList2/Item.js

@@ -0,0 +1,172 @@
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+/**
+ * test suite!
+ * id, role
+ * text could be non-text
+ * activeDescendantAttribute
+ * deepmerge sx
+ * nicer name for showDivider?
+ * aria-label
+ * aria-describedby
+ * React.FC<Props> doesn't allow id?
+ * truncate description
+ * icon color
+ * disabled checkbox
+ * check height with divider
+ *
+ * use immediate child slot API instead of double render?
+ * change as= li | div based on context of menu or not?
+ * check if everyone accepts sx prop
+ * link example outside of overlay? (details)
+ * if one item has selected, should we give all of them selected without the need to pass prop?
+ * move custom item themes to primitives?
+ * padding: 8 or 6?
+ * ActionList.Selection or ActionList.Item selected?
+ * different size for icon and avatar, range?
+ * minimize number of divs?
+ * can use layoutEffect on server?
+ */
+import React from 'react';
+import { useColorSchemeVar, useTheme } from '../ThemeProvider';
+import Box from '../Box';
+import { get } from '../constants';
+import createSlots from '../utils/create-slots';
+import { ListContext } from './List';
+import { customItemThemes } from './hacks';
+import { Selection } from './Selection';
+export const getVariantStyles = (variant, disabled) => {
+  if (disabled) {
+    return {
+      color: get('colors.fg.muted'),
+      iconColor: get('colors.fg.muted'),
+      annotationColor: get('colors.fg.muted')
+    };
+  }
+
+  switch (variant) {
+    case 'danger':
+      return {
+        color: 'danger.fg',
+        iconColor: 'danger.fg',
+        annotationColor: 'fg.muted'
+      };
+
+    default:
+      return {
+        color: 'fg.default',
+        iconColor: 'fg.muted',
+        annotationColor: 'fg.muted'
+      };
+  }
+};
+const {
+  Slots,
+  Slot
+} = createSlots(['LeadingVisual', 'InlineDescription', 'BlockDescription', 'TrailingVisual']);
+export { Slot };
+export const Item = /*#__PURE__*/React.forwardRef(({
+  variant = 'default',
+  disabled = false,
+  selected = undefined,
+  showDivider = false,
+  onAction = () => null,
+  sx = {},
+  ...props
+}, forwardedRef) => {
+  const customItemTheme = customItemThemes[variant];
+  const {
+    variant: listVariant
+  } = React.useContext(ListContext);
+  const {
+    theme
+  } = useTheme();
+  const styles = {
+    display: 'flex',
+    paddingX: get('space.2'),
+    paddingY: '6px',
+    marginX: listVariant === 'inset' ? get('space.2') : 0,
+    minHeight: get('space.5'),
+    borderRadius: get('radii.2'),
+    transition: 'background 33.333ms linear',
+    color: getVariantStyles(variant, disabled).color,
+    textDecoration: 'none',
+    // for as="a"
+    ':not(disabled)': {
+      cursor: 'pointer'
+    },
+    '@media (hover: hover) and (pointer: fine)': {
+      ':hover': {
+        backgroundColor: useColorSchemeVar(customItemTheme.hover, 'inherit')
+      },
+      ':focus': {
+        backgroundColor: useColorSchemeVar(customItemTheme.focus, 'inherit')
+      }
+    },
+
+    /** Divider styles */
+    '[data-component="ActionList.Item--Main"]': {
+      position: 'relative'
+    },
+    '[data-component="ActionList.Item--Main"]::before': {
+      content: '" "',
+      display: 'block',
+      position: 'absolute',
+      width: '100%',
+      top: '-7px',
+      border: '0 solid',
+      borderTopWidth: showDivider ? `1px` : '0',
+      borderColor: 'var(--divider-color, transparent)'
+    },
+    // show between 2 items
+    ':not(:first-of-type)': {
+      '--divider-color': theme === null || theme === void 0 ? void 0 : theme.colors.border.muted
+    },
+    // hide divider after dividers & group header
+    '[data-component="ActionList.Divider"] + &': {
+      '--divider-color': 'transparent'
+    },
+    // hide border on current and previous item
+    '&:hover, &:focus': {
+      '--divider-color': 'transparent'
+    },
+    '&:hover + &, &:focus + &': {
+      '--divider-color': 'transparent'
+    },
+    ...sx
+  };
+  const clickHandler = React.useCallback(event => {
+    if (disabled) return;
+    if (!event.defaultPrevented) onAction(event);
+  }, [onAction, disabled]);
+  return /*#__PURE__*/React.createElement(Slots, null, slots => /*#__PURE__*/React.createElement(Box, _extends({
+    as: "li",
+    sx: styles,
+    "data-component": "ActionList.Item",
+    onClick: clickHandler,
+    ref: forwardedRef
+  }, props), /*#__PURE__*/React.createElement(Selection, {
+    selected: selected,
+    disabled: disabled
+  }), slots.LeadingVisual, /*#__PURE__*/React.createElement(Box, {
+    "data-component": "ActionList.Item--Main",
+    sx: {
+      display: 'flex',
+      flexDirection: 'column',
+      flexGrow: 1,
+      minWidth: 0
+    }
+  }, /*#__PURE__*/React.createElement(Box, {
+    sx: {
+      display: 'flex'
+    }
+  }, /*#__PURE__*/React.createElement(Box, {
+    sx: {
+      display: 'flex',
+      flexGrow: 1,
+      alignItems: 'baseline',
+      minWidth: 0
+    }
+  }, /*#__PURE__*/React.createElement("span", null, props.children), slots.InlineDescription), slots.TrailingVisual), slots.BlockDescription)));
+});
+Item.displayName = 'ActionList.Item';

package/lib-esm/ActionList2/List.d.ts

@@ -0,0 +1,18 @@
+/**
+ *
+ * showItemDividers
+ * deepmerge sx
+ * change as= ul | div based on context of menu or not?
+ * should selectionVariant be single by default or nothing. ask for explicit choice?
+ */
+import React from 'react';
+import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
+import { SxProp } from '../sx';
+export declare type ListProps = {
+    variant?: 'inset' | 'full';
+    selectionVariant?: 'single' | 'multiple';
+} & SxProp;
+declare type ContextProps = Pick<ListProps, 'selectionVariant' | 'variant'>;
+export declare const ListContext: React.Context<ContextProps>;
+export declare const List: PolymorphicForwardRefComponent<"ul", ListProps>;
+export {};

package/lib-esm/ActionList2/List.js

@@ -0,0 +1,42 @@
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+/**
+ *
+ * showItemDividers
+ * deepmerge sx
+ * change as= ul | div based on context of menu or not?
+ * should selectionVariant be single by default or nothing. ask for explicit choice?
+ */
+import React from 'react';
+import Box from '../Box';
+import { get } from '../constants';
+export const ListContext = /*#__PURE__*/React.createContext({});
+export const List = /*#__PURE__*/React.forwardRef(({
+  variant = 'inset',
+  selectionVariant = 'single',
+  sx = {},
+  ...props
+}, forwardedRef) => {
+  const styles = {
+    margin: 0,
+    fontSize: get('fontSizes.1'),
+    lineHeight: '20px',
+    // TODO: check if we replace this already
+    paddingInlineStart: 0,
+    // reset ul styles
+    paddingY: variant === 'inset' ? get('space.2') : 0,
+    ...sx
+  };
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    as: "ul",
+    sx: styles
+  }, props, {
+    ref: forwardedRef
+  }), /*#__PURE__*/React.createElement(ListContext.Provider, {
+    value: {
+      variant,
+      selectionVariant
+    }
+  }, props.children));
+});
+List.displayName = 'ActionList';

package/lib-esm/ActionList2/Selection.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+import { ItemProps } from './Item';
+declare type SelectionProps = Pick<ItemProps, 'selected' | 'disabled'>;
+export declare const Selection: React.FC<SelectionProps>;
+export {};

package/lib-esm/ActionList2/Selection.js

@@ -0,0 +1,50 @@
+import React from 'react';
+import { CheckIcon } from '@primer/octicons-react';
+import { useTheme } from '../ThemeProvider';
+import { ListContext } from './List';
+import { LeadingVisualContainer } from './Visuals';
+export const Selection = ({
+  selected,
+  disabled
+}) => {
+  const {
+    selectionVariant
+  } = React.useContext(ListContext);
+  const {
+    theme
+  } = useTheme();
+  if (typeof selected === 'undefined') return null;
+
+  if (selectionVariant === 'single') {
+    return /*#__PURE__*/React.createElement(LeadingVisualContainer, null, selected && /*#__PURE__*/React.createElement(CheckIcon, {
+      fill: theme === null || theme === void 0 ? void 0 : theme.colors.text.primary
+    }));
+  }
+
+  if (selectionVariant === 'multiple') {
+    /**
+     * readOnly is required because we are doing a one-way bind to `checked`
+     * aria-readonly="false" tells screen that they can still interact with the checkbox
+     * TODO: not sure if disabled & aria-label be here or should we apply it on the instance as props
+     * TODO: aria-label should come from the text part of the slot
+     */
+    return /*#__PURE__*/React.createElement(LeadingVisualContainer, {
+      sx: {
+        input: {
+          margin: 0,
+          pointerEvents: 'none'
+        }
+      }
+    }, /*#__PURE__*/React.createElement("input", {
+      type: "checkbox",
+      checked: selected,
+      disabled: disabled,
+      "aria-label": "TODO",
+      tabIndex: -1,
+      readOnly: true,
+      "aria-readonly": "false"
+    }));
+  }
+
+  return null;
+};

package/lib-esm/ActionList2/Visuals.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { SxProp } from '../sx';
+import { ItemProps } from './Item';
+declare type VisualProps = Pick<ItemProps, 'variant' | 'disabled' | 'sx'> & {
+    children: React.ReactNode;
+};
+export declare const LeadingVisualContainer: React.FC<SxProp>;
+export declare type LeadingVisualProps = VisualProps;
+export declare const LeadingVisual: React.FC<VisualProps>;
+export declare type TrailingVisualProps = VisualProps;
+export declare const TrailingVisual: React.FC<VisualProps>;
+export {};

package/lib-esm/ActionList2/Visuals.js

@@ -0,0 +1,66 @@
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+import React from 'react';
+import Box from '../Box';
+import { get } from '../constants';
+import { getVariantStyles, Slot } from './Item';
+export const LeadingVisualContainer = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    as: "span",
+    sx: {
+      height: '20px',
+      // match height of text row
+      minWidth: get('space.3'),
+      maxWidth: '20px',
+      // square (same as height)
+      display: 'flex',
+      justifyContent: 'center',
+      alignItems: 'center',
+      flexShrink: 0,
+      marginRight: 2,
+      ...sx
+    }
+  }, props));
+};
+LeadingVisualContainer.displayName = "LeadingVisualContainer";
+export const LeadingVisual = ({
+  variant,
+  disabled,
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: "LeadingVisual"
+  }, /*#__PURE__*/React.createElement(LeadingVisualContainer, _extends({
+    sx: {
+      color: getVariantStyles(variant, disabled).iconColor,
+      svg: {
+        fontSize: 0
+      },
+      ...sx
+    }
+  }, props), props.children));
+};
+LeadingVisual.displayName = "LeadingVisual";
+export const TrailingVisual = ({
+  variant,
+  disabled,
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: "TrailingVisual"
+  }, /*#__PURE__*/React.createElement(Box, _extends({
+    as: "span",
+    sx: {
+      height: '20px',
+      // match height of text row
+      flexShrink: 0,
+      color: getVariantStyles(variant, disabled).annotationColor,
+      marginLeft: 2
+    }
+  }, props), props.children));
+};
+TrailingVisual.displayName = "TrailingVisual";

package/lib-esm/ActionList2/hacks.d.ts

@@ -0,0 +1,30 @@
+/**
+ * These colors are not yet in our default theme.
+ * TODO: Need to remove this once they are added.
+ */
+export declare const customItemThemes: {
+    default: {
+        hover: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+        focus: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+    };
+    danger: {
+        hover: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+        focus: {
+            light: string;
+            dark: string;
+            dark_dimmed: string;
+        };
+    };
+};

package/lib-esm/ActionList2/hacks.js

@@ -0,0 +1,30 @@
+/**
+ * These colors are not yet in our default theme.
+ * TODO: Need to remove this once they are added.
+ */
+export const customItemThemes = {
+  default: {
+    hover: {
+      light: 'rgba(46, 77, 108, 0.06)',
+      dark: 'rgba(201, 206, 212, 0.12)',
+      dark_dimmed: 'rgba(201, 206, 212, 0.12)'
+    },
+    focus: {
+      light: 'rgba(54, 77, 100, 0.16)',
+      dark: 'rgba(201, 206, 212, 0.24)',
+      dark_dimmed: 'rgba(201, 206, 212, 0.24)'
+    }
+  },
+  danger: {
+    hover: {
+      light: 'rgba(234, 74, 90, 0.08)',
+      dark: 'rgba(248, 81, 73, 0.16)',
+      dark_dimmed: 'rgba(248, 81, 73, 0.16)'
+    },
+    focus: {
+      light: 'rgba(234, 74, 90, 0.14)',
+      dark: 'rgba(248, 81, 73, 0.24)',
+      dark_dimmed: 'rgba(248, 81, 73, 0.24)'
+    }
+  }
+};

package/lib-esm/ActionList2/index.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import { Group } from './Group';
+import { Divider } from './Divider';
+export type { ListProps as ActionListProps } from './List';
+export type { GroupProps } from './Group';
+export type { ItemProps } from './Item';
+export type { DescriptionProps } from './Description';
+export type { LeadingVisualProps, TrailingVisualProps } from './Visuals';
+/**
+ * Collection of list-related components.
+ */
+export declare const ActionList: import("@radix-ui/react-polymorphic").ForwardRefComponent<"ul", import("./List").ListProps> & {
+    /** Collects related `Items` in an `ActionList`. */
+    Group: typeof Group;
+    /** An actionable or selectable `Item` with an optional icon and description. */
+    Item: import("@radix-ui/react-polymorphic").ForwardRefComponent<"li", import("./Item").ItemProps>;
+    /** Visually separates `Item`s or `Group`s in an `ActionList`. */
+    Divider: typeof Divider;
+    Description: import("react").FC<import("./Description").DescriptionProps>;
+    LeadingVisual: import("react").FC<Pick<import("./Item").ItemProps, "sx" | "disabled" | "variant"> & {
+        children: import("react").ReactNode;
+    }>;
+    TrailingVisual: import("react").FC<Pick<import("./Item").ItemProps, "sx" | "disabled" | "variant"> & {
+        children: import("react").ReactNode;
+    }>;
+};

package/lib-esm/ActionList2/index.js

@@ -0,0 +1,23 @@
+import { List } from './List';
+import { Group } from './Group';
+import { Item } from './Item';
+import { Divider } from './Divider';
+import { Description } from './Description';
+import { LeadingVisual, TrailingVisual } from './Visuals';
+
+/**
+ * Collection of list-related components.
+ */
+export const ActionList = Object.assign(List, {
+  /** Collects related `Items` in an `ActionList`. */
+  Group,
+
+  /** An actionable or selectable `Item` with an optional icon and description. */
+  Item,
+
+  /** Visually separates `Item`s or `Group`s in an `ActionList`. */
+  Divider,
+  Description,
+  LeadingVisual,
+  TrailingVisual
+});

package/lib-esm/index.d.ts

@@ -22,6 +22,7 @@ export { useOnEscapePress } from './hooks/useOnEscapePress';
 export { useOverlay } from './hooks/useOverlay';
 export { useConfirm } from './Dialog/ConfirmationDialog';
 export { ActionList } from './ActionList';
+export { ActionList as ActionList2 } from './ActionList2';
 export { ActionMenu } from './ActionMenu';
 export type { ActionMenuProps } from './ActionMenu';
 export { default as Autocomplete } from './Autocomplete';

package/lib-esm/index.js

@@ -18,6 +18,7 @@ export { useOverlay } from './hooks/useOverlay';
 export { useConfirm } from './Dialog/ConfirmationDialog'; // Components
 
 export { ActionList } from './ActionList';
+export { ActionList as ActionList2 } from './ActionList2';
 export { ActionMenu } from './ActionMenu';
 export { default as Autocomplete } from './Autocomplete';
 export { default as Avatar } from './Avatar';

package/lib-esm/utils/create-slots.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+/** createSlots is a factory that can create a
+ *  typesafe Slots + Slot pair to use in a component definition
+ *  For example: ActionList.Item uses createSlots to get a Slots wrapper
+ *  + Slot component that is used by LeadingVisual, Description
+ */
+declare const createSlots: <SlotNames extends string>(slotNames: SlotNames[]) => {
+    Slots: React.FC<{
+        children: (slots: { [key in SlotNames]?: React.ReactNode; }) => React.ReactNode;
+    }>;
+    Slot: React.FC<{
+        name: SlotNames;
+    }>;
+};
+export default createSlots;

package/lib-esm/utils/create-slots.js

@@ -0,0 +1,80 @@
+import React from 'react';
+import { useForceUpdate } from './use-force-update';
+/** createSlots is a factory that can create a
+ *  typesafe Slots + Slot pair to use in a component definition
+ *  For example: ActionList.Item uses createSlots to get a Slots wrapper
+ *  + Slot component that is used by LeadingVisual, Description
+ */
+
+const createSlots = slotNames => {
+  const SlotsContext = /*#__PURE__*/React.createContext({
+    registerSlot: () => null,
+    unregisterSlot: () => null
+  });
+
+  /** Slots uses a Double render strategy inspired by [reach-ui/descendants](https://github.com/reach/reach-ui/tree/develop/packages/descendants)
+   *  Slot registers themself with the Slots parent.
+   *  When all the children have mounted = registered themselves in slot,
+   *  we re-render the parent component to render with slots
+   */
+  const Slots = ({
+    children
+  }) => {
+    // initialise slots
+    const slotsDefinition = {};
+    slotNames.map(name => slotsDefinition[name] = null);
+    const slotsRef = React.useRef(slotsDefinition);
+    const rerenderWithSlots = useForceUpdate();
+    const [isMounted, setIsMounted] = React.useState(false); // fires after all the effects in children
+
+    React.useEffect(() => {
+      rerenderWithSlots();
+      setIsMounted(true);
+    }, [rerenderWithSlots]);
+    const slots = slotsRef.current;
+    const registerSlot = React.useCallback((name, contents) => {
+      slotsRef.current[name] = contents; // don't render until the component mounts = all slots are registered
+
+      if (isMounted) rerenderWithSlots();
+    }, [isMounted, rerenderWithSlots]); // Slot can be removed from the tree as well,
+    // we need to unregister them from the slot
+
+    const unregisterSlot = React.useCallback(name => {
+      slotsRef.current[name] = null;
+      rerenderWithSlots();
+    }, [rerenderWithSlots]);
+    /**
+     * Slots uses a render prop API so abstract the
+     * implementation detail of using a context provider.
+     */
+
+    return /*#__PURE__*/React.createElement(SlotsContext.Provider, {
+      value: {
+        registerSlot,
+        unregisterSlot
+      }
+    }, children(slots));
+  };
+
+  const Slot = ({
+    name,
+    children
+  }) => {
+    const {
+      registerSlot,
+      unregisterSlot
+    } = React.useContext(SlotsContext);
+    React.useEffect(() => {
+      registerSlot(name, children);
+      return () => unregisterSlot(name);
+    }, [name, children, registerSlot, unregisterSlot]);
+    return null;
+  };
+
+  return {
+    Slots,
+    Slot
+  };
+};
+
+export default createSlots;

package/lib-esm/utils/use-force-update.d.ts

@@ -0,0 +1 @@
+export declare const useForceUpdate: () => () => void;

package/lib-esm/utils/use-force-update.js

@@ -0,0 +1,6 @@
+// Inspired from reach-ui: https://github.com/reach/reach-ui/blob/develop/packages/utils/src/use-force-update.ts
+import React from 'react';
+export const useForceUpdate = () => {
+  const [, rerender] = React.useState({});
+  return React.useCallback(() => rerender({}), []);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/components",
-  "version": "0.0.0-20219184953",
+  "version": "0.0.0-2021919182815",
   "description": "Primer react components",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",