@primer/components 0.0.0-2021111171525 → 0.0.0-20211111716

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

@@ -0,0 +1,9 @@
+import React from 'react';
+import { SxProp } from '../sx';
+declare type VisualProps = SxProp & React.HTMLAttributes<HTMLSpanElement>;
+export declare const LeadingVisualContainer: React.FC<VisualProps>;
+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, TEXT_ROW_HEIGHT } from './Item';
+export const LeadingVisualContainer = ({
+  sx = {},
+  ...props
+}) => {
+  return /*#__PURE__*/React.createElement(Box, _extends({
+    as: "span",
+    sx: merge({
+      height: TEXT_ROW_HEIGHT,
+      // match height of text row
+      minWidth: get('space.3'),
+      maxWidth: TEXT_ROW_HEIGHT,
+      // 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/index.d.ts

@@ -0,0 +1,36 @@
+/// <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` */
+    Item: import("@radix-ui/react-polymorphic").ForwardRefComponent<"li", import("./Item").ItemProps>;
+    /** A `Item` that renders a full-size anchor inside ListItem */
+    LinkItem: import("@radix-ui/react-polymorphic").ForwardRefComponent<"a", Pick<import("./Item").ItemProps, "children" | "sx"> & {
+        download?: string | undefined;
+        href?: string | undefined;
+        hrefLang?: string | undefined;
+        media?: string | undefined;
+        ping?: string | undefined;
+        rel?: string | undefined;
+        target?: string | undefined;
+        type?: string | undefined;
+        referrerPolicy?: import("react").HTMLAttributeReferrerPolicy | undefined;
+    }>;
+    /** Visually separates `Item`s or `Group`s in an `ActionList`. */
+    Divider: typeof Divider;
+    /** Secondary text which provides additional information about an `Item`. */
+    Description: import("react").FC<import("./Description").DescriptionProps>;
+    /** Icon (or similar) positioned before `Item` text. */
+    LeadingVisual: import("react").FC<import("../sx").SxProp & import("react").HTMLAttributes<HTMLSpanElement>>;
+    /** Icon (or similar) positioned after `Item` text. */
+    TrailingVisual: import("react").FC<import("../sx").SxProp & import("react").HTMLAttributes<HTMLSpanElement>>;
+};

package/lib-esm/ActionList2/index.js

@@ -0,0 +1,33 @@
+import { List } from './List';
+import { Group } from './Group';
+import { Item } from './Item';
+import { LinkItem } from './LinkItem';
+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` */
+  Item,
+
+  /** A `Item` that renders a full-size anchor inside ListItem */
+  LinkItem,
+
+  /** Visually separates `Item`s or `Group`s in an `ActionList`. */
+  Divider,
+
+  /** Secondary text which provides additional information about an `Item`. */
+  Description,
+
+  /** Icon (or similar) positioned before `Item` text. */
+  LeadingVisual,
+
+  /** Icon (or similar) positioned after `Item` text. */
+  TrailingVisual
+});

package/lib-esm/ActionMenu.d.ts

@@ -0,0 +1,40 @@
+import { GroupedListProps, ListPropsBase } from './ActionList/List';
+import { ItemProps } from './ActionList/Item';
+import { Divider } from './ActionList/Divider';
+import React from 'react';
+import { OverlayProps } from './Overlay';
+import { AnchoredOverlayWrapperAnchorProps } from './AnchoredOverlay/AnchoredOverlay';
+interface ActionMenuBaseProps extends Partial<Omit<GroupedListProps, keyof ListPropsBase>>, ListPropsBase {
+    /**
+     * Content that is passed into the renderAnchor component, which is a button by default.
+     */
+    anchorContent?: React.ReactNode;
+    /**
+     * A callback that triggers both on clicks and keyboard events. This callback will be overridden by item level `onAction` callbacks.
+     */
+    onAction?: (props: ItemProps, event?: React.MouseEvent<HTMLDivElement> | React.KeyboardEvent<HTMLDivElement>) => void;
+    /**
+     * If defined, will control the open/closed state of the overlay. Must be used in conjuction with `setOpen`.
+     */
+    open?: boolean;
+    /**
+     * If defined, will control the open/closed state of the overlay. Must be used in conjuction with `open`.
+     */
+    setOpen?: (s: boolean) => void;
+    /**
+     * Props to be spread on the internal `Overlay` component.
+     */
+    overlayProps?: Partial<OverlayProps>;
+}
+export declare type ActionMenuProps = ActionMenuBaseProps & AnchoredOverlayWrapperAnchorProps;
+export declare const ActionMenu: {
+    ({ anchorContent, renderAnchor, anchorRef: externalAnchorRef, onAction, open, setOpen, overlayProps, items, ...listProps }: ActionMenuProps): JSX.Element;
+    displayName: string;
+} & {
+    Divider: typeof Divider;
+    Item: {
+        (props: ItemProps): JSX.Element;
+        displayName: string;
+    };
+};
+export {};

package/lib-esm/ActionMenu.js

@@ -0,0 +1,82 @@
+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 { List } from './ActionList/List';
+import { Item } from './ActionList/Item';
+import { Divider } from './ActionList/Divider';
+import Button from './Button';
+import React, { useCallback, useMemo } from 'react';
+import { AnchoredOverlay } from './AnchoredOverlay';
+import { useProvidedStateOrCreate } from './hooks/useProvidedStateOrCreate';
+import { useProvidedRefOrCreate } from './hooks';
+
+const ActionMenuItem = props => /*#__PURE__*/React.createElement(Item, _extends({
+  role: "menuitem"
+}, props));
+
+ActionMenuItem.displayName = "ActionMenuItem";
+ActionMenuItem.displayName = 'ActionMenu.Item';
+
+const ActionMenuBase = ({
+  anchorContent,
+  renderAnchor = props => /*#__PURE__*/React.createElement(Button, props),
+  anchorRef: externalAnchorRef,
+  onAction,
+  open,
+  setOpen,
+  overlayProps,
+  items,
+  ...listProps
+}) => {
+  const [combinedOpenState, setCombinedOpenState] = useProvidedStateOrCreate(open, setOpen, false);
+  const anchorRef = useProvidedRefOrCreate(externalAnchorRef);
+  const onOpen = useCallback(() => setCombinedOpenState(true), [setCombinedOpenState]);
+  const onClose = useCallback(() => setCombinedOpenState(false), [setCombinedOpenState]);
+  const renderMenuAnchor = useMemo(() => {
+    if (renderAnchor === null) {
+      return null;
+    }
+
+    return props => {
+      return renderAnchor({
+        'aria-label': 'menu',
+        children: anchorContent,
+        ...props
+      });
+    };
+  }, [anchorContent, renderAnchor]);
+  const itemsToRender = useMemo(() => {
+    return items.map(item => {
+      return { ...item,
+        role: 'menuitem',
+        onAction: (props, event) => {
+          var _item$onAction;
+
+          const actionCallback = (_item$onAction = item.onAction) !== null && _item$onAction !== void 0 ? _item$onAction : onAction;
+          actionCallback === null || actionCallback === void 0 ? void 0 : actionCallback(props, event);
+
+          if (!event.defaultPrevented) {
+            onClose();
+          }
+        }
+      };
+    });
+  }, [items, onAction, onClose]);
+  return /*#__PURE__*/React.createElement(AnchoredOverlay, {
+    renderAnchor: renderMenuAnchor,
+    anchorRef: anchorRef,
+    open: combinedOpenState,
+    onOpen: onOpen,
+    onClose: onClose,
+    overlayProps: overlayProps
+  }, /*#__PURE__*/React.createElement(List, _extends({}, listProps, {
+    role: "menu",
+    items: itemsToRender
+  })));
+};
+
+ActionMenuBase.displayName = "ActionMenuBase";
+ActionMenuBase.displayName = 'ActionMenu';
+export const ActionMenu = Object.assign(ActionMenuBase, {
+  Divider,
+  Item: ActionMenuItem
+});

package/lib-esm/AnchoredOverlay/AnchoredOverlay.d.ts

@@ -0,0 +1,62 @@
+import React from 'react';
+import { OverlayProps } from '../Overlay';
+import { FocusTrapHookSettings } from '../hooks/useFocusTrap';
+import { FocusZoneHookSettings } from '../hooks/useFocusZone';
+import { PositionSettings } from '../behaviors/anchoredPosition';
+interface AnchoredOverlayPropsWithAnchor {
+    /**
+     * A custom function component used to render the anchor element.
+     * Will receive the selected text as `children` prop when an item is activated.
+     */
+    renderAnchor: <T extends React.HTMLAttributes<HTMLElement>>(props: T) => JSX.Element;
+    /**
+     * An override to the internal ref that will be spread on to the renderAnchor
+     */
+    anchorRef?: React.RefObject<HTMLElement>;
+}
+interface AnchoredOverlayPropsWithoutAnchor {
+    /**
+     * A custom function component used to render the anchor element.
+     * When renderAnchor is null, an anchorRef is required.
+     */
+    renderAnchor: null;
+    /**
+     * An override to the internal renderAnchor ref that will be used to position the overlay.
+     * When renderAnchor is null this can be used to make an anchor that is detached from ActionMenu.
+     */
+    anchorRef: React.RefObject<HTMLElement>;
+}
+export declare type AnchoredOverlayWrapperAnchorProps = Partial<AnchoredOverlayPropsWithAnchor> | AnchoredOverlayPropsWithoutAnchor;
+interface AnchoredOverlayBaseProps extends Pick<OverlayProps, 'height' | 'width'> {
+    /**
+     * Determines whether the overlay portion of the component should be shown or not
+     */
+    open: boolean;
+    /**
+     * A callback which is called whenever the overlay is currently closed and an "open gesture" is detected.
+     */
+    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: 'anchor-click' | 'click-outside' | 'escape') => unknown;
+    /**
+     * Props to be spread on the internal `Overlay` component.
+     */
+    overlayProps?: Partial<OverlayProps>;
+    /**
+     * Settings to apply to the Focus Zone on the internal `Overlay` component.
+     */
+    focusTrapSettings?: Partial<FocusTrapHookSettings>;
+    /**
+     * Settings to apply to the Focus Zone on the internal `Overlay` component.
+     */
+    focusZoneSettings?: Partial<FocusZoneHookSettings>;
+}
+export declare type AnchoredOverlayProps = AnchoredOverlayBaseProps & (AnchoredOverlayPropsWithAnchor | AnchoredOverlayPropsWithoutAnchor) & Partial<Pick<PositionSettings, 'align' | 'side'>>;
+/**
+ * An `AnchoredOverlay` provides an anchor that will open a floating overlay positioned relative to the anchor.
+ * The overlay can be opened and navigated using keyboard or mouse.
+ */
+export declare const AnchoredOverlay: React.FC<AnchoredOverlayProps>;
+export {};

package/lib-esm/AnchoredOverlay/AnchoredOverlay.js

@@ -0,0 +1,104 @@
+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, { useCallback, useEffect } from 'react';
+import Overlay from '../Overlay';
+import { useFocusTrap } from '../hooks/useFocusTrap';
+import { useFocusZone } from '../hooks/useFocusZone';
+import { useAnchoredPosition, useProvidedRefOrCreate, useRenderForcingRef } from '../hooks';
+import { useSSRSafeId } from '@react-aria/ssr';
+
+/**
+ * An `AnchoredOverlay` provides an anchor that will open a floating overlay positioned relative to the anchor.
+ * The overlay can be opened and navigated using keyboard or mouse.
+ */
+export const AnchoredOverlay = ({
+  renderAnchor,
+  anchorRef: externalAnchorRef,
+  children,
+  open,
+  onOpen,
+  onClose,
+  height,
+  width,
+  overlayProps,
+  focusTrapSettings,
+  focusZoneSettings,
+  side,
+  align
+}) => {
+  const anchorRef = useProvidedRefOrCreate(externalAnchorRef);
+  const [overlayRef, updateOverlayRef] = useRenderForcingRef();
+  const anchorId = useSSRSafeId();
+  const onClickOutside = useCallback(() => onClose === null || onClose === void 0 ? void 0 : onClose('click-outside'), [onClose]);
+  const onEscape = useCallback(() => onClose === null || onClose === void 0 ? void 0 : onClose('escape'), [onClose]);
+  const onAnchorKeyDown = useCallback(event => {
+    if (!event.defaultPrevented) {
+      if (!open && ['ArrowDown', 'ArrowUp', ' ', 'Enter'].includes(event.key)) {
+        onOpen === null || onOpen === void 0 ? void 0 : onOpen('anchor-key-press');
+        event.preventDefault();
+      }
+    }
+  }, [open, onOpen]);
+  const onAnchorClick = useCallback(event => {
+    if (event.defaultPrevented || event.button !== 0) {
+      return;
+    }
+
+    if (!open) {
+      onOpen === null || onOpen === void 0 ? void 0 : onOpen('anchor-click');
+    } else {
+      onClose === null || onClose === void 0 ? void 0 : onClose('anchor-click');
+    }
+  }, [open, onOpen, onClose]);
+  const {
+    position
+  } = useAnchoredPosition({
+    anchorElementRef: anchorRef,
+    floatingElementRef: overlayRef,
+    side,
+    align
+  }, [overlayRef.current]);
+  useEffect(() => {
+    // ensure overlay ref gets cleared when closed, so position can reset between closing/re-opening
+    if (!open && overlayRef.current) {
+      updateOverlayRef(null);
+    }
+  }, [open, overlayRef, updateOverlayRef]);
+  useFocusZone({
+    containerRef: overlayRef,
+    disabled: !open || !position,
+    ...focusZoneSettings
+  });
+  useFocusTrap({
+    containerRef: overlayRef,
+    disabled: !open || !position,
+    ...focusTrapSettings
+  });
+  return /*#__PURE__*/React.createElement(React.Fragment, null, renderAnchor && renderAnchor({
+    ref: anchorRef,
+    id: anchorId,
+    'aria-labelledby': anchorId,
+    'aria-haspopup': 'true',
+    tabIndex: 0,
+    onClick: onAnchorClick,
+    onKeyDown: onAnchorKeyDown
+  }), open ? /*#__PURE__*/React.createElement(Overlay, _extends({
+    returnFocusRef: anchorRef,
+    onClickOutside: onClickOutside,
+    ignoreClickRefs: [anchorRef],
+    onEscape: onEscape,
+    ref: updateOverlayRef,
+    role: "none",
+    visibility: position ? 'visible' : 'hidden',
+    height: height,
+    width: width,
+    top: (position === null || position === void 0 ? void 0 : position.top) || 0,
+    left: (position === null || position === void 0 ? void 0 : position.left) || 0,
+    anchorSide: position === null || position === void 0 ? void 0 : position.anchorSide
+  }, overlayProps), children) : null);
+};
+AnchoredOverlay.displayName = 'AnchoredOverlay';
+AnchoredOverlay.defaultProps = {
+  side: 'outside-bottom',
+  align: 'start'
+};

package/lib-esm/AnchoredOverlay/index.d.ts

@@ -0,0 +1,2 @@
+export { AnchoredOverlay } from './AnchoredOverlay';
+export type { AnchoredOverlayProps } from './AnchoredOverlay';

package/lib-esm/AnchoredOverlay/index.js

@@ -0,0 +1 @@
+export { AnchoredOverlay } from './AnchoredOverlay';