@primer/components 0.0.0-20211040541 → 0.0.0-2021104151625

package/lib/ActionList2/Description.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import { SxProp } from '../sx';
+export declare type DescriptionProps = {
+    /**
+     * Secondary text style variations.
+     *
+     * - `"inline"` - Secondary text is positioned beside primary text.
+     * - `"block"` - Secondary text is positioned below primary text.
+     */
+    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,35 @@
+"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: 'actionListItem.inlineDivider',
+      marginTop: theme => `calc(${(0, _constants.get)('space.2')(theme)} - 1px)`,
+      marginBottom: 2,
+      listStyle: 'none' // hide the ::marker inserted by browser's stylesheet
+
+    },
+    "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,57 @@
+"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
+      },
+      listStyle: 'none',
+      // hide the ::marker inserted by browser's stylesheet
+      ...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 @@
+/// <reference types="react" />
+import { SxProp } from '../sx';
+/**
+ * Contract for props passed to the `Header` component.
+ */
+export declare type HeaderProps = {
+    /**
+     * 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;
+} & SxProp;
+/**
+ * Displays the name and description of a `Group`.
+ */
+export declare const Header: ({ variant, title, auxiliaryText, sx, ...props }: HeaderProps) => JSX.Element;

package/lib/ActionList2/Header.js

@@ -0,0 +1,55 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Header = void 0;
+
+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`.
+ */
+const Header = ({
+  variant = 'subtle',
+  title,
+  auxiliaryText,
+  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));
+};
+
+exports.Header = Header;
+Header.displayName = "Header";

package/lib/ActionList2/Item.d.ts

@@ -0,0 +1,67 @@
+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;
+    hoverColor?: undefined;
+    selectedBg?: undefined;
+} | {
+    color: string;
+    iconColor: string;
+    annotationColor: string;
+    hoverColor: string;
+    selectedBg?: undefined;
+} | {
+    color: string;
+    iconColor: string;
+    annotationColor: string;
+    hoverColor: string;
+    selectedBg: 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;
+    /**
+     * Private API for use internally only. Used by LinkItem to wrap contents in an anchor
+     */
+    _PrivateItemWrapper?: React.FC;
+} & 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 TEXT_ROW_HEIGHT = "20px";
+export declare const Item: PolymorphicForwardRefComponent<"li", ItemProps>;

package/lib/ActionList2/Item.js

@@ -0,0 +1,221 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Item = exports.TEXT_ROW_HEIGHT = 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 _sx = require("../sx");
+
+var _createSlots = _interopRequireDefault(require("../utils/create-slots"));
+
+var _List = require("./List");
+
+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',
+        hoverColor: 'actionListItem.danger.hoverText'
+      };
+
+    default:
+      return {
+        color: 'fg.default',
+        iconColor: 'fg.muted',
+        annotationColor: 'fg.muted',
+        hoverColor: 'fg.default',
+        selectedBg: 'actionListItem.default.selectedBg'
+      };
+  }
+};
+
+exports.getVariantStyles = getVariantStyles;
+const {
+  Slots,
+  Slot
+} = (0, _createSlots.default)(['LeadingVisual', 'InlineDescription', 'BlockDescription', 'TrailingVisual']);
+exports.Slot = Slot;
+const TEXT_ROW_HEIGHT = '20px'; // custom value off the scale
+
+exports.TEXT_ROW_HEIGHT = TEXT_ROW_HEIGHT;
+
+const Item = /*#__PURE__*/_react.default.forwardRef(({
+  variant = 'default',
+  disabled = false,
+  selected = undefined,
+  onSelect = () => null,
+  sx = {},
+  _PrivateItemWrapper = ({
+    children
+  }) => /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, children),
+  ...props
+}, forwardedRef) => {
+  const {
+    variant: listVariant,
+    showDividers
+  } = _react.default.useContext(_List.ListContext);
+
+  const {
+    theme
+  } = (0, _ThemeProvider.useTheme)();
+  const styles = {
+    display: 'flex',
+    paddingX: 2,
+    fontSize: 1,
+    paddingY: '6px',
+    // custom value off the scale
+    lineHeight: TEXT_ROW_HEIGHT,
+    marginX: listVariant === 'inset' ? 2 : 0,
+    minHeight: 5,
+    borderRadius: 2,
+    transition: 'background 33.333ms linear',
+    color: getVariantStyles(variant, disabled).color,
+    textDecoration: 'none',
+    // for as="a"
+    '&[aria-selected=true]': {
+      backgroundColor: getVariantStyles(variant, disabled).selectedBg
+    },
+    ':not([aria-disabled])': {
+      cursor: 'pointer'
+    },
+    '@media (hover: hover) and (pointer: fine)': {
+      ':hover:not([aria-disabled])': {
+        backgroundColor: `actionListItem.${variant}.hoverBg`,
+        color: getVariantStyles(variant, disabled).hoverColor
+      },
+      ':focus:not([aria-disabled])': {
+        backgroundColor: `actionListItem.${variant}.activeBg`,
+        color: getVariantStyles(variant, disabled).hoverColor,
+        outline: 'none'
+      }
+    },
+
+    /** 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):not([aria-selected=true])': {
+      '--divider-color': theme === null || theme === void 0 ? void 0 : theme.colors.actionListItem.inlineDivider
+    },
+    // hide divider after dividers & group header, with higher importance!
+    '[data-component="ActionList.Divider"] + &': {
+      '--divider-color': 'transparent !important'
+    },
+    // 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'
+    },
+    // hide border around selected item
+    '&[aria-selected=true] + &': {
+      '--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,
+    tabIndex: disabled ? undefined : -1,
+    "aria-labelledby": labelId,
+    "aria-describedby": [slots.InlineDescription && inlineDescriptionId, slots.BlockDescription && blockDescriptionId].filter(Boolean).join(' ')
+  }, props), /*#__PURE__*/_react.default.createElement(_PrivateItemWrapper, null, /*#__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/LinkItem.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
+import { ItemProps } from './Item';
+declare type LinkProps = {
+    download?: string;
+    href?: string;
+    hrefLang?: string;
+    media?: string;
+    ping?: string;
+    rel?: string;
+    target?: string;
+    type?: string;
+    referrerPolicy?: React.AnchorHTMLAttributes<HTMLAnchorElement>['referrerPolicy'];
+};
+declare type LinkItemProps = Pick<ItemProps, 'children' | 'sx'> & LinkProps;
+export declare const LinkItem: PolymorphicForwardRefComponent<"a", LinkItemProps>;
+export {};

package/lib/ActionList2/LinkItem.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.LinkItem = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Link = _interopRequireDefault(require("../Link"));
+
+var _sx = require("../sx");
+
+var _Item = require("./Item");
+
+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 LinkItem = /*#__PURE__*/_react.default.forwardRef(({
+  sx = {},
+  as: Component,
+  ...props
+}, forwardedRef) => {
+  const styles = {
+    // occupy full size of Item
+    paddingX: 2,
+    paddingY: '6px',
+    // custom value off the scale
+    display: 'flex',
+    flexGrow: 1,
+    // full width
+    borderRadius: 2,
+    // inherit Item styles
+    color: 'inherit',
+    '&:hover': {
+      color: 'inherit',
+      textDecoration: 'none'
+    }
+  };
+  return /*#__PURE__*/_react.default.createElement(_Item.Item, {
+    sx: {
+      paddingY: 0,
+      paddingX: 0
+    },
+    _PrivateItemWrapper: ({
+      children
+    }) => /*#__PURE__*/_react.default.createElement(_Link.default, _extends({
+      as: Component,
+      sx: (0, _sx.merge)(styles, sx)
+    }, props, {
+      ref: forwardedRef
+    }), children)
+  }, props.children);
+});
+
+exports.LinkItem = LinkItem;

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 {};