@primer/components 0.0.0-2021111171525 → 0.0.0-20211111716

package/lib-esm/hooks/useProvidedRefOrCreate.js

@@ -0,0 +1,14 @@
+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 function useProvidedRefOrCreate(providedRef) {
+  const createdRef = React.useRef(null);
+  return providedRef !== null && providedRef !== void 0 ? providedRef : createdRef;
+}

package/lib-esm/hooks/useProvidedStateOrCreate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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-esm/hooks/useProvidedStateOrCreate.js

@@ -0,0 +1,20 @@
+import { useCallback, useState } from '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.
+ */
+
+export function useProvidedStateOrCreate(externalState, setExternalState, defaultState) {
+  const [internalState, setInternalState] = useState(defaultState);
+  const state = externalState !== null && externalState !== void 0 ? externalState : internalState;
+  const setState = useCallback(s => {
+    setInternalState(s);
+    if (setExternalState) setExternalState(s);
+  }, [setExternalState]);
+  return [state, setState];
+}

package/lib-esm/hooks/useRenderForcingRef.d.ts

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

@@ -0,0 +1,18 @@
+import { useCallback, useRef, useState } 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 function useRenderForcingRef() {
+  const [refCurrent, setRefCurrent] = useState(null);
+  const ref = useRef(null);
+  ref.current = refCurrent;
+  const setRef = useCallback(newRef => {
+    ref.current = newRef;
+    setRefCurrent(newRef);
+  }, [ref]);
+  return [ref, setRef];
+}

package/lib-esm/hooks/useResizeObserver.d.ts

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

package/lib-esm/hooks/useResizeObserver.js

@@ -0,0 +1,10 @@
+import useLayoutEffect from '../utils/useIsomorphicLayoutEffect';
+export function useResizeObserver(callback) {
+  useLayoutEffect(() => {
+    const observer = new window.ResizeObserver(() => callback());
+    observer.observe(document.documentElement);
+    return () => {
+      observer.disconnect();
+    };
+  }, [callback]);
+}

package/lib-esm/hooks/useSafeTimeout.d.ts

@@ -0,0 +1,12 @@
+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-esm/hooks/useSafeTimeout.js

@@ -0,0 +1,31 @@
+import { useCallback, useEffect, useRef } from 'react';
+
+/**
+ * Safely call `setTimeout` and `clearTimeout` within a component.
+ *
+ * This hook ensures that all timeouts are cleared when the component unmounts.
+ */
+export default function useSafeTimeout() {
+  const timers = useRef(new Set());
+  const safeSetTimeout = useCallback((handler, timeout, ...args) => {
+    const id = window.setTimeout(handler, timeout, ...args);
+    timers.current.add(id);
+    return id;
+  }, []);
+  const safeClearTimeout = useCallback(id => {
+    clearTimeout(id);
+    timers.current.delete(id);
+  }, []);
+  useEffect(() => {
+    return () => {
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+      for (const id of timers.current) {
+        clearTimeout(id);
+      }
+    };
+  }, []);
+  return {
+    safeSetTimeout,
+    safeClearTimeout
+  };
+}

package/lib-esm/hooks/useScrollFlash.d.ts

@@ -0,0 +1,6 @@
+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-esm/hooks/useScrollFlash.js

@@ -0,0 +1,22 @@
+import { useEffect } 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) {
+  // https://adxlv.computer/projects/flash-scrollers/
+  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-esm/index.d.ts

@@ -0,0 +1,120 @@
+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 type { AutocompleteMenuProps, AutocompleteInputProps, AutocompleteOverlayProps } 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 { NewButton } from './NewButton';
+export type { NewButtonProps } from './NewButton';
+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 type { TextInputWithTokensProps } 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, AvatarToken } 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 { default as Checkbox } from './Checkbox';
+export type { CheckboxProps } from './Checkbox';
+export { SSRProvider, useSSRSafeId } from './utils/ssr';

package/lib-esm/index.js

@@ -1,29 +1,43 @@
 export { default as theme } from './theme';
 export { get as themeGet } from './constants';
-export { default as BaseStyles } from './BaseStyles'; // Layout
-
+export { default as BaseStyles } from './BaseStyles';
+export { default as ThemeProvider, useTheme, useColorSchemeVar } from './ThemeProvider';
+// Layout
 export { default as BorderBox } from './BorderBox';
 export { default as Box } from './Box';
 export { default as Flex } from './Flex';
 export { default as Grid } from './Grid';
-export { default as Position, Absolute, Fixed, Relative, Sticky } from './Position'; // Hooks
-
+export { default as Position, Absolute, Fixed, Relative, Sticky } from './Position';
+// Hooks
 export { default as useDetails } from './hooks/useDetails';
-export { default as useMouseIntent } from './hooks/useMouseIntent'; // Components
+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'; // Components
 
+export { ActionList } from './ActionList';
+export { ActionMenu } from './ActionMenu';
+export { default as Autocomplete } from './Autocomplete';
 export { default as Avatar } from './Avatar';
 export { default as AvatarPair } from './AvatarPair';
 export { default as AvatarStack } from './AvatarStack';
 export { default as BranchName } from './BranchName';
-export { default as Breadcrumb } from './Breadcrumb';
+export { default as Breadcrumbs, Breadcrumb } from './Breadcrumbs';
 export { default as Button, ButtonDanger, ButtonOutline, ButtonPrimary, ButtonInvisible, ButtonTableList, ButtonClose, ButtonGroup } from './Button';
+export { NewButton } from './NewButton';
 export { default as Caret } from './Caret';
 export { default as CircleBadge } from './CircleBadge';
 export { default as CircleOcticon } from './CircleOcticon';
 export { default as CounterLabel } from './CounterLabel';
 export { default as Details } from './Details';
 export { default as Dialog } from './Dialog';
+export { ConfirmationDialog } from './Dialog/ConfirmationDialog';
 export { default as Dropdown } from './Dropdown';
+export { DropdownButton, DropdownMenu } from './DropdownMenu'; // not exporting new DropdownMenu types yet due to conflict with Dropdown types above
+// export type {DropdownButtonProps, DropdownMenuProps} from './DropdownMenu'
+
 export { default as FilteredSearch } from './FilteredSearch';
 export { default as FilterList } from './FilterList';
 export { default as Flash } from './Flash';
@@ -33,20 +47,28 @@ export { default as Heading } from './Heading';
 export { default as LabelGroup } from './LabelGroup';
 export { default as Label } from './Label';
 export { default as Link } from './Link';
+export { default as Overlay } from './Overlay';
 export { default as Pagehead } from './Pagehead';
 export { default as Pagination } from './Pagination';
 export { default as PointerBox } from './PointerBox';
 export { default as Popover } from './Popover';
+// export {default as Portal, registerPortalRoot} from './Portal'
+// export type {PortalProps} from './Portal'
 export { default as ProgressBar } from './ProgressBar';
 export { default as SelectMenu } from './SelectMenu';
 export { default as SideNav } from './SideNav';
+export { default as Spinner } from './Spinner';
 export { default as StateLabel } from './StateLabel';
 export { default as StyledOcticon } from './StyledOcticon';
 export { default as SubNav } from './SubNav';
 export { default as TabNav } from './TabNav';
 export { default as TextInput } from './TextInput';
+export { default as TextInputWithTokens } from './TextInputWithTokens';
 export { default as Text } from './Text';
 export { default as Timeline } from './Timeline';
+export { default as Token, IssueLabelToken, AvatarToken } from './Token';
 export { default as Tooltip } from './Tooltip';
 export { default as Truncate } from './Truncate';
-export { default as UnderlineNav } from './UnderlineNav';
+export { default as UnderlineNav } from './UnderlineNav';
+export { default as Checkbox } from './Checkbox';
+export { SSRProvider, useSSRSafeId } from './utils/ssr';

package/lib-esm/polyfills/eventListenerSignal.d.ts

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

package/lib-esm/polyfills/eventListenerSignal.js

@@ -0,0 +1,57 @@
+/*
+
+This file polyfills the following: https://github.com/whatwg/dom/issues/911
+Once all targeted browsers support this DOM feature, this polyfill can be deleted.
+
+This allows users to pass an AbortSignal to a call to addEventListener as part of the
+AddEventListenerOptions object. When the signal is aborted, the event listener is
+removed.
+
+*/
+let signalSupported = false; // eslint-disable-next-line @typescript-eslint/no-empty-function
+
+function noop() {}
+
+try {
+  const options = Object.create({}, {
+    signal: {
+      get() {
+        signalSupported = true;
+      }
+
+    }
+  });
+  window.addEventListener('test', noop, options);
+  window.removeEventListener('test', noop, options);
+} catch (e) {
+  /* */
+}
+
+function featureSupported() {
+  return signalSupported;
+}
+
+function monkeyPatch() {
+  if (typeof window === 'undefined') {
+    return;
+  }
+
+  const originalAddEventListener = EventTarget.prototype.addEventListener;
+
+  EventTarget.prototype.addEventListener = function (name, originalCallback, optionsOrCapture) {
+    if (typeof optionsOrCapture === 'object' && 'signal' in optionsOrCapture && optionsOrCapture.signal instanceof AbortSignal) {
+      originalAddEventListener.call(optionsOrCapture.signal, 'abort', () => {
+        this.removeEventListener(name, originalCallback, optionsOrCapture);
+      });
+    }
+
+    return originalAddEventListener.call(this, name, originalCallback, optionsOrCapture);
+  };
+}
+
+export function polyfill() {
+  if (!featureSupported()) {
+    monkeyPatch();
+    signalSupported = true;
+  }
+}

package/lib-esm/sx.d.ts

@@ -0,0 +1,14 @@
+import { SystemCssProperties, SystemStyleObject } from '@styled-system/css';
+import { ThemeColorPaths, ThemeShadowPaths } from './theme';
+import { ColorProps, ShadowProps } from 'styled-system';
+import merge from 'deepmerge';
+export declare type BetterCssProperties = {
+    [K in keyof SystemCssProperties]: K extends keyof ColorProps ? ThemeColorPaths | SystemCssProperties[K] : K extends keyof ShadowProps ? ThemeShadowPaths | SystemCssProperties[K] : SystemCssProperties[K];
+};
+export declare type BetterSystemStyleObject = BetterCssProperties | SystemStyleObject;
+export interface SxProp {
+    sx?: BetterSystemStyleObject;
+}
+declare const sx: (props: SxProp) => import("@styled-system/css").CssFunctionReturnType;
+export default sx;
+export { merge };

package/lib-esm/sx.js

@@ -1,9 +1,7 @@
-import PropTypes from 'prop-types';
 import css from '@styled-system/css';
+import merge from 'deepmerge';
 
 const sx = props => css(props.sx);
 
-sx.propTypes = {
-  sx: PropTypes.object
-};
-export default sx;
+export default sx;
+export { merge };

package/lib-esm/theme-preval.d.ts

@@ -0,0 +1,49 @@
+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 {};