@primer/components 0.0.0-2021983515 → 0.0.0-2022530194733

package/lib/hooks/useOverlay.d.ts

@@ -1,15 +0,0 @@
-/// <reference types="react" />
-import { TouchOrMouseEvent } from './useOnOutsideClick';
-export declare type UseOverlaySettings = {
-    ignoreClickRefs?: React.RefObject<HTMLElement>[];
-    initialFocusRef?: React.RefObject<HTMLElement>;
-    returnFocusRef: React.RefObject<HTMLElement>;
-    onEscape: (e: KeyboardEvent) => void;
-    onClickOutside: (e: TouchOrMouseEvent) => void;
-    overlayRef?: React.RefObject<HTMLDivElement>;
-    preventFocusOnOpen?: boolean;
-};
-export declare type OverlayReturnProps = {
-    ref: React.RefObject<HTMLDivElement>;
-};
-export declare const useOverlay: ({ overlayRef: _overlayRef, returnFocusRef, initialFocusRef, onEscape, ignoreClickRefs, onClickOutside, preventFocusOnOpen }: UseOverlaySettings) => OverlayReturnProps;

package/lib/hooks/useProvidedRefOrCreate.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-/**
- * There are some situations where we only want to create a new ref if one is not provided to a component
- * or hook as a prop. However, due to the `rules-of-hooks`, we cannot conditionally make a call to `React.useRef`
- * only in the situations where the ref is not provided as a prop.
- * This hook aims to encapsulate that logic, so the consumer doesn't need to be concerned with violating `rules-of-hooks`.
- * @param providedRef The ref to use - if undefined, will use the ref from a call to React.useRef
- * @type TRef The type of the RefObject which should be created.
- */
-export declare function useProvidedRefOrCreate<TRef>(providedRef?: React.RefObject<TRef>): React.RefObject<TRef>;

package/lib/hooks/useProvidedStateOrCreate.d.ts

@@ -1,10 +0,0 @@
-/**
- * There are some situations where we want to give users the option to control state externally with their own state handlers
- * or default to using internal state handlers. Because of the 'rules-of-hooks', we cannot conditionally make a call to `React.useState`
- * only in the situations where the state is not provided as a prop.
- * This hook aims to encapsulate that logic, so the consumer doesn't need to be concerned with violating `rules-of-hooks`.
- * @param externalState The state to use - if undefined, will use the state from a call to React.useState
- * @param setExternalState The setState to use - if undefined, will use the setState from a call to React.useState
- * @param defaultState The defaultState to use, if using internal state.
- */
-export declare function useProvidedStateOrCreate<T>(externalState: T | undefined, setExternalState: ((s: T) => void) | undefined, defaultState: T): readonly [T, (s: T) => void];

package/lib/hooks/useProvidedStateOrCreate.js

@@ -1,27 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useProvidedStateOrCreate = useProvidedStateOrCreate;
-
-var _react = require("react");
-
-/**
- * There are some situations where we want to give users the option to control state externally with their own state handlers
- * or default to using internal state handlers. Because of the 'rules-of-hooks', we cannot conditionally make a call to `React.useState`
- * only in the situations where the state is not provided as a prop.
- * This hook aims to encapsulate that logic, so the consumer doesn't need to be concerned with violating `rules-of-hooks`.
- * @param externalState The state to use - if undefined, will use the state from a call to React.useState
- * @param setExternalState The setState to use - if undefined, will use the setState from a call to React.useState
- * @param defaultState The defaultState to use, if using internal state.
- */
-function useProvidedStateOrCreate(externalState, setExternalState, defaultState) {
-  const [internalState, setInternalState] = (0, _react.useState)(defaultState);
-  const state = externalState !== null && externalState !== void 0 ? externalState : internalState;
-  const setState = (0, _react.useCallback)(s => {
-    setInternalState(s);
-    if (setExternalState) setExternalState(s);
-  }, [setExternalState]);
-  return [state, setState];
-}

package/lib/hooks/useRenderForcingRef.d.ts

@@ -1,8 +0,0 @@
-import { RefObject } from 'react';
-/**
- * There are certain situations where a ref might be set after the current render cycle for a
- * component has finished.  e.g. a forward ref from a conditionally rendered child component.
- * In these situations, we need to force a re-render, which is done here by the useState hook.
- * @type TRef The type of the RefObject which should be created.
- */
-export declare function useRenderForcingRef<TRef>(): readonly [RefObject<TRef>, (newRef: TRef | null) => void];

package/lib/hooks/useRenderForcingRef.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useRenderForcingRef = useRenderForcingRef;
-
-var _react = require("react");
-
-/**
- * There are certain situations where a ref might be set after the current render cycle for a
- * component has finished.  e.g. a forward ref from a conditionally rendered child component.
- * In these situations, we need to force a re-render, which is done here by the useState hook.
- * @type TRef The type of the RefObject which should be created.
- */
-function useRenderForcingRef() {
-  const [refCurrent, setRefCurrent] = (0, _react.useState)(null);
-  const ref = (0, _react.useRef)(null);
-  ref.current = refCurrent;
-  const setRef = (0, _react.useCallback)(newRef => {
-    ref.current = newRef;
-    setRefCurrent(newRef);
-  }, [ref]);
-  return [ref, setRef];
-}

package/lib/hooks/useResizeObserver.d.ts

@@ -1 +0,0 @@
-export declare function useResizeObserver(callback: () => void): void;

package/lib/hooks/useResizeObserver.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useResizeObserver = useResizeObserver;
-
-var _react = _interopRequireDefault(require("react"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function useResizeObserver(callback) {
-  _react.default.useLayoutEffect(() => {
-    const observer = new window.ResizeObserver(() => callback());
-    observer.observe(document.documentElement);
-    return () => {
-      observer.disconnect();
-    };
-  }, [callback]);
-}

package/lib/hooks/useSafeTimeout.d.ts

@@ -1,12 +0,0 @@
-declare type SetTimeout = (handler: TimerHandler, timeout?: number, ...args: unknown[]) => number;
-declare type ClearTimeout = (id: number) => void;
-/**
- * Safely call `setTimeout` and `clearTimeout` within a component.
- *
- * This hook ensures that all timeouts are cleared when the component unmounts.
- */
-export default function useSafeTimeout(): {
-    safeSetTimeout: SetTimeout;
-    safeClearTimeout: ClearTimeout;
-};
-export {};

package/lib/hooks/useScrollFlash.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-/**
- * This hook will flash the scrollbars for a ref of a container that has scrollable overflow
- * @param scrollContainerRef The ref of the scrollable content
- */
-export default function useScrollFlash(scrollContainerRef: React.RefObject<HTMLElement>): void;

package/lib/hooks/useScrollFlash.js

@@ -1,29 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = useScrollFlash;
-
-var _react = require("react");
-
-/**
- * This hook will flash the scrollbars for a ref of a container that has scrollable overflow
- * @param scrollContainerRef The ref of the scrollable content
- */
-function useScrollFlash(scrollContainerRef) {
-  // https://adxlv.computer/projects/flash-scrollers/
-  (0, _react.useEffect)(() => {
-    const scrollContainer = scrollContainerRef.current;
-
-    if (!scrollContainer) {
-      return;
-    }
-
-    const currentScroll = scrollContainer.scrollTop;
-    const maxScroll = scrollContainer.scrollHeight;
-    const altScroll = currentScroll < Math.min(1, maxScroll) ? currentScroll + 1 : currentScroll - 1;
-    scrollContainer.scrollTop = altScroll;
-    scrollContainer.scrollTop = currentScroll;
-  }, [scrollContainerRef]);
-}

package/lib/index.d.ts

@@ -1,114 +0,0 @@
-export { default as theme } from './theme';
-export { get as themeGet } from './constants';
-export { default as BaseStyles } from './BaseStyles';
-export type { BaseStylesProps } from './BaseStyles';
-export { default as ThemeProvider, useTheme, useColorSchemeVar } from './ThemeProvider';
-export type { ThemeProviderProps } from './ThemeProvider';
-export { default as BorderBox } from './BorderBox';
-export type { BorderBoxProps } from './BorderBox';
-export { default as Box } from './Box';
-export type { BoxProps } from './Box';
-export { default as Flex } from './Flex';
-export type { FlexProps } from './Flex';
-export { default as Grid } from './Grid';
-export type { GridProps } from './Grid';
-export { default as Position, Absolute, Fixed, Relative, Sticky } from './Position';
-export type { PositionProps, AbsoluteProps, FixedProps, RelativeProps, StickyProps } from './Position';
-export { default as useDetails } from './hooks/useDetails';
-export { default as useSafeTimeout } from './hooks/useSafeTimeout';
-export { useOnOutsideClick } from './hooks/useOnOutsideClick';
-export { useOpenAndCloseFocus } from './hooks/useOpenAndCloseFocus';
-export { useOnEscapePress } from './hooks/useOnEscapePress';
-export { useOverlay } from './hooks/useOverlay';
-export { useConfirm } from './Dialog/ConfirmationDialog';
-export { ActionList } from './ActionList';
-export { ActionMenu } from './ActionMenu';
-export type { ActionMenuProps } from './ActionMenu';
-export { default as Autocomplete } from './Autocomplete';
-export { default as Avatar } from './Avatar';
-export type { AvatarProps } from './Avatar';
-export { default as AvatarPair } from './AvatarPair';
-export type { AvatarPairProps } from './AvatarPair';
-export { default as AvatarStack } from './AvatarStack';
-export type { AvatarStackProps } from './AvatarStack';
-export { default as BranchName } from './BranchName';
-export type { BranchNameProps } from './BranchName';
-export { default as Breadcrumbs, Breadcrumb } from './Breadcrumbs';
-export type { BreadcrumbsProps, BreadcrumbsItemProps, BreadcrumbProps, BreadcrumbItemProps } from './Breadcrumbs';
-export { default as Button, ButtonDanger, ButtonOutline, ButtonPrimary, ButtonInvisible, ButtonTableList, ButtonClose, ButtonGroup } from './Button';
-export type { ButtonProps, ButtonDangerProps, ButtonOutlineProps, ButtonPrimaryProps, ButtonInvisibleProps, ButtonTableListProps, ButtonCloseProps, ButtonGroupProps } from './Button';
-export { default as Caret } from './Caret';
-export type { CaretProps } from './Caret';
-export { default as CircleBadge } from './CircleBadge';
-export type { CircleBadgeProps, CircleBadgeIconProps } from './CircleBadge';
-export { default as CircleOcticon } from './CircleOcticon';
-export type { CircleOcticonProps } from './CircleOcticon';
-export { default as CounterLabel } from './CounterLabel';
-export type { CounterLabelProps } from './CounterLabel';
-export { default as Details } from './Details';
-export type { DetailsProps } from './Details';
-export { default as Dialog } from './Dialog';
-export type { DialogProps, DialogHeaderProps } from './Dialog';
-export { ConfirmationDialog } from './Dialog/ConfirmationDialog';
-export { default as Dropdown } from './Dropdown';
-export type { DropdownProps, DropdownCaretProps, DropdownButtonProps, DropdownItemProps, DropdownMenuProps } from './Dropdown';
-export { DropdownButton, DropdownMenu } from './DropdownMenu';
-export { default as FilteredSearch } from './FilteredSearch';
-export type { FilteredSearchProps } from './FilteredSearch';
-export { default as FilterList } from './FilterList';
-export type { FilterListProps, FilterListItemProps } from './FilterList';
-export { default as Flash } from './Flash';
-export type { FlashProps } from './Flash';
-export { default as FormGroup } from './FormGroup';
-export type { FormGroupProps, FormGroupLabelProps } from './FormGroup';
-export { default as Header } from './Header';
-export type { HeaderProps, HeaderItemProps, HeaderLinkProps } from './Header';
-export { default as Heading } from './Heading';
-export type { HeadingProps } from './Heading';
-export { default as LabelGroup } from './LabelGroup';
-export type { LabelGroupProps } from './LabelGroup';
-export { default as Label } from './Label';
-export type { LabelProps } from './Label';
-export { default as Link } from './Link';
-export type { LinkProps } from './Link';
-export { default as Overlay } from './Overlay';
-export type { OverlayProps } from './Overlay';
-export { default as Pagehead } from './Pagehead';
-export type { PageheadProps } from './Pagehead';
-export { default as Pagination } from './Pagination';
-export type { PaginationProps } from './Pagination';
-export { default as PointerBox } from './PointerBox';
-export type { PointerBoxProps } from './PointerBox';
-export { default as Popover } from './Popover';
-export type { PopoverProps, PopoverContentProps } from './Popover';
-export { default as ProgressBar } from './ProgressBar';
-export type { ProgressBarProps } from './ProgressBar';
-export { default as SelectMenu } from './SelectMenu';
-export type { SelectMenuProps, SelectMenuDividerProps, SelectMenuFilterProps, SelectMenuFooterProps, SelectMenuItemProps, SelectMenuListProps, SelectMenuModalProps, SelectMenuTabsProps, SelectMenuHeaderProps, SelectMenuTabProps, SelectMenuTabPanelProps, SelectMenuLoadingAnimationProps } from './SelectMenu';
-export { default as SideNav } from './SideNav';
-export type { SideNavProps, SideNavLinkProps } from './SideNav';
-export { default as Spinner } from './Spinner';
-export type { SpinnerProps } from './Spinner';
-export { default as StateLabel } from './StateLabel';
-export type { StateLabelProps } from './StateLabel';
-export { default as StyledOcticon } from './StyledOcticon';
-export type { StyledOcticonProps } from './StyledOcticon';
-export { default as SubNav } from './SubNav';
-export type { SubNavProps, SubNavLinkProps, SubNavLinksProps } from './SubNav';
-export { default as TabNav } from './TabNav';
-export type { TabNavProps, TabNavLinkProps } from './TabNav';
-export { default as TextInput } from './TextInput';
-export type { TextInputProps } from './TextInput';
-export { default as TextInputWithTokens } from './TextInputWithTokens';
-export { default as Text } from './Text';
-export type { TextProps } from './Text';
-export { default as Timeline } from './Timeline';
-export type { TimelineProps, TimelineBadgeProps, TimelineBodyProps, TimelineBreakProps, TimelineItemsProps } from './Timeline';
-export { default as Token, IssueLabelToken, ProfileToken } from './Token';
-export { default as Tooltip } from './Tooltip';
-export type { TooltipProps } from './Tooltip';
-export { default as Truncate } from './Truncate';
-export type { TruncateProps } from './Truncate';
-export { default as UnderlineNav } from './UnderlineNav';
-export type { UnderlineNavProps, UnderlineNavLinkProps } from './UnderlineNav';
-export { SSRProvider, useSSRSafeId } from './utils/ssr';

package/lib/polyfills/eventListenerSignal.d.ts

@@ -1,6 +0,0 @@
-export declare function polyfill(): void;
-declare global {
-    interface AddEventListenerOptions {
-        signal?: AbortSignal;
-    }
-}

package/lib/sx.d.ts

@@ -1,6 +0,0 @@
-import { SystemStyleObject } from '@styled-system/css';
-export interface SxProp {
-    sx?: SystemStyleObject;
-}
-declare const sx: (props: SxProp) => import("@styled-system/css").CssFunctionReturnType;
-export default sx;

package/lib/theme-preval.d.ts

@@ -1,49 +0,0 @@
-export namespace theme {
-    export { animation };
-    export { borderWidths };
-    export { breakpoints };
-    export { fonts };
-    export { fontSizes };
-    export { fontWeights };
-    export { lineHeights };
-    export { radii };
-    export { sizes };
-    export { space };
-    export { colorSchemes };
-}
-declare namespace animation {
-    const easeOutCubic: string;
-}
-declare const borderWidths: (string | number)[];
-declare const breakpoints: string[];
-declare namespace fonts {
-    const normal: any;
-    const mono: any;
-}
-declare const fontSizes: string[];
-declare namespace fontWeights {
-    export const light: number;
-    const normal_1: number;
-    export { normal_1 as normal };
-    export const semibold: number;
-    export const bold: number;
-}
-declare const lineHeights: {
-    condensedUltra: number;
-    condensed: number;
-    default: number;
-};
-declare const radii: string[];
-declare namespace sizes {
-    const small: string;
-    const medium: string;
-    const large: string;
-    const xlarge: string;
-}
-declare const space: string[];
-/**
- * @type Record<keyof typeof primitives.colors, Record<'colors' | 'shadows', Partial<typeof primitives.colors.light>>
- */
-declare const colorSchemes: Record<keyof typeof primitives.colors, Record<'colors' | 'shadows', Partial<typeof primitives.colors.light>>>;
-import { default as primitives } from "@primer/primitives";
-export {};

package/lib/theme.d.ts

@@ -1,2 +0,0 @@
-import { theme } from './theme-preval';
-export default theme;

package/lib/utils/deprecate.d.ts

@@ -1,18 +0,0 @@
-declare type DeprecationType = {
-    name: string;
-    message: string;
-    version: string;
-};
-declare let deprecate: ({ name, message, version }: DeprecationType) => void | (() => void);
-export { deprecate };
-declare let useDeprecation: any;
-export { useDeprecation };
-export declare class Deprecations {
-    static instance: Deprecations | null;
-    deprecations: Array<DeprecationType>;
-    static get(): Deprecations;
-    constructor();
-    static deprecate({ name, message, version }: DeprecationType): void;
-    static getDeprecations(): DeprecationType[];
-    static clearDeprecations(): void;
-}

package/lib/utils/isNumeric.d.ts

@@ -1 +0,0 @@
-export default function isNumeric(n: any): boolean;

package/lib/utils/iterateFocusableElements.d.ts

@@ -1,42 +0,0 @@
-/**
- * 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/scrollIntoViewingArea.d.ts

@@ -1 +0,0 @@
-export declare const scrollIntoViewingArea: (child: HTMLElement, container: HTMLElement, direction?: 'horizontal' | 'vertical', startMargin?: number, endMargin?: number, behavior?: ScrollBehavior) => void;

package/lib/utils/scrollIntoViewingArea.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.scrollIntoViewingArea = void 0;
-
-const scrollIntoViewingArea = (child, container, direction = 'vertical', startMargin = 8, endMargin = 0, behavior = 'smooth') => {
-  const startSide = direction === 'vertical' ? 'top' : 'left';
-  const endSide = direction === 'vertical' ? 'bottom' : 'right';
-  const scrollSide = direction === 'vertical' ? 'scrollTop' : 'scrollLeft';
-  const {
-    [startSide]: childStart,
-    [endSide]: childEnd
-  } = child.getBoundingClientRect();
-  const {
-    [startSide]: containerStart,
-    [endSide]: containerEnd
-  } = container.getBoundingClientRect();
-  const isChildStartAboveViewingArea = childStart < containerStart + endMargin;
-  const isChildBottomBelowViewingArea = childEnd > containerEnd - startMargin;
-
-  if (isChildStartAboveViewingArea) {
-    const scrollHeightToChildStart = childStart - containerStart + container[scrollSide];
-    container.scrollTo({
-      behavior,
-      [startSide]: scrollHeightToChildStart - endMargin
-    });
-  } else if (isChildBottomBelowViewingArea) {
-    const scrollHeightToChildBottom = childEnd - containerEnd + container[scrollSide];
-    container.scrollTo({
-      behavior,
-      [startSide]: scrollHeightToChildBottom + startMargin
-    });
-  } // either completely in view or outside viewing area on both ends, don't scroll
-
-};
-
-exports.scrollIntoViewingArea = scrollIntoViewingArea;

package/lib/utils/ssr.d.ts

@@ -1 +0,0 @@
-export { SSRProvider, useSSRSafeId } from '@react-aria/ssr';

package/lib/utils/ssr.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "SSRProvider", {
-  enumerable: true,
-  get: function () {
-    return _ssr.SSRProvider;
-  }
-});
-Object.defineProperty(exports, "useSSRSafeId", {
-  enumerable: true,
-  get: function () {
-    return _ssr.useSSRSafeId;
-  }
-});
-
-var _ssr = require("@react-aria/ssr");

package/lib/utils/test-deprecations.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/utils/test-helpers.js

@@ -1,9 +0,0 @@
-"use strict";
-
-// JSDOM doesn't mock ResizeObserver
-global.ResizeObserver = jest.fn().mockImplementation(() => {
-  return {
-    observe: jest.fn(),
-    disconnect: jest.fn()
-  };
-});

package/lib/utils/test-matchers.d.ts

@@ -1 +0,0 @@
-import 'jest-styled-components';