@primer/components 0.0.0-20219283497 → 0.0.0-2021929114541

package/lib/ActionList2/Description.d.ts

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

package/lib/ActionList2/Description.js

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

package/lib/ActionList2/Divider.d.ts

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

package/lib/ActionList2/Divider.js

@@ -0,0 +1,33 @@
+"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: "li",
+    role: "separator",
+    sx: {
+      height: 1,
+      backgroundColor: 'border.muted',
+      marginTop: theme => `calc(${(0, _constants.get)('space.2')(theme)} - 1px)`,
+      marginBottom: 2
+    },
+    "data-component": "ActionList.Divider"
+  });
+}
+
+Divider.displayName = "Divider";

package/lib/ActionList2/Group.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { SxProp } from '../sx';
+import { HeaderProps } from './Header';
+import { ListProps } from './List';
+export declare type GroupProps = HeaderProps & SxProp & {
+    selectionVariant?: ListProps['selectionVariant'] | false;
+};
+declare type ContextProps = Pick<GroupProps, 'selectionVariant'>;
+export declare const GroupContext: React.Context<ContextProps>;
+export declare const Group: React.FC<GroupProps>;
+export {};

package/lib/ActionList2/Group.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Group = exports.GroupContext = void 0;
+
+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); }
+
+const GroupContext = /*#__PURE__*/_react.default.createContext({});
+
+exports.GroupContext = GroupContext;
+
+const Group = ({
+  title,
+  variant,
+  auxiliaryText,
+  selectionVariant,
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    as: "li",
+    sx: {
+      '&:not(:first-child)': {
+        marginTop: 2
+      },
+      ...sx
+    }
+  }, props), title && /*#__PURE__*/_react.default.createElement(_Header.Header, {
+    title: title,
+    variant: variant,
+    auxiliaryText: auxiliaryText
+  }), /*#__PURE__*/_react.default.createElement(GroupContext.Provider, {
+    value: {
+      selectionVariant
+    }
+  }, /*#__PURE__*/_react.default.createElement(_Box.default, {
+    as: "ul",
+    sx: {
+      paddingInlineStart: 0
+    }
+  }, props.children)));
+};
+
+exports.Group = Group;
+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,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/ActionList2/Item.js

@@ -0,0 +1,204 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Item = exports.Slot = exports.getVariantStyles = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _ssr = require("@react-aria/ssr");
+
+var _ThemeProvider = require("../ThemeProvider");
+
+var _Box = _interopRequireDefault(require("../Box"));
+
+var _constants = require("../constants");
+
+var _sx = require("../sx");
+
+var _createSlots = _interopRequireDefault(require("../utils/create-slots"));
+
+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: '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'
+      };
+  }
+};
+
+exports.getVariantStyles = getVariantStyles;
+const {
+  Slots,
+  Slot
+} = (0, _createSlots.default)(['LeadingVisual', 'InlineDescription', 'BlockDescription', 'TrailingVisual']);
+exports.Slot = Slot;
+
+const Item = /*#__PURE__*/_react.default.forwardRef(({
+  variant = 'default',
+  disabled = false,
+  selected = undefined,
+  onSelect = () => null,
+  sx = {},
+  ...props
+}, forwardedRef) => {
+  const customItemTheme = _hacks.customItemThemes[variant];
+
+  const {
+    variant: listVariant,
+    showDividers
+  } = _react.default.useContext(_List.ListContext);
+
+  const {
+    theme
+  } = (0, _ThemeProvider.useTheme)();
+  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([aria-disabled])': {
+      cursor: 'pointer'
+    },
+    '@media (hover: hover) and (pointer: fine)': {
+      ':hover:not([aria-disabled])': {
+        backgroundColor: (0, _ThemeProvider.useColorSchemeVar)(customItemTheme.hover, 'inherit')
+      },
+      ':focus:not([aria-disabled])': {
+        backgroundColor: (0, _ThemeProvider.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.default.useCallback(event => {
+    if (disabled) return;
+    if (!event.defaultPrevented) onSelect(event);
+  }, [onSelect, disabled]);
+
+  const labelId = (0, _ssr.useSSRSafeId)();
+  const inlineDescriptionId = (0, _ssr.useSSRSafeId)();
+  const blockDescriptionId = (0, _ssr.useSSRSafeId)();
+  return /*#__PURE__*/_react.default.createElement(Slots, {
+    context: {
+      variant,
+      disabled,
+      inlineDescriptionId,
+      blockDescriptionId
+    }
+  }, slots => /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    as: "li",
+    ref: forwardedRef,
+    sx: (0, _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.default.createElement(_Selection.Selection, {
+    selected: selected,
+    disabled: disabled
+  }), slots.LeadingVisual, /*#__PURE__*/_react.default.createElement(_Box.default, {
+    "data-component": "ActionList.Item--DividerContainer",
+    sx: {
+      display: 'flex',
+      flexDirection: 'column',
+      flexGrow: 1,
+      minWidth: 0
+    }
+  }, /*#__PURE__*/_react.default.createElement(ConditionalBox, {
+    if: Boolean(slots.TrailingVisual),
+    sx: {
+      display: 'flex',
+      flexGrow: 1
+    }
+  }, /*#__PURE__*/_react.default.createElement(ConditionalBox, {
+    if: Boolean(slots.InlineDescription),
+    sx: {
+      display: 'flex',
+      flexGrow: 1,
+      alignItems: 'baseline',
+      minWidth: 0
+    }
+  }, /*#__PURE__*/_react.default.createElement(_Box.default, {
+    as: "span",
+    id: labelId,
+    sx: {
+      flexGrow: slots.InlineDescription ? 0 : 1
+    }
+  }, props.children), slots.InlineDescription), slots.TrailingVisual), slots.BlockDescription)));
+});
+
+exports.Item = Item;
+Item.displayName = 'ActionList.Item';
+
+const ConditionalBox = props => {
+  const {
+    if: condition,
+    ...rest
+  } = props;
+  if (condition) return /*#__PURE__*/_react.default.createElement(_Box.default, rest, props.children);else return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, props.children);
+};

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

@@ -0,0 +1,56 @@
+"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");
+
+var _sx = require("../sx");
+
+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,
+  showDividers = false,
+  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
+  };
+  return /*#__PURE__*/_react.default.createElement(_Box.default, _extends({
+    as: "ul",
+    sx: (0, _sx.merge)(styles, sx),
+    "aria-multiselectable": selectionVariant === 'multiple' ? true : undefined
+  }, props, {
+    ref: forwardedRef
+  }), /*#__PURE__*/_react.default.createElement(ListContext.Provider, {
+    value: {
+      variant,
+      selectionVariant,
+      showDividers
+    }
+  }, 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,73 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Selection = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _octiconsReact = require("@primer/octicons-react");
+
+var _List = require("./List");
+
+var _Group = require("./Group");
+
+var _Visuals = require("./Visuals");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const Selection = ({
+  selected,
+  disabled
+}) => {
+  const {
+    selectionVariant: listSelectionVariant
+  } = _react.default.useContext(_List.ListContext);
+
+  const {
+    selectionVariant: groupSelectionVariant
+  } = _react.default.useContext(_Group.GroupContext);
+  /** selectionVariant in Group can override the selectionVariant in List root */
+
+
+  const selectionVariant = typeof groupSelectionVariant !== 'undefined' ? groupSelectionVariant : listSelectionVariant; // 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.default.createElement(_Visuals.LeadingVisualContainer, null, selected && /*#__PURE__*/_react.default.createElement(_octiconsReact.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.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"
+  }));
+};
+
+exports.Selection = Selection;
+Selection.displayName = "Selection";

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