@primer/components 0.0.0-202192801738 → 0.0.0-2021928142718

package/lib-esm/ActionList2/Group.js

@@ -0,0 +1,35 @@
+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); }
+
+/**
+ * show item dividers
+ */
+import React from 'react';
+import Box from '../Box';
+import { Header } from './Header';
+export const Group = ({
+  title,
+  variant,
+  auxiliaryText,
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    as: "li",
+    sx: {
+      '&:not(:first-child)': {
+        marginTop: 2
+      },
+      ...sx
+    }
+  }, props), title && /*#__PURE__*/React.createElement(Header, {
+    title: title,
+    variant: variant,
+    auxiliaryText: auxiliaryText
+  }), /*#__PURE__*/React.createElement(Box, {
+    as: "ul",
+    sx: {
+      paddingInlineStart: 0
+    }
+  }, props.children));
+};
+Group.displayName = "Group";

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

@@ -0,0 +1,45 @@
+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 { ListContext } from './List';
+/**
+ * Contract for props passed to the `Header` component.
+ */
+
+/**
+ * Displays the name and description of a `Group`.
+ */
+export function Header({
+  variant = 'subtle',
+  title,
+  auxiliaryText,
+  children: _children,
+  sx = {},
+  ...props
+}) {
+  const {
+    variant: listVariant
+  } = React.useContext(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.createElement(Box, _extends({
+    sx: styles,
+    role: "heading"
+  }, props), title, auxiliaryText && /*#__PURE__*/React.createElement("span", null, "auxiliaryText"));
+}
+Header.displayName = "Header";

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

@@ -0,0 +1,48 @@
+import React from 'react';
+import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
+import { SxProp } from '../sx';
+import { AriaRole } from '../utils/types';
+export declare const getVariantStyles: (variant: ItemProps['variant'], disabled: ItemProps['disabled']) => {
+    color: string;
+    iconColor: string;
+    annotationColor: string;
+};
+export declare type ItemProps = {
+    /**
+     * Primary content for an Item
+     */
+    children: React.ReactNode;
+    /**
+     * Callback that will trigger both on click selection and keyboard selection.
+     */
+    onSelect?: (event: React.MouseEvent<HTMLLIElement> | React.KeyboardEvent<HTMLLIElement>) => void;
+    /**
+     * Is the `Item` is currently selected?
+     */
+    selected?: boolean;
+    /**
+     * Style variations associated with various `Item` types.
+     *
+     * - `"default"` - An action `Item`.
+     * - `"danger"` - A destructive action `Item`.
+     */
+    variant?: 'default' | 'danger';
+    /**
+     * Items that are disabled can not be clicked, selected, or navigated through.
+     */
+    disabled?: boolean;
+    /**
+     * The ARIA role describing the function of `Item` component. `option` is a common value. |
+     */
+    role?: AriaRole;
+} & SxProp;
+declare const Slot: React.FC<{
+    name: "LeadingVisual" | "InlineDescription" | "BlockDescription" | "TrailingVisual";
+    children: React.ReactNode | ((context: Record<string, unknown>) => React.ReactNode);
+}>;
+export { Slot };
+export declare type ItemContext = Pick<ItemProps, 'variant' | 'disabled'> & {
+    inlineDescriptionId: string;
+    blockDescriptionId: string;
+};
+export declare const Item: PolymorphicForwardRefComponent<"li", ItemProps>;

package/lib-esm/ActionList2/Item.js

@@ -0,0 +1,176 @@
+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 { useSSRSafeId } from '@react-aria/ssr';
+import { useColorSchemeVar, useTheme } from '../ThemeProvider';
+import Box from '../Box';
+import { get } from '../constants';
+import { merge } from '../sx';
+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: 'fg.muted',
+      iconColor: 'fg.muted',
+      annotationColor: '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,
+  onSelect = () => null,
+  sx = {},
+  ...props
+}, forwardedRef) => {
+  const customItemTheme = customItemThemes[variant];
+  const {
+    variant: listVariant,
+    showDividers
+  } = 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([aria-disabled])': {
+      cursor: 'pointer'
+    },
+    '@media (hover: hover) and (pointer: fine)': {
+      ':hover:not([aria-disabled])': {
+        backgroundColor: useColorSchemeVar(customItemTheme.hover, 'inherit')
+      },
+      ':focus:not([aria-disabled])': {
+        backgroundColor: useColorSchemeVar(customItemTheme.focus, 'inherit')
+      }
+    },
+
+    /** Divider styles */
+    '[data-component="ActionList.Item--DividerContainer"]': {
+      position: 'relative'
+    },
+    '[data-component="ActionList.Item--DividerContainer"]::before': {
+      content: '" "',
+      display: 'block',
+      position: 'absolute',
+      width: '100%',
+      top: '-7px',
+      border: '0 solid',
+      borderTopWidth: showDividers ? `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:not([aria-disabled]), &:focus:not([aria-disabled])': {
+      '--divider-color': 'transparent'
+    },
+    '&:hover:not([aria-disabled]) + &, &:focus:not([aria-disabled]) + &': {
+      '--divider-color': 'transparent'
+    }
+  };
+  const clickHandler = React.useCallback(event => {
+    if (disabled) return;
+    if (!event.defaultPrevented) onSelect(event);
+  }, [onSelect, disabled]);
+  const labelId = useSSRSafeId();
+  const inlineDescriptionId = useSSRSafeId();
+  const blockDescriptionId = useSSRSafeId();
+  return /*#__PURE__*/React.createElement(Slots, {
+    context: {
+      variant,
+      disabled,
+      inlineDescriptionId,
+      blockDescriptionId
+    }
+  }, slots => /*#__PURE__*/React.createElement(Box, _extends({
+    as: "li",
+    ref: forwardedRef,
+    sx: merge(styles, sx),
+    onClick: clickHandler,
+    "aria-selected": selected,
+    "aria-disabled": disabled ? true : undefined,
+    "aria-labelledby": labelId,
+    "aria-describedby": [slots.InlineDescription && inlineDescriptionId, slots.BlockDescription && blockDescriptionId].filter(Boolean).join(' ')
+  }, props), /*#__PURE__*/React.createElement(Selection, {
+    selected: selected,
+    disabled: disabled
+  }), slots.LeadingVisual, /*#__PURE__*/React.createElement(Box, {
+    "data-component": "ActionList.Item--DividerContainer",
+    sx: {
+      display: 'flex',
+      flexDirection: 'column',
+      flexGrow: 1,
+      minWidth: 0
+    }
+  }, /*#__PURE__*/React.createElement(ConditionalBox, {
+    if: Boolean(slots.TrailingVisual),
+    sx: {
+      display: 'flex',
+      flexGrow: 1
+    }
+  }, /*#__PURE__*/React.createElement(ConditionalBox, {
+    if: Boolean(slots.InlineDescription),
+    sx: {
+      display: 'flex',
+      flexGrow: 1,
+      alignItems: 'baseline',
+      minWidth: 0
+    }
+  }, /*#__PURE__*/React.createElement(Box, {
+    as: "span",
+    id: labelId,
+    sx: {
+      flexGrow: slots.InlineDescription ? 0 : 1
+    }
+  }, props.children), slots.InlineDescription), slots.TrailingVisual), slots.BlockDescription)));
+});
+Item.displayName = 'ActionList.Item';
+
+const ConditionalBox = props => {
+  const {
+    if: condition,
+    ...rest
+  } = props;
+  if (condition) return /*#__PURE__*/React.createElement(Box, rest, props.children);else return /*#__PURE__*/React.createElement(React.Fragment, null, props.children);
+};

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

@@ -0,0 +1,26 @@
+import React from 'react';
+import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
+import { SxProp } from '../sx';
+import { AriaRole } from '../utils/types';
+export declare type ListProps = {
+    /**
+     * `inset` children are offset (vertically and horizontally) from `List`’s edges, `full` children are flush (vertically and horizontally) with `List` edges
+     */
+    variant?: 'inset' | 'full';
+    /**
+     * Whether multiple Items or a single Item can be selected.
+     */
+    selectionVariant?: 'single' | 'multiple';
+    /**
+     * Display a divider above each `Item` in this `List` when it does not follow a `Header` or `Divider`.
+     */
+    showDividers?: boolean;
+    /**
+     * The ARIA role describing the function of `List` component. `listbox` or `menu` are a common values.
+     */
+    role?: AriaRole;
+} & SxProp;
+declare type ContextProps = Omit<ListProps, 'sx'>;
+export declare const ListContext: React.Context<ContextProps>;
+export declare const List: PolymorphicForwardRefComponent<"ul", ListProps>;
+export {};

package/lib-esm/ActionList2/List.js

@@ -0,0 +1,38 @@
+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 { merge } from '../sx';
+export const ListContext = /*#__PURE__*/React.createContext({});
+export const List = /*#__PURE__*/React.forwardRef(({
+  variant = 'inset',
+  selectionVariant,
+  showDividers = false,
+  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
+  };
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    as: "ul",
+    sx: merge(styles, sx),
+    "aria-multiselectable": selectionVariant === 'multiple' ? true : undefined
+  }, props, {
+    ref: forwardedRef
+  }), /*#__PURE__*/React.createElement(ListContext.Provider, {
+    value: {
+      variant,
+      selectionVariant,
+      showDividers
+    }
+  }, 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,48 @@
+import React from 'react';
+import { CheckIcon } from '@primer/octicons-react';
+import { ListContext } from './List';
+import { LeadingVisualContainer } from './Visuals';
+export const Selection = ({
+  selected,
+  disabled
+}) => {
+  const {
+    selectionVariant
+  } = React.useContext(ListContext); // if selectionVariant is not set on List, don't show selection
+
+  if (!selectionVariant) {
+    // to avoid confusion, fail loudly instead of silently ignoring
+    if (selected) throw new Error('For Item to be selected, List needs to have a selectionVariant defined');
+    return null;
+  }
+
+  if (selectionVariant === 'single') {
+    return /*#__PURE__*/React.createElement(LeadingVisualContainer, null, selected && /*#__PURE__*/React.createElement(CheckIcon, null));
+  }
+  /**
+   * selectionVariant is 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"
+  }));
+};
+Selection.displayName = "Selection";

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

@@ -0,0 +1,11 @@
+import React from 'react';
+import { SxProp } from '../sx';
+declare type VisualProps = SxProp & {
+    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,68 @@
+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 { merge } from '../sx';
+import { get } from '../constants';
+import { getVariantStyles, Slot } from './Item';
+export const LeadingVisualContainer = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    as: "span",
+    sx: merge({
+      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 = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: "LeadingVisual"
+  }, ({
+    variant,
+    disabled
+  }) => /*#__PURE__*/React.createElement(LeadingVisualContainer, _extends({
+    sx: merge({
+      color: getVariantStyles(variant, disabled).iconColor,
+      svg: {
+        fontSize: 0
+      }
+    }, sx)
+  }, props), props.children));
+};
+LeadingVisual.displayName = "LeadingVisual";
+export const TrailingVisual = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Slot, {
+    name: "TrailingVisual"
+  }, ({
+    variant,
+    disabled
+  }) => /*#__PURE__*/React.createElement(Box, _extends({
+    as: "span",
+    sx: merge({
+      height: '20px',
+      // match height of text row
+      flexShrink: 0,
+      color: getVariantStyles(variant, disabled).annotationColor,
+      marginLeft: 2
+    }, sx)
+  }, 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,25 @@
+/// <reference types="react" />
+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: import("react").FC<import("./Group").GroupProps>;
+    /** 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<import("../sx").SxProp & {
+        children: import("react").ReactNode;
+    }>;
+    TrailingVisual: import("react").FC<import("../sx").SxProp & {
+        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/AnchoredOverlay/AnchoredOverlay.d.ts

@@ -26,8 +26,6 @@ interface AnchoredOverlayPropsWithoutAnchor {
      */
     anchorRef: React.RefObject<HTMLElement>;
 }
-export declare type OverlayOpenGesture = 'anchor-click' | 'anchor-key-press';
-export declare type OverlayCloseGesture = 'anchor-click' | 'click-outside' | 'escape';
 export declare type AnchoredOverlayWrapperAnchorProps = Partial<AnchoredOverlayPropsWithAnchor> | AnchoredOverlayPropsWithoutAnchor;
 interface AnchoredOverlayBaseProps extends Pick<OverlayProps, 'height' | 'width'> {
     /**
@@ -37,11 +35,11 @@ interface AnchoredOverlayBaseProps extends Pick<OverlayProps, 'height' | 'width'
     /**
      * A callback which is called whenever the overlay is currently closed and an "open gesture" is detected.
      */
-    onOpen?: (gesture: OverlayOpenGesture) => unknown;
+    onOpen?: (gesture: 'anchor-click' | 'anchor-key-press') => unknown;
     /**
      * A callback which is called whenever the overlay is currently open and a "close gesture" is detected.
      */
-    onClose?: (gesture: OverlayCloseGesture) => unknown;
+    onClose?: (gesture: 'anchor-click' | 'click-outside' | 'escape') => unknown;
     /**
      * Props to be spread on the internal `Overlay` component.
      */