@primer/components 0.0.0-2021116153325 → 0.0.0-2021116153548

package/lib/hooks/useFocusZone.js

@@ -7,7 +7,7 @@ exports.useFocusZone = useFocusZone;
 
 var _react = _interopRequireWildcard(require("react"));
 
-var _behaviors = require("@primer/behaviors");
+var _focusZone = require("../behaviors/focusZone");
 
 var _useProvidedRefOrCreate = require("./useProvidedRefOrCreate");
 
@@ -32,7 +32,7 @@ function useFocusZone(settings = {}, dependencies = []) {
         const vanillaSettings = { ...settings,
           activeDescendantControl: (_activeDescendantCont = activeDescendantControlRef.current) !== null && _activeDescendantCont !== void 0 ? _activeDescendantCont : undefined
         };
-        abortController.current = (0, _behaviors.focusZone)(containerRef.current, vanillaSettings);
+        abortController.current = (0, _focusZone.focusZone)(containerRef.current, vanillaSettings);
         return () => {
           var _abortController$curr;
 

package/lib/hooks/useOpenAndCloseFocus.js

@@ -7,7 +7,7 @@ exports.useOpenAndCloseFocus = useOpenAndCloseFocus;
 
 var _react = require("react");
 
-var _utils = require("@primer/behaviors/utils");
+var _iterateFocusableElements = require("../utils/iterateFocusableElements");
 
 function useOpenAndCloseFocus({
   initialFocusRef,
@@ -25,7 +25,7 @@ function useOpenAndCloseFocus({
     if (initialFocusRef && initialFocusRef.current) {
       initialFocusRef.current.focus();
     } else if (containerRef.current) {
-      const firstItem = (0, _utils.iterateFocusableElements)(containerRef.current).next().value;
+      const firstItem = (0, _iterateFocusableElements.iterateFocusableElements)(containerRef.current).next().value;
       firstItem === null || firstItem === void 0 ? void 0 : firstItem.focus();
     }
 

package/lib/utils/iterateFocusableElements.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Options to the focusable elements iterator
+ */
+export interface IterateFocusableElements {
+    /**
+     * (Default: false) Iterate through focusable elements in reverse-order
+     */
+    reverse?: boolean;
+    /**
+     * (Default: false) Perform additional checks to determine tabbability
+     * which may adversely affect app performance.
+     */
+    strict?: boolean;
+    /**
+     * (Default: false) Only iterate tabbable elements, which is the subset
+     * of focusable elements that are part of the page's tab sequence.
+     */
+    onlyTabbable?: boolean;
+}
+/**
+ * Returns an iterator over all of the focusable elements within `container`.
+ * Note: If `container` is itself focusable it will be included in the results.
+ * @param container The container over which to find focusable elements.
+ * @param reverse If true, iterate backwards through focusable elements.
+ */
+export declare function iterateFocusableElements(container: HTMLElement, options?: IterateFocusableElements): Generator<HTMLElement, undefined, undefined>;
+/**
+ * Determines whether the given element is focusable. If `strict` is true, we may
+ * perform additional checks that require a reflow (less performant).
+ * @param elem
+ * @param strict
+ */
+export declare function isFocusable(elem: HTMLElement, strict?: boolean): boolean;
+/**
+ * Determines whether the given element is tabbable. If `strict` is true, we may
+ * perform additional checks that require a reflow (less performant). This check
+ * ensures that the element is focusable and that its tabindex is not explicitly
+ * set to "-1" (which makes it focusable, but removes it from the tab order).
+ * @param elem
+ * @param strict
+ */
+export declare function isTabbable(elem: HTMLElement, strict?: boolean): boolean;

package/lib/utils/iterateFocusableElements.js

@@ -0,0 +1,113 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.iterateFocusableElements = iterateFocusableElements;
+exports.isFocusable = isFocusable;
+exports.isTabbable = isTabbable;
+
+/**
+ * Options to the focusable elements iterator
+ */
+
+/**
+ * Returns an iterator over all of the focusable elements within `container`.
+ * Note: If `container` is itself focusable it will be included in the results.
+ * @param container The container over which to find focusable elements.
+ * @param reverse If true, iterate backwards through focusable elements.
+ */
+function* iterateFocusableElements(container, options = {}) {
+  var _options$strict, _options$onlyTabbable;
+
+  const strict = (_options$strict = options.strict) !== null && _options$strict !== void 0 ? _options$strict : false;
+  const acceptFn = ((_options$onlyTabbable = options.onlyTabbable) !== null && _options$onlyTabbable !== void 0 ? _options$onlyTabbable : false) ? isTabbable : isFocusable;
+  const walker = document.createTreeWalker(container, NodeFilter.SHOW_ELEMENT, {
+    acceptNode: node => node instanceof HTMLElement && acceptFn(node, strict) ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_SKIP
+  });
+  let nextNode = null; // Allow the container to participate
+
+  if (!options.reverse && acceptFn(container, strict)) {
+    yield container;
+  } // If iterating in reverse, continue traversing down into the last child until we reach
+  // a leaf DOM node
+
+
+  if (options.reverse) {
+    let lastChild = walker.lastChild();
+
+    while (lastChild) {
+      nextNode = lastChild;
+      lastChild = walker.lastChild();
+    }
+  } else {
+    nextNode = walker.firstChild();
+  }
+
+  while (nextNode instanceof HTMLElement) {
+    yield nextNode;
+    nextNode = options.reverse ? walker.previousNode() : walker.nextNode();
+  } // Allow the container to participate (in reverse)
+
+
+  if (options.reverse && acceptFn(container, strict)) {
+    yield container;
+  }
+
+  return undefined;
+}
+/**
+ * Determines whether the given element is focusable. If `strict` is true, we may
+ * perform additional checks that require a reflow (less performant).
+ * @param elem
+ * @param strict
+ */
+
+
+function isFocusable(elem, strict = false) {
+  // Certain conditions cause an element to never be focusable, even if they have tabindex="0"
+  const disabledAttrInert = ['BUTTON', 'INPUT', 'SELECT', 'TEXTAREA', 'OPTGROUP', 'OPTION', 'FIELDSET'].includes(elem.tagName) && elem.disabled;
+  const hiddenInert = elem.hidden;
+  const hiddenInputInert = elem instanceof HTMLInputElement && elem.type === 'hidden';
+
+  if (disabledAttrInert || hiddenInert || hiddenInputInert) {
+    return false;
+  } // Each of the conditions checked below require a reflow, thus are gated by the `strict`
+  // argument. If any are true, the element is not focusable, even if tabindex is set.
+
+
+  if (strict) {
+    const sizeInert = elem.offsetWidth === 0 || elem.offsetHeight === 0;
+    const visibilityInert = ['hidden', 'collapse'].includes(getComputedStyle(elem).visibility);
+    const clientRectsInert = elem.getClientRects().length === 0;
+
+    if (sizeInert || visibilityInert || clientRectsInert) {
+      return false;
+    }
+  } // Any element with `tabindex` explicitly set can be focusable, even if it's set to "-1"
+
+
+  if (elem.getAttribute('tabindex') != null) {
+    return true;
+  } // One last way `elem.tabIndex` can be wrong.
+
+
+  if (elem instanceof HTMLAnchorElement && elem.getAttribute('href') == null) {
+    return false;
+  }
+
+  return elem.tabIndex !== -1;
+}
+/**
+ * Determines whether the given element is tabbable. If `strict` is true, we may
+ * perform additional checks that require a reflow (less performant). This check
+ * ensures that the element is focusable and that its tabindex is not explicitly
+ * set to "-1" (which makes it focusable, but removes it from the tab order).
+ * @param elem
+ * @param strict
+ */
+
+
+function isTabbable(elem, strict = false) {
+  return isFocusable(elem, strict) && elem.getAttribute('tabindex') !== '-1';
+}

package/lib/utils/uniqueId.d.ts

@@ -0,0 +1 @@
+export declare function uniqueId(): string;

package/lib/utils/uniqueId.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.uniqueId = uniqueId;
+// Note: uniqueId may be unsafe in SSR contexts if it is used create DOM IDs or otherwise cause a hydration warning. Use useSSRSafeId instead.
+let idSeed = 10000;
+
+function uniqueId() {
+  return `__primer_id_${idSeed++}`;
+}

package/lib/utils/userAgent.d.ts

@@ -0,0 +1 @@
+export declare function isMacOS(): boolean;

package/lib/utils/userAgent.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isMacOS = isMacOS;
+let isMac = undefined;
+
+function isMacOS() {
+  if (isMac === undefined) {
+    isMac = /^mac/i.test(window.navigator.platform);
+  }
+
+  return isMac;
+}

package/lib-esm/ActionList/Item.js

@@ -9,7 +9,7 @@ import styled from 'styled-components';
 import { StyledHeader } from './Header';
 import { StyledDivider } from './Divider';
 import { useTheme } from '../ThemeProvider';
-import { activeDescendantActivatedDirectly, activeDescendantActivatedIndirectly, isActiveDescendantAttribute } from '@primer/behaviors';
+import { activeDescendantActivatedDirectly, activeDescendantActivatedIndirectly, isActiveDescendantAttribute } from '../behaviors/focusZone';
 import { useSSRSafeId } from '@react-aria/ssr';
 
 const getItemVariant = (variant = 'default', disabled) => {

package/lib-esm/ActionList/List.js

@@ -6,7 +6,7 @@ import { Item } from './Item';
 import { Divider } from './Divider';
 import styled from 'styled-components';
 import { get } from '../constants';
-import { hasActiveDescendantAttribute } from '@primer/behaviors';
+import { hasActiveDescendantAttribute } from '../behaviors/focusZone';
 
 /**
  * Asserts that the given value fulfills the `GroupedListProps` contract.

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

@@ -2,7 +2,7 @@ import React from 'react';
 import { OverlayProps } from '../Overlay';
 import { FocusTrapHookSettings } from '../hooks/useFocusTrap';
 import { FocusZoneHookSettings } from '../hooks/useFocusZone';
-import type { PositionSettings } from '@primer/behaviors';
+import { PositionSettings } from '../behaviors/anchoredPosition';
 interface AnchoredOverlayPropsWithAnchor {
     /**
      * A custom function component used to render the anchor element.

package/lib-esm/Autocomplete/AutocompleteMenu.js

@@ -4,16 +4,11 @@ import { useFocusZone } from '../hooks/useFocusZone';
 import { Box, Spinner } from '../';
 import { AutocompleteContext } from './AutocompleteContext';
 import { PlusIcon } from '@primer/octicons-react';
-import { uniqueId } from '@primer/behaviors/utils';
-import { scrollIntoView } from '@primer/behaviors';
+import { uniqueId } from '../utils/uniqueId';
+import { scrollIntoViewingArea } from '../behaviors/scrollIntoViewingArea';
 
 const getDefaultSortFn = isItemSelectedFn => (itemIdA, itemIdB) => isItemSelectedFn(itemIdA) === isItemSelectedFn(itemIdB) ? 0 : isItemSelectedFn(itemIdA) ? -1 : 1;
 
-const menuScrollMargins = {
-  startMargin: 0,
-  endMargin: 8
-};
-
 function getDefaultItemFilter(filterValue) {
   return function (item, _i) {
     var _item$text;
@@ -139,9 +134,9 @@ function AutocompleteMenu(props) {
       }
 
       if (current && customScrollContainerRef && customScrollContainerRef.current && directlyActivated) {
-        scrollIntoView(current, customScrollContainerRef.current, menuScrollMargins);
+        scrollIntoViewingArea(current, customScrollContainerRef.current);
       } else if (current && scrollContainerRef.current && directlyActivated) {
-        scrollIntoView(current, scrollContainerRef.current, menuScrollMargins);
+        scrollIntoViewingArea(current, scrollContainerRef.current);
       }
     }
   }, [loading]);

package/lib-esm/Dialog/ConfirmationDialog.js

@@ -5,7 +5,7 @@ import ReactDOM from 'react-dom';
 import styled from 'styled-components';
 import Box from '../Box';
 import { ThemeProvider, useTheme } from '../ThemeProvider';
-import { FocusKeys } from '@primer/behaviors';
+import { FocusKeys } from '../behaviors/focusZone';
 import { get } from '../constants';
 import { Dialog } from '../Dialog/Dialog';
 import { useFocusZone } from '../hooks/useFocusZone';

package/lib-esm/Dialog/Dialog.js

@@ -11,7 +11,7 @@ import sx from '../sx';
 import StyledOcticon from '../StyledOcticon';
 import { XIcon } from '@primer/octicons-react';
 import { useFocusZone } from '../hooks/useFocusZone';
-import { FocusKeys } from '@primer/behaviors';
+import { FocusKeys } from '../behaviors/focusZone';
 import Portal from '../Portal';
 import { useCombinedRefs } from '../hooks/useCombinedRefs';
 import { useSSRSafeId } from '@react-aria/ssr';

package/lib-esm/FilteredActionList/FilteredActionList.js

@@ -12,11 +12,7 @@ import styled from 'styled-components';
 import { get } from '../constants';
 import { useProvidedRefOrCreate } from '../hooks/useProvidedRefOrCreate';
 import useScrollFlash from '../hooks/useScrollFlash';
-import { scrollIntoView } from '@primer/behaviors';
-const menuScrollMargins = {
-  startMargin: 0,
-  endMargin: 8
-};
+import { scrollIntoViewingArea } from '../behaviors/scrollIntoViewingArea';
 const StyledHeader = styled.div.withConfig({
   displayName: "FilteredActionList__StyledHeader",
   componentId: "sc-yg3jkv-0"
@@ -63,7 +59,7 @@ export function FilteredActionList({
       activeDescendantRef.current = current;
 
       if (current && scrollContainerRef.current && directlyActivated) {
-        scrollIntoView(current, scrollContainerRef.current, menuScrollMargins);
+        scrollIntoViewingArea(current, scrollContainerRef.current);
       }
     }
   }, [// List ref isn't set while loading.  Need to re-bind focus zone when it changes
@@ -71,9 +67,7 @@ export function FilteredActionList({
   useEffect(() => {
     // if items changed, we want to instantly move active descendant into view
     if (activeDescendantRef.current && scrollContainerRef.current) {
-      scrollIntoView(activeDescendantRef.current, scrollContainerRef.current, { ...menuScrollMargins,
-        behavior: 'auto'
-      });
+      scrollIntoViewingArea(activeDescendantRef.current, scrollContainerRef.current, 'vertical', undefined, undefined, 'auto');
     }
   }, [items]);
   useScrollFlash(scrollContainerRef);

package/lib-esm/Overlay.d.ts

@@ -2,7 +2,7 @@ import React, { ComponentPropsWithRef } from 'react';
 import { AriaRole, Merge } from './utils/types';
 import { TouchOrMouseEvent } from './hooks';
 import { SxProp } from './sx';
-import type { AnchorSide } from '@primer/behaviors';
+import { AnchorSide } from './behaviors/anchoredPosition';
 import { ForwardRefComponent as PolymorphicForwardRefComponent } from '@radix-ui/react-polymorphic';
 declare type StyledOverlayProps = {
     width?: keyof typeof widthMap;

package/lib-esm/TextInputWithTokens.js

@@ -2,7 +2,7 @@ function _extends() { _extends = Object.assign || function (target) { for (var i
 
 import React, { useRef, useState } from 'react';
 import { omit } from '@styled-system/props';
-import { FocusKeys } from '@primer/behaviors';
+import { FocusKeys } from './behaviors/focusZone';
 import { useCombinedRefs } from './hooks/useCombinedRefs';
 import { useFocusZone } from './hooks/useFocusZone';
 import Token from './Token/Token';
@@ -11,7 +11,7 @@ import UnstyledTextInput from './_UnstyledTextInput';
 import TextInputWrapper from './_TextInputWrapper';
 import Box from './Box';
 import Text from './Text';
-import { isFocusable } from '@primer/behaviors/utils'; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+import { isFocusable } from './utils/iterateFocusableElements'; // eslint-disable-next-line @typescript-eslint/no-explicit-any
 
 const overflowCountFontSizeMap = {
   small: 0,

package/lib-esm/behaviors/anchoredPosition.d.ts

@@ -0,0 +1,89 @@
+export declare type AnchorAlignment = 'start' | 'center' | 'end';
+export declare type AnchorSide = 'inside-top' | 'inside-bottom' | 'inside-left' | 'inside-right' | 'inside-center' | 'outside-top' | 'outside-bottom' | 'outside-left' | 'outside-right';
+/**
+ * Settings that customize how a floating element is positioned
+ * with respect to an anchor element.
+ */
+export interface PositionSettings {
+    /**
+     * Sets the side of the anchor element that the floating element should be
+     * pinned to. This side is given by a string starting with either "inside" or
+     * "outside", followed by a hyphen, followed by either "top", "right", "bottom",
+     * or "left". Additionally, "inside-center" is an allowed value.
+     *
+     * The first part of this string, "inside" or "outside", determines whether the
+     * floating element should be attempted to be placed "inside" the anchor element
+     * or "outside" of it. Using "inside" is useful for making it appear that the
+     * anchor _contains_ the floating element, and it can be used for implementing a
+     * dialog that is centered on the screen. The "outside" value is more common and
+     * can be used for tooltips, popovers, menus, etc.
+     *
+     * The second part of this string determines the _edge_ on the anchor element that
+     * the floating element will be anchored to. If side is "inside-center", then
+     * the floating element will be centered in the X-direction (while align is used
+     * to position it in the Y-direction).
+     * Note: "outside-center" is _not_ a valid value for this property.
+     */
+    side: AnchorSide;
+    /**
+     * Determines how the floating element should align with the anchor element. If
+     * set to "start", the floating element's first edge (top or left) will align
+     * with the anchor element's first edge. If set to "center", the floating
+     * element will be centered along the axis of the anchor edge. If set to "end",
+     * the floating element's last edge will align with the anchor element's last edge.
+     */
+    align: AnchorAlignment;
+    /**
+     * The number of pixels between the anchor edge and the floating element.
+     *
+     * Positive values move the floating element farther from the anchor element
+     * (for outside positioning) or further inside the anchor element (for inside
+     * positioning). Negative values have the opposite effect.
+     */
+    anchorOffset: number;
+    /**
+     * An additional offset, in pixels, to move the floating element from
+     * the aligning edge.
+     *
+     * Positive values move the floating element in the direction of center-
+     * alignment. Negative values move the floating element away from center-
+     * alignment. When align is "center", positive offsets move the floating
+     * element right (top or bottom anchor side) or down (left or right
+     * anchor side).
+     */
+    alignmentOffset: number;
+    /**
+     * If false, when the above settings result in rendering the floating element
+     * wholly or partially outside of the bounds of the containing element, attempt
+     * to adjust the settings to prevent this. Only applies to "outside" positioning.
+     *
+     * First, attempt to flip to the opposite edge of the anchor if the floating
+     * element is getting clipped in that direction. If flipping results in a
+     * similar clipping, try moving to the adjacent sides.
+     *
+     * Once we find a side that does not clip the overlay in its own dimension,
+     * check the rest of the sides to see if we need to adjust the alignment offset
+     * to fit in other dimensions.
+     *
+     * If we try all four sides and get clipped each time, settle for overflowing
+     * and use the "bottom" side, since the ability to scroll is most likely in
+     * this direction.
+     */
+    allowOutOfBounds: boolean;
+}
+export interface AnchorPosition {
+    top: number;
+    left: number;
+    anchorSide: AnchorSide;
+}
+/**
+ * Given a floating element and an anchor element, return coordinates for the top-left
+ * of the floating element in order to absolutely position it such that it appears
+ * near the anchor element.
+ *
+ * @param floatingElement Element intended to be positioned near or within an anchor
+ * @param anchorElement The element to serve as the position anchor
+ * @param settings Settings to determine the rules for positioning the floating element
+ * @returns {top: number, left: number} coordinates for the floating element
+ */
+export declare function getAnchoredPosition(floatingElement: Element, anchorElement: Element | DOMRect, settings?: Partial<PositionSettings>): AnchorPosition;