@primer/components 0.0.0-202191914226 → 0.0.0-2021919184749

package/lib/ActionList2/index.d.ts

@@ -1,26 +0,0 @@
-/// <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/ActionList2/index.js

@@ -1,36 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.ActionList = void 0;
-
-var _List = require("./List");
-
-var _Group = require("./Group");
-
-var _Item = require("./Item");
-
-var _Divider = require("./Divider");
-
-var _Description = require("./Description");
-
-var _Visuals = require("./Visuals");
-
-/**
- * Collection of list-related components.
- */
-const ActionList = Object.assign(_List.List, {
-  /** Collects related `Items` in an `ActionList`. */
-  Group: _Group.Group,
-
-  /** An actionable or selectable `Item` with an optional icon and description. */
-  Item: _Item.Item,
-
-  /** Visually separates `Item`s or `Group`s in an `ActionList`. */
-  Divider: _Divider.Divider,
-  Description: _Description.Description,
-  LeadingVisual: _Visuals.LeadingVisual,
-  TrailingVisual: _Visuals.TrailingVisual
-});
-exports.ActionList = ActionList;

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

@@ -1,15 +0,0 @@
-import React from 'react';
-/** createSlots is a factory that can create a
- *  typed Slots + Slot combination to use in a component definition
- *  For example: ActionList uses createSlots to get a Slots wrapper
- *  Slot component that can be used inside each Item
- */
-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/utils/create-slots.js

@@ -1,101 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _useForceUpdate = require("./use-force-update");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/** createSlots is a factory that can create a
- *  typed Slots + Slot combination to use in a component definition
- *  For example: ActionList uses createSlots to get a Slots wrapper
- *  Slot component that can be used inside each Item
- */
-const createSlots = slotNames => {
-  const SlotsContext = /*#__PURE__*/_react.default.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.default.useRef(slotsDefinition);
-
-    const rerenderWithSlots = (0, _useForceUpdate.useForceUpdate)();
-
-    const [isMounted, setIsMounted] = _react.default.useState(false); // fires after all the effects in children
-
-
-    _react.default.useEffect(() => {
-      rerenderWithSlots();
-      setIsMounted(true);
-    }, [rerenderWithSlots]);
-
-    const slots = slotsRef.current;
-
-    const registerSlot = _react.default.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.default.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.default.createElement(SlotsContext.Provider, {
-      value: {
-        registerSlot,
-        unregisterSlot
-      }
-    }, children(slots));
-  };
-
-  const Slot = ({
-    name,
-    children
-  }) => {
-    const {
-      registerSlot,
-      unregisterSlot
-    } = _react.default.useContext(SlotsContext);
-
-    _react.default.useEffect(() => {
-      registerSlot(name, children);
-      return () => unregisterSlot(name);
-    }, [name, children, registerSlot, unregisterSlot]);
-
-    return null;
-  };
-
-  return {
-    Slots,
-    Slot
-  };
-};
-
-var _default = createSlots;
-exports.default = _default;

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

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

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

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useForceUpdate = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Inspired from reach-ui: https://github.com/reach/reach-ui/blob/develop/packages/utils/src/use-force-update.ts
-const useForceUpdate = () => {
-  const [, rerender] = _react.default.useState({});
-
-  return _react.default.useCallback(() => rerender({}), []);
-};
-
-exports.useForceUpdate = useForceUpdate;

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

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

package/lib-esm/ActionList2/Description.js

@@ -1,30 +0,0 @@
-import React from 'react';
-import Box from '../Box';
-import Truncate from '../Truncate';
-import { Slot } from './Item';
-export const Description = ({
-  variant = 'inline',
-  ...props
-}) => {
-  const styles = {
-    color: 'fg.muted',
-    fontSize: 0,
-    lineHeight: '16px',
-    flexGrow: 1,
-    flexBasis: 0,
-    minWidth: 0,
-    marginLeft: variant === 'block' ? 0 : 2
-  };
-  return /*#__PURE__*/React.createElement(Slot, {
-    name: variant === 'block' ? 'BlockDescription' : 'InlineDescription'
-  }, variant === 'block' ? /*#__PURE__*/React.createElement(Box, {
-    as: "span",
-    sx: styles
-  }, props.children) : /*#__PURE__*/React.createElement(Truncate, {
-    sx: styles,
-    title: props.children,
-    inline: true,
-    maxWidth: "100%"
-  }, props.children));
-};
-Description.displayName = "Description";

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

@@ -1,8 +0,0 @@
-/// <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-esm/ActionList2/Divider.js

@@ -1,30 +0,0 @@
-import React from 'react';
-import Box from '../Box';
-import { get } from '../constants';
-
-/**
- * Visually separates `Item`s or `Group`s in an `ActionList`.
- */
-export function Divider() {
-  return /*#__PURE__*/React.createElement(Box, {
-    as: "hr",
-    sx: {
-      border: 'none',
-      // override browser styles
-      height: 1,
-      backgroundColor: 'border.muted',
-      marginTop: theme => `calc(${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-esm/ActionList2/Group.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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-esm/ActionList2/Group.js

@@ -1,29 +0,0 @@
-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 function Group({
-  title,
-  variant,
-  auxiliaryText,
-  sx = {},
-  ...props
-}) {
-  return /*#__PURE__*/React.createElement(Box, _extends({
-    sx: {
-      '&:not(:first-child)': {
-        marginTop: 2
-      },
-      ...sx
-    }
-  }, props), title && /*#__PURE__*/React.createElement(Header, {
-    title: title,
-    variant: variant,
-    auxiliaryText: auxiliaryText
-  }), props.children);
-}
-Group.displayName = "Group";

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

@@ -1,26 +0,0 @@
-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

@@ -1,45 +0,0 @@
-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

@@ -1,52 +0,0 @@
-/**
- * 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 { 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;
-};
-declare const Slot: React.FC<{
-    name: "LeadingVisual" | "InlineDescription" | "BlockDescription" | "TrailingVisual";
-}>;
-export { Slot };
-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;
-export declare const Item: PolymorphicForwardRefComponent<"li", ItemProps>;

package/lib-esm/ActionList2/Item.js

@@ -1,172 +0,0 @@
-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

@@ -1,18 +0,0 @@
-/**
- *
- * 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

@@ -1,42 +0,0 @@
-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';