@primer/components 0.0.0-202191502023 → 0.0.0-202191514518

package/CHANGELOG.md

@@ -1,10 +1,10 @@
 # @primer/components
 
-## 0.0.0-202191502023
+## 0.0.0-202191514518
 
 ### Major Changes
 
-- [#1514](https://github.com/primer/react/pull/1514) [`30b4c44f`](https://github.com/primer/react/commit/30b4c44fef2d4c366e912771f0a4d998fc95ab92) Thanks [@colebemis](https://github.com/colebemis)! - Remove deprecated color variables by upgrading to @primer/primitives [v5](https://github.com/primer/primitives/pull/251)
+- [#1514](https://github.com/primer/react/pull/1514) [`dc789025`](https://github.com/primer/react/commit/dc789025d4976e2f0863e1f377c4a834aab88e3a) Thanks [@colebemis](https://github.com/colebemis)! - Remove deprecated color variables by upgrading to @primer/primitives [v5](https://github.com/primer/primitives/pull/251)
 
   **Note:** Install [`eslint-plugin-primer-react`](https://primer.style/react/linting) to ensure that you're not using any deprecated or removed color variables.
 

package/lib/ActionList2/Description.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export declare type DescriptionProps = {
+    variant?: 'inline' | 'block';
+};
+export declare const Description: React.FC<DescriptionProps>;

package/lib/ActionList2/Description.js

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Description = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _Truncate = _interopRequireDefault(require("../Truncate"));
+
+var _Item = require("./Item");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const Description = ({
+  variant = 'inline',
+  ...props
+}) => {
+  const {
+    registerSlot
+  } = _react.default.useContext(_Item.ItemContext);
+
+  const slotName = variant === 'block' ? 'BlockDescription' : 'InlineDescription';
+  const styles = {
+    color: 'fg.muted',
+    fontSize: 0,
+    lineHeight: '16px',
+    flexGrow: 1,
+    flexBasis: 0,
+    minWidth: 0,
+    marginLeft: variant === 'block' ? 0 : 2
+  };
+
+  if (variant === 'block') {
+    registerSlot(slotName, /*#__PURE__*/_react.default.createElement(_Box.default, {
+      as: "span",
+      sx: styles
+    }, props.children));
+  } else {
+    registerSlot(slotName, /*#__PURE__*/_react.default.createElement(_Truncate.default, {
+      sx: styles,
+      title: props.children,
+      inline: true,
+      maxWidth: "100%"
+    }, props.children));
+  }
+
+  return null;
+};
+
+exports.Description = Description;

package/lib/ActionList2/Divider.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+/**
+ * Visually separates `Item`s or `Group`s in an `ActionList`.
+ */
+export declare function Divider(): JSX.Element;
+export declare namespace Divider {
+    var renderItem: typeof Divider;
+}

package/lib/ActionList2/Divider.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Divider = Divider;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _constants = require("../constants");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Visually separates `Item`s or `Group`s in an `ActionList`.
+ */
+function Divider() {
+  return /*#__PURE__*/_react.default.createElement(_Box.default, {
+    as: "hr",
+    sx: {
+      border: 'none',
+      // override browser styles
+      height: 1,
+      backgroundColor: 'border.muted',
+      marginTop: theme => `calc(${(0, _constants.get)('space.2')(theme)} - 1px)`,
+      marginBottom: 2
+    },
+    "data-component": "ActionList.Divider"
+  });
+}
+
+Divider.displayName = "Divider";
+
+/**
+ * `Divider` fulfills the `ItemPropsWithCustomRenderer` contract,
+ * so it can be used inline in an `ActionList`’s `items` prop.
+ * In other words, `items={[ActionList.Divider]}` is supported as a concise
+ * alternative to `items={[{renderItem: () => <ActionList.Divider />}]}`.
+ */
+Divider.renderItem = Divider;

package/lib/ActionList2/Group.d.ts

@@ -0,0 +1,8 @@
+/**
+ * show item dividers
+ */
+/// <reference types="react" />
+import { SxProp } from '../sx';
+import { HeaderProps } from './Header';
+export declare type GroupProps = HeaderProps & SxProp;
+export declare function Group({ title, variant, auxiliaryText, sx, ...props }: GroupProps): JSX.Element;

package/lib/ActionList2/Group.js

@@ -0,0 +1,39 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Group = Group;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _Header = require("./Header");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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); }
+
+function Group({
+  title,
+  variant,
+  auxiliaryText,
+  sx = {},
+  ...props
+}) {
+  return /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    sx: {
+      '&:not(:first-child)': {
+        marginTop: 2
+      },
+      ...sx
+    }
+  }, props), title && /*#__PURE__*/_react.default.createElement(_Header.Header, {
+    title: title,
+    variant: variant,
+    auxiliaryText: auxiliaryText
+  }), props.children);
+}
+
+Group.displayName = "Group";

package/lib/ActionList2/Header.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import { SxProp } from '../sx';
+/**
+ * Contract for props passed to the `Header` component.
+ */
+export interface HeaderProps extends React.ComponentPropsWithoutRef<'div'>, SxProp {
+    /**
+     * Style variations. Usage is discretionary.
+     *
+     * - `"filled"` - Superimposed on a background, offset from nearby content
+     * - `"subtle"` - Relatively less offset from nearby content
+     */
+    variant?: 'subtle' | 'filled';
+    /**
+     * Primary text which names a `Group`.
+     */
+    title?: string;
+    /**
+     * Secondary text which provides additional information about a `Group`.
+     */
+    auxiliaryText?: string;
+}
+/**
+ * Displays the name and description of a `Group`.
+ */
+export declare function Header({ variant, title, auxiliaryText, children: _children, sx, ...props }: HeaderProps): JSX.Element;

package/lib/ActionList2/Header.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Header = Header;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _List = require("./List");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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); }
+
+/**
+ * Displays the name and description of a `Group`.
+ */
+function Header({
+  variant = 'subtle',
+  title,
+  auxiliaryText,
+  children: _children,
+  sx = {},
+  ...props
+}) {
+  const {
+    variant: listVariant
+  } = _react.default.useContext(_List.ListContext);
+
+  const styles = {
+    paddingY: '6px',
+    paddingX: listVariant === 'full' ? 2 : 3,
+    fontSize: 0,
+    fontWeight: 'bold',
+    color: 'fg.muted',
+    ...(variant === 'filled' && {
+      backgroundColor: 'canvas.subtle',
+      marginX: 0,
+      marginBottom: 2,
+      borderTop: '1px solid',
+      borderBottom: '1px solid',
+      borderColor: 'neutral.muted'
+    }),
+    ...sx
+  };
+  return /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    sx: styles,
+    role: "heading"
+  }, props), title, auxiliaryText && /*#__PURE__*/_react.default.createElement("span", null, "auxiliaryText"));
+}
+
+Header.displayName = "Header";

package/lib/ActionList2/Item.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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?
+ */
+import React from 'react';
+import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
+import { SxProp } from '../sx';
+export declare const getVariantStyles: (variant: ItemProps['variant'], disabled: ItemProps['disabled']) => {
+    color: (props: any) => any;
+    iconColor: (props: any) => any;
+    annotationColor: (props: any) => any;
+} | {
+    color: string;
+    iconColor: string;
+    annotationColor: string;
+};
+export declare type ItemProps = {
+    children: React.ReactNode;
+    onAction?: (event: React.MouseEvent<HTMLLIElement> | React.KeyboardEvent<HTMLLIElement>) => void;
+    selected?: boolean;
+    variant?: 'default' | 'danger';
+    disabled?: boolean;
+    showDivider?: boolean;
+} & SxProp;
+declare type SlotNames = 'LeadingVisual' | 'InlineDescription' | 'BlockDescription' | 'TrailingVisual';
+declare type ContextProps = {
+    registerSlot: (name: SlotNames, contents: React.ReactNode) => void;
+};
+export declare const ItemContext: React.Context<ContextProps>;
+export declare const Item: PolymorphicForwardRefComponent<"li", ItemProps>;
+export {};

package/lib/ActionList2/Item.js

@@ -0,0 +1,188 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Item = exports.ItemContext = exports.getVariantStyles = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _constants = require("../constants");
+
+var _List = require("./List");
+
+var _hacks = require("./hacks");
+
+var _Selection = require("./Selection");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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); }
+
+const getVariantStyles = (variant, disabled) => {
+  if (disabled) {
+    return {
+      color: (0, _constants.get)('colors.fg.muted'),
+      iconColor: (0, _constants.get)('colors.fg.muted'),
+      annotationColor: (0, _constants.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'
+      };
+  }
+};
+
+exports.getVariantStyles = getVariantStyles;
+
+const ItemContext = /*#__PURE__*/_react.default.createContext({
+  registerSlot: () => null
+});
+
+exports.ItemContext = ItemContext;
+
+const Item = /*#__PURE__*/_react.default.forwardRef(({
+  variant = 'default',
+  disabled = false,
+  selected = undefined,
+  showDivider = false,
+  onAction = () => null,
+  sx = {},
+  ...props
+}, forwardedRef) => {
+  const customItemTheme = _hacks.customItemThemes[variant];
+
+  const {
+    variant: listVariant
+  } = _react.default.useContext(_List.ListContext);
+
+  const {
+    theme
+  } = (0, _ThemeProvider.useTheme)();
+
+  const [slots, setSlots] = _react.default.useState({
+    LeadingVisual: null,
+    InlineDescription: null,
+    BlockDescription: null,
+    TrailingVisual: null
+  });
+
+  const registerSlot = (name, contents) => {
+    if (slots[name] === null) setSlots({ ...slots,
+      [name]: contents
+    });
+  };
+
+  const styles = {
+    display: 'flex',
+    paddingX: (0, _constants.get)('space.2'),
+    paddingY: '6px',
+    marginX: listVariant === 'inset' ? (0, _constants.get)('space.2') : 0,
+    minHeight: (0, _constants.get)('space.5'),
+    borderRadius: (0, _constants.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: (0, _ThemeProvider.useColorSchemeVar)(customItemTheme.hover, 'inherit')
+      },
+      ':focus': {
+        backgroundColor: (0, _ThemeProvider.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.default.useCallback(event => {
+    if (disabled) return;
+    if (!event.defaultPrevented) onAction(event);
+  }, [onAction, disabled]);
+
+  return /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    as: "li",
+    sx: styles,
+    "data-component": "ActionList.Item",
+    onClick: clickHandler,
+    ref: forwardedRef
+  }, props), /*#__PURE__*/_react.default.createElement(ItemContext.Provider, {
+    value: {
+      registerSlot
+    }
+  }, /*#__PURE__*/_react.default.createElement(_Selection.Selection, {
+    selected: selected,
+    disabled: disabled
+  }), slots.LeadingVisual, /*#__PURE__*/_react.default.createElement(_Box.default, {
+    "data-component": "ActionList.Item--Main",
+    sx: {
+      display: 'flex',
+      flexDirection: 'column',
+      flexGrow: 1,
+      minWidth: 0
+    }
+  }, /*#__PURE__*/_react.default.createElement(_Box.default, {
+    sx: {
+      display: 'flex'
+    }
+  }, /*#__PURE__*/_react.default.createElement(_Box.default, {
+    sx: {
+      display: 'flex',
+      flexGrow: 1,
+      alignItems: 'baseline',
+      minWidth: 0
+    }
+  }, /*#__PURE__*/_react.default.createElement("span", null, props.children), slots.InlineDescription), slots.TrailingVisual), slots.BlockDescription)));
+});
+
+exports.Item = Item;
+Item.displayName = 'ActionList.Item';

package/lib/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/ActionList2/List.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.List = exports.ListContext = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _constants = require("../constants");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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); }
+
+const ListContext = /*#__PURE__*/_react.default.createContext({});
+
+exports.ListContext = ListContext;
+
+const List = /*#__PURE__*/_react.default.forwardRef(({
+  variant = 'inset',
+  selectionVariant = 'single',
+  sx = {},
+  ...props
+}, forwardedRef) => {
+  const styles = {
+    margin: 0,
+    fontSize: (0, _constants.get)('fontSizes.1'),
+    lineHeight: '20px',
+    // TODO: check if we replace this already
+    paddingInlineStart: 0,
+    // reset ul styles
+    paddingY: variant === 'inset' ? (0, _constants.get)('space.2') : 0,
+    ...sx
+  };
+  return /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    as: "ul",
+    sx: styles
+  }, props, {
+    ref: forwardedRef
+  }), /*#__PURE__*/_react.default.createElement(ListContext.Provider, {
+    value: {
+      variant,
+      selectionVariant
+    }
+  }, props.children));
+});
+
+exports.List = List;
+List.displayName = 'ActionList';

package/lib/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/ActionList2/Selection.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Selection = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _octiconsReact = require("@primer/octicons-react");
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _List = require("./List");
+
+var _Visuals = require("./Visuals");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const Selection = ({
+  selected,
+  disabled
+}) => {
+  const {
+    selectionVariant
+  } = _react.default.useContext(_List.ListContext);
+
+  const {
+    theme
+  } = (0, _ThemeProvider.useTheme)();
+  if (typeof selected === 'undefined') return null;
+
+  if (selectionVariant === 'single') {
+    return /*#__PURE__*/_react.default.createElement(_Visuals.LeadingVisualContainer, null, selected && /*#__PURE__*/_react.default.createElement(_octiconsReact.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.default.createElement(_Visuals.LeadingVisualContainer, {
+      sx: {
+        input: {
+          margin: 0,
+          pointerEvents: 'none'
+        }
+      }
+    }, /*#__PURE__*/_react.default.createElement("input", {
+      type: "checkbox",
+      checked: selected,
+      disabled: disabled,
+      "aria-label": "TODO",
+      tabIndex: -1,
+      readOnly: true,
+      "aria-readonly": "false"
+    }));
+  }
+
+  return null;
+};
+
+exports.Selection = Selection;

package/lib/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 {};