index int64 0 0 | repo_id stringlengths 16 181 | file_path stringlengths 28 270 | content stringlengths 1 11.6M | __index_level_0__ int64 0 10k |
|---|---|---|---|---|
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-deep-effect.tsx | import {useEffect} from 'react';
import {useDeepCompareRef} from './use-deep-compare-ref';
type DependencyList = readonly unknown[];
type Comparator = (a: DependencyList, b: DependencyList) => boolean;
/**
* A replacement for React's useEffect that'll allow for custom and deep
* compares of the dependency list.
... | 300 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-disable-interaction.ts | import {useCallback} from 'react';
/**
* useDisableInteraction provides the original event handler but disables interaction
* if the boolean passed is true.
* @param disabled - A boolean value that determines if the button should
* be disabled
* @param handleEvent - The original event handler
* @returns Function... | 301 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-event-listener.ts | import {useEffect, useRef} from 'react';
import type {RefObject} from 'react';
import {useIsomorphicLayoutEffect} from './use-isomorphic-layout-effect';
/**
* Acceptable target elements for `useEventListener`.
*/
type UseEventListenerTarget =
| Window
| Document
| HTMLElement
| RefObject<HTMLElement>;
/**
... | 302 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-index-resource-state.ts | import {useState, useCallback} from 'react';
export enum SelectionType {
All = 'all',
Page = 'page',
Multi = 'multi',
Single = 'single',
Range = 'range',
}
type Range = [number, number];
type ResourceIDResolver<T extends {[key: string]: unknown}> = (
resource: T,
) => string;
function defaultResourceIDRes... | 303 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-is-after-initial-mount.ts | import {useState, useEffect} from 'react';
/**
* useIsAfterInitialMount will trigger a re-render to provide
* you with an updated value. Using this you enhance server-side
* code that can only run on the client.
* @returns MutableRefObject<T> - Returns a ref object with the
* results from invoking initial value
... | 304 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-is-mounted-ref.ts | import {useRef, useEffect} from 'react';
import type {MutableRefObject} from 'react';
/**
* Returns a MutatableRefObject containing a boolean value that
* represents a components mounted status.
* @returns MutableRefObject<boolean> The mounted status
*/
export function useIsMountedRef(): MutableRefObject<boolean> ... | 305 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-is-touch-device.ts | import {useState, useCallback} from 'react';
import {useEventListener} from './use-event-listener';
export function useIsTouchDevice() {
const [isTouchDevice, setIsTouchDevice] = useState(false);
const handleTouchStart = useCallback(() => setIsTouchDevice(true), []);
useEventListener('touchstart', handleTouch... | 306 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-isomorphic-layout-effect.ts | // eslint-disable-next-line no-restricted-imports
import {useEffect, useLayoutEffect} from 'react';
import {isServer} from './target';
export const useIsomorphicLayoutEffect = isServer ? useEffect : useLayoutEffect;
| 307 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-lazy-ref.ts | import {useRef} from 'react';
import type {MutableRefObject} from 'react';
const UNIQUE_IDENTIFIER = Symbol('unique_identifier');
/**
* useLazyRef provides a lazy initial value, similar to lazy
* initial state the initialValue is the value used during
* initialization and disregarded after that. Use this hook
* f... | 308 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-on-value-change.ts | import React, {useEffect} from 'react';
export function useOnValueChange<T>(
value: T,
onChange: (value: T, oldValue: T) => void,
) {
const tracked = React.useRef(value);
useEffect(() => {
const oldValue = tracked.current;
if (value !== tracked.current) {
tracked.current = value;
onChange(v... | 309 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-previous.ts | import {useRef, useEffect} from 'react';
/**
* Returns the previous value of a variable.
*/
export function usePrevious<T>(value: T) {
const ref = useRef<T>();
useEffect(() => {
ref.current = value;
}, [value]);
return ref.current;
}
| 310 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-theme.ts | import {createContext, useContext} from 'react';
import type {ThemeName, Theme} from '@shopify/polaris-tokens';
import {themes} from '@shopify/polaris-tokens';
export function getTheme(themeName: ThemeName): Theme {
return themes[themeName];
}
export const ThemeContext = createContext<Theme | null>(null);
export f... | 311 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/use-toggle.ts | import {useState, useCallback} from 'react';
/**
* Returns a stateful value, and a set of memoized functions to toggle it,
* set it to true and set it to false
*/
export function useToggle(initialState: boolean) {
const [value, setState] = useState(initialState);
return {
value,
toggle: useCallback(() ... | 312 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/within-content-context.tsx | import {createContext} from 'react';
export const WithinContentContext = createContext(false);
| 313 |
0 | petrpan-code/Shopify/polaris/polaris-react/src | petrpan-code/Shopify/polaris/polaris-react/src/utilities/within-filter-context.tsx | import {createContext} from 'react';
export const WithinFilterContext = createContext(false);
| 314 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/autocomplete/context.ts | import {createContext} from 'react';
interface MappedActionContextType {
role?: string;
url?: string;
external?: boolean;
onAction?(): void;
destructive?: boolean;
}
export const MappedActionContext = createContext<MappedActionContextType>({});
| 315 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/autocomplete/index.ts | export * from './context';
| 316 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/combobox/context.tsx | import {createContext} from 'react';
export interface ComboboxTextFieldType {
// Value for the TextField aria-activedescendant. (also on list context when not in combobox)
activeOptionId?: string;
// Value for the Combobox aria-owns and TextField aria-control
listboxId?: string;
// Value for aria-expanded on... | 317 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/combobox/hooks.tsx | import {useContext} from 'react';
import {ComboboxTextFieldContext, ComboboxListboxContext} from './context';
export function useComboboxTextField() {
const context = useContext(ComboboxTextFieldContext);
if (!context) {
throw new Error(
'No Combobox was provided. Your component must be wrapped in a <Co... | 318 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/combobox/index.ts | export * from './context';
export * from './hooks';
| 319 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/combobox | petrpan-code/Shopify/polaris/polaris-react/src/utilities/combobox/tests/hook.test.tsx | import React from 'react';
import {mountWithApp} from 'tests/utilities';
import {useComboboxTextField} from '../hooks';
import {ComboboxTextFieldContext} from '../context';
function TextFieldComponent() {
const textFieldContext = useComboboxTextField();
return textFieldContext ? <div /> : null;
}
describe('text... | 320 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/ephemeral-presence-manager/context.tsx | import {createContext} from 'react';
export type EphemeralPresenceKey = 'tooltip';
export interface EphemeralPresenceManagerContextType {
presenceList: {
[key in EphemeralPresenceKey]: boolean;
};
presenceCounter: {
[key in EphemeralPresenceKey]: number;
};
addPresence: (key: EphemeralPresenceKey) =... | 321 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/ephemeral-presence-manager/hooks.ts | import {useContext} from 'react';
import {EphemeralPresenceManagerContext} from './context';
export function useEphemeralPresenceManager() {
const ephemeralPresenceManager = useContext(EphemeralPresenceManagerContext);
if (!ephemeralPresenceManager) {
throw new Error(
'No ephemeral presence manager was... | 322 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/ephemeral-presence-manager/index.ts | export * from './hooks';
export * from './context';
| 323 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/features/context.ts | import {createContext} from 'react';
import type {FeaturesConfig} from './types';
export const classNamePolarisSummerEditions2023 =
'Polaris-Summer-Editions-2023';
export const FeaturesContext = createContext<FeaturesConfig | undefined>(
undefined,
);
| 324 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/features/hooks.tsx | import {useContext} from 'react';
import type {FeaturesConfig} from './types';
import {FeaturesContext} from './context';
export function useFeatures() {
const features = useContext(FeaturesContext);
if (!features) {
throw new Error('No Features were provided.');
}
return features;
}
/**
* Temporary c... | 325 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/features/index.ts | export * from './context';
export type {Features, FeaturesConfig} from './types';
export * from './hooks';
| 326 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/features/types.ts | export interface FeaturesConfig {
[key: string]: boolean | undefined;
}
export interface Features {}
| 327 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/features | petrpan-code/Shopify/polaris/polaris-react/src/utilities/features/tests/hooks.test.tsx | import React from 'react';
import {mount, mountWithApp} from 'tests/utilities';
import {useFeatures} from '../hooks';
function Component() {
const features = useFeatures();
return features.foo ? <div /> : null;
}
describe('useFeatures', () => {
let consoleErrorSpy: jest.SpyInstance;
beforeEach(() => {
c... | 328 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/focus-manager/context.tsx | import {createContext} from 'react';
export interface FocusManagerContextType {
trapFocusList: string[];
add: (id: string) => void;
remove: (id: string) => boolean;
}
export const FocusManagerContext = createContext<
FocusManagerContextType | undefined
>(undefined);
| 329 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/focus-manager/hooks.ts | import {useContext, useMemo, useEffect, useId} from 'react';
import {MissingAppProviderError} from '../errors';
import {FocusManagerContext} from './context';
interface Options {
trapping: boolean;
}
export function useFocusManager({trapping}: Options) {
const focusManager = useContext(FocusManagerContext);
c... | 330 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/focus-manager/index.ts | export * from './context';
export * from './hooks';
| 331 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/focus-manager | petrpan-code/Shopify/polaris/polaris-react/src/utilities/focus-manager/tests/hooks.test.tsx | import React from 'react';
import {mount, mountWithApp} from 'tests/utilities';
import {useFocusManager} from '../hooks';
let consoleErrorSpy: jest.SpyInstance;
const Component = () =>
typeof useFocusManager({trapping: true}).canSafelyFocus === 'boolean' ? (
<div />
) : null;
describe('useFocusManager', () ... | 332 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/frame/context.ts | import {createContext} from 'react';
import type {
ToastPropsWithID,
ToastID,
ContextualSaveBarProps,
Logo,
} from './types';
// This is internal, but TS throws a build-time error if we don't export it
export interface FrameContextType {
logo?: Logo;
showToast(toast: ToastPropsWithID): void;
hideToast(t... | 333 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/frame/hooks.ts | import {useContext} from 'react';
import {FrameContext} from './context';
export function useFrame() {
const frame = useContext(FrameContext);
if (!frame) {
throw new Error(
'No Frame context was provided. Your component must be wrapped in a <Frame> component. See https://polaris.shopify.com/components... | 334 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/frame/index.ts | export * from './hooks';
export * from './context';
export type {
ContextualSaveBarProps,
ToastProps,
ToastID,
ToastPropsWithID,
} from './types';
| 335 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/frame/types.ts | import type {Action} from '../../types';
export interface Logo {
/** Provides a path for a logo used on a dark background */
topBarSource?: string;
/** Provides a path for a logo used on a light background */
contextualSaveBarSource?: string;
/** Destination the merchant will navigate to when clicking the lo... | 336 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/frame | petrpan-code/Shopify/polaris/polaris-react/src/utilities/frame/tests/hooks.test.tsx | import React, {useContext} from 'react';
import {mountWithApp, mount} from 'tests/utilities';
import {useFrame} from '../hooks';
import {FrameContext} from '../context';
describe('useFrame', () => {
let consoleErrorSpy: jest.SpyInstance;
function Component() {
return useFrame() === useContext(FrameContext) ?... | 337 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n/I18n.ts | import {get} from '../get';
import {merge} from '../merge';
const REPLACE_REGEX = /{([^}]*)}/g;
interface TranslationDictionary {
[key: string]: string | TranslationDictionary;
}
export class I18n {
private translation: TranslationDictionary = {};
/**
* @param translation A locale object or array of locale... | 338 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n/context.tsx | import {createContext} from 'react';
import type {I18n} from './I18n';
export const I18nContext = createContext<I18n | undefined>(undefined);
| 339 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n/hooks.tsx | import {useContext} from 'react';
import {MissingAppProviderError} from '../errors';
import {I18nContext} from './context';
export function useI18n() {
const i18n = useContext(I18nContext);
if (!i18n) {
throw new MissingAppProviderError('No i18n was provided.');
}
return i18n;
}
| 340 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n/index.ts | export * from './context';
export * from './hooks';
export * from './I18n';
| 341 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n/tests/I18n.test.ts | import {I18n} from '../I18n';
describe('I18n.translate', () => {
it('returns a simple string value in the translation dictionary', () => {
const i18n = new I18n({foo: 'bar'});
expect(i18n.translate('foo')).toBe('bar');
});
it('returns a nested string value in the translation dictionary', () => {
con... | 342 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n | petrpan-code/Shopify/polaris/polaris-react/src/utilities/i18n/tests/hooks.test.tsx | import React, {useContext} from 'react';
import {mount, mountWithApp} from 'tests/utilities';
import {useI18n} from '../hooks';
import {I18nContext} from '../context';
let consoleErrorSpy: jest.SpyInstance;
function Component() {
return useI18n() === useContext(I18nContext) ? <div /> : null;
}
describe('useI18n',... | 343 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-provider/context.ts | import {createContext} from 'react';
import type {SelectionType, SELECT_ALL_ITEMS, Range} from './types';
export interface IndexContextType {
loading?: boolean;
bulkSelectState?: boolean | 'indeterminate';
resourceName: {
singular: string;
plural: string;
};
selectedItemsCount: typeof SELECT_ALL_ITE... | 344 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-provider/hooks.ts | import {useContext, useRef, useCallback} from 'react';
import {useI18n} from '../i18n';
import {SELECT_ALL_ITEMS, SelectionType} from './types';
import type {
HandleSelectionChange,
Range,
BulkSelectionDataOptions,
HandleBulkSelectionOptions,
} from './types';
import {
IndexContext,
IndexRowContext,
Ind... | 345 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-provider/index.ts | export * from './hooks';
export * from './context';
export * from './types';
| 346 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-provider/types.ts | export type IndexSelectedItems = string[] | 'All';
export const SELECT_ALL_ITEMS = 'All';
export enum SelectionType {
All = 'all',
Page = 'page',
Multi = 'multi',
Single = 'single',
Range = 'range',
}
export type Range = [number, number];
export interface IndexProviderProps {
children?: React.ReactNode;... | 347 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-provider | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-provider/tests/hooks.test.tsx | import React from 'react';
import {mountWithApp, mount} from 'tests/utilities';
import {
IndexRowContext,
IndexSelectionChangeContext,
IndexContext,
} from '../context';
import type {IndexContextType} from '../context';
import {SelectionType} from '../types';
import type {
BulkSelectionDataOptions,
HandleBul... | 348 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table/context.ts | import {createContext} from 'react';
interface RowContextType {
itemId?: string;
selected?: boolean | 'indeterminate';
disabled?: boolean;
position?: number;
onInteraction?: (event: React.MouseEvent | React.KeyboardEvent) => void;
}
export const RowContext = createContext<RowContextType>({});
export const ... | 349 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table/hooks.ts | import {useContext} from 'react';
import {RowContext, RowHoveredContext, ScrollContext} from './context';
export function useRowHovered() {
const hovered = useContext(RowHoveredContext);
return hovered;
}
export function useRowSelected() {
const {selected} = useContext(RowContext);
return selected;
}
export... | 350 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table/index.ts | export * from './hooks';
export * from './context';
| 351 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table/tests/hooks-useContainerScroll.test.tsx | import React from 'react';
import {mountWithApp} from 'tests/utilities';
// eslint-disable-next-line @shopify/strict-component-boundaries
import {IndexTable, ScrollContainer} from '../../../components/IndexTable';
// eslint-disable-next-line @shopify/strict-component-boundaries
import type {IndexTableProps} from '../.... | 352 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table/tests/hooks-useRowHovered.test.tsx | import React from 'react';
import {mountWithApp} from 'tests/utilities';
// eslint-disable-next-line @shopify/strict-component-boundaries
import {IndexTable} from '../../../components/IndexTable';
// eslint-disable-next-line @shopify/strict-component-boundaries
import type {IndexTableProps} from '../../../components/I... | 353 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table | petrpan-code/Shopify/polaris/polaris-react/src/utilities/index-table/tests/hooks-useRowSelected.test.tsx | import React from 'react';
import {mountWithApp} from 'tests/utilities';
// eslint-disable-next-line @shopify/strict-component-boundaries
import {IndexTable} from '../../../components/IndexTable';
// eslint-disable-next-line @shopify/strict-component-boundaries
import type {IndexTableProps} from '../../../components/I... | 354 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/link/context.tsx | import {createContext} from 'react';
import type {LinkLikeComponent} from './types';
export const LinkContext = createContext<LinkLikeComponent | undefined>(
undefined,
);
| 355 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/link/hooks.tsx | import {useContext} from 'react';
import {LinkContext} from './context';
export function useLink() {
return useContext(LinkContext);
}
| 356 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/link/index.ts | export * from './context';
export * from './hooks';
export type {LinkLikeComponent, LinkLikeComponentProps} from './types';
| 357 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/link/types.ts | import type {Target} from '../../types';
export interface LinkLikeComponentProps
extends React.HTMLProps<HTMLAnchorElement> {
/** The url to link to */
url: string;
/** The content to display inside the link */
children?: React.ReactNode;
/** Makes the link open in a new tab */
external?: boolean;
/** ... | 358 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/link | petrpan-code/Shopify/polaris/polaris-react/src/utilities/link/tests/hooks.test.tsx | import React, {useContext} from 'react';
import {mountWithApp} from 'tests/utilities';
import {useLink} from '../hooks';
import {LinkContext} from '../context';
let consoleErrorSpy: jest.SpyInstance;
function Component() {
return useLink() === useContext(LinkContext) ? <div /> : null;
}
describe('useLink', () => ... | 359 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/listbox/context.ts | import {createContext} from 'react';
import type {NavigableOption} from './types';
export interface ListboxContextType {
onOptionSelect(option: NavigableOption): void;
setLoading(label?: string): void;
}
export const ListboxContext = createContext<ListboxContextType | undefined>(
undefined,
);
export const Wi... | 360 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/listbox/hooks.ts | import {useContext} from 'react';
import {ListboxContext} from './context';
export function useListbox() {
const listbox = useContext(ListboxContext);
if (!listbox) {
throw new Error(
'No Listbox was provided. Listbox components must be wrapped in a Listbox',
);
}
return listbox;
}
| 361 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/listbox/index.ts | export * from './context';
export * from './hooks';
export * from './types';
export * from './utilities';
| 362 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/listbox/types.ts | export interface NavigableOption {
domId: string;
value: string;
element: HTMLElement;
disabled: boolean;
isAction?: boolean;
index?: number;
}
| 363 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/listbox/utilities.ts | export function scrollOptionIntoView(
option: HTMLElement,
scrollable: HTMLElement,
) {
const listTop = scrollable.scrollTop;
const listBottom = listTop + scrollable.clientHeight;
const {offsetHeight: optionHeight} = option;
const {offsetTop: optionTop} = option;
const optionBottom = optionTop + optionHei... | 364 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/media-query/context.tsx | import {createContext} from 'react';
// This is internal, but TS throws a build-time error if we don't export it
export interface MediaQueryContextType {
isNavigationCollapsed: boolean;
}
export const MediaQueryContext = createContext<
MediaQueryContextType | undefined
>(undefined);
| 365 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/media-query/hooks.tsx | import {useContext} from 'react';
import {MediaQueryContext} from './context';
export function useMediaQuery() {
const mediaQuery = useContext(MediaQueryContext);
if (!mediaQuery) {
throw new Error(
'No mediaQuery was provided. Your application must be wrapped in an <AppProvider> component. See https:/... | 366 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/media-query/index.ts | export * from './context';
export * from './hooks';
| 367 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/media-query | petrpan-code/Shopify/polaris/polaris-react/src/utilities/media-query/tests/hooks.test.tsx | import React, {useContext} from 'react';
import {mount, mountWithApp} from 'tests/utilities';
import {useMediaQuery} from '../hooks';
import {MediaQueryContext} from '../context';
let consoleErrorSpy: jest.SpyInstance;
function Component() {
return useMediaQuery() === useContext(MediaQueryContext) ? <div /> : null... | 368 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/portals/context.tsx | import {createContext} from 'react';
import type {PortalsContainerElement} from './types';
export interface PortalsManager {
container: PortalsContainerElement;
}
export const PortalsManagerContext = createContext<PortalsManager | undefined>(
undefined,
);
| 369 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/portals/hooks.ts | import {useContext} from 'react';
import {PortalsManagerContext} from './context';
export function usePortalsManager() {
const portalsManager = useContext(PortalsManagerContext);
if (!portalsManager) {
throw new Error(
'No portals manager was provided. Your application must be wrapped in an <AppProvide... | 370 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/portals/index.ts | export * from './context';
export * from './hooks';
export type {PortalsContainerElement} from './types';
| 371 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/portals/types.ts | export type PortalsContainerElement = HTMLDivElement | null;
| 372 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/portals | petrpan-code/Shopify/polaris/polaris-react/src/utilities/portals/tests/hooks.test.tsx | import React, {useContext} from 'react';
import {mount, mountWithApp} from 'tests/utilities';
import {usePortalsManager} from '../hooks';
import {PortalsManagerContext} from '../context';
let consoleErrorSpy: jest.SpyInstance;
function Component() {
return usePortalsManager() === useContext(PortalsManagerContext) ... | 373 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/resource-list/context.ts | import {createContext} from 'react';
import type {ResourceListSelectedItems} from './types';
// This is internal, but TS throws a build-time error if we don't export it
export interface ResourceListContextType {
selectMode?: boolean;
selectable?: boolean;
selectedItems?: ResourceListSelectedItems;
resourceNam... | 374 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/resource-list/index.ts | export * from './context';
export {SELECT_ALL_ITEMS} from './types';
export type {ResourceListSelectedItems} from './types';
| 375 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/resource-list/types.ts | export type ResourceListSelectedItems = string[] | 'All';
export const SELECT_ALL_ITEMS = 'All';
| 376 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/scroll-lock-manager/context.tsx | import {createContext} from 'react';
import type {ScrollLockManager} from './scroll-lock-manager';
export const ScrollLockManagerContext = createContext<
ScrollLockManager | undefined
>(undefined);
| 377 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/scroll-lock-manager/hooks.tsx | import {useContext} from 'react';
import {MissingAppProviderError} from '../errors';
import {ScrollLockManagerContext} from './context';
export function useScrollLockManager() {
const scrollLockManager = useContext(ScrollLockManagerContext);
if (!scrollLockManager) {
throw new MissingAppProviderError('No Sc... | 378 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/scroll-lock-manager/index.ts | export * from './context';
export * from './hooks';
export * from './scroll-lock-manager';
| 379 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/scroll-lock-manager/scroll-lock-manager.ts | import {isServer} from '../target';
export const SCROLL_LOCKING_ATTRIBUTE = 'data-lock-scrolling';
const SCROLL_LOCKING_HIDDEN_ATTRIBUTE = 'data-lock-scrolling-hidden';
const SCROLL_LOCKING_WRAPPER_ATTRIBUTE = 'data-lock-scrolling-wrapper';
let scrollPosition = 0;
function isScrollBarVisible() {
const {body} = d... | 380 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/scroll-lock-manager | petrpan-code/Shopify/polaris/polaris-react/src/utilities/scroll-lock-manager/tests/hooks.test.tsx | import React, {useContext} from 'react';
import {mount, mountWithApp} from 'tests/utilities';
import {useScrollLockManager} from '../hooks';
import {ScrollLockManagerContext} from '../context';
let consoleErrorSpy: jest.SpyInstance;
function Component() {
return useScrollLockManager() === useContext(ScrollLockMana... | 381 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/sticky-manager/context.tsx | import {createContext} from 'react';
import type {StickyManager} from './sticky-manager';
export const StickyManagerContext = createContext<StickyManager | undefined>(
undefined,
);
| 382 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/sticky-manager/hooks.ts | import {useContext} from 'react';
import {MissingAppProviderError} from '../errors';
import {StickyManagerContext} from './context';
export function useStickyManager() {
const stickyManager = useContext(StickyManagerContext);
if (!stickyManager) {
throw new MissingAppProviderError('No StickyManager was prov... | 383 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/sticky-manager/index.ts | export * from './context';
export * from './hooks';
export * from './sticky-manager';
| 384 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/sticky-manager/sticky-manager.ts | import {themeDefault} from '@shopify/polaris-tokens';
import {debounce} from '../debounce';
import {dataPolarisTopBar, scrollable} from '../../components/shared';
import {stackedContent} from '../breakpoints';
import {getRectForNode} from '../geometry';
import type {Rect} from '../geometry';
interface StickyItem {
... | 385 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities/sticky-manager | petrpan-code/Shopify/polaris/polaris-react/src/utilities/sticky-manager/tests/hooks.test.tsx | import React, {useContext} from 'react';
import {mount, mountWithApp} from 'tests/utilities';
import {useStickyManager} from '../hooks';
import {StickyManagerContext} from '../context';
let consoleErrorSpy: jest.SpyInstance;
function Component() {
return useStickyManager() === useContext(StickyManagerContext) ? (
... | 386 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/arrays.test.ts | import {arraysAreEqual} from '../arrays';
describe('arrays', () => {
it('declares equal arrays as equal', () => {
const firstArray = ['one', 'two', 'three'];
const secondArray = ['one', 'two', 'three'];
expect(arraysAreEqual(firstArray, secondArray)).toBe(true);
});
it('declares differing arrays as... | 387 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/capitalize.test.ts | import {capitalize} from '../capitalize';
describe('capitalize', () => {
it('capitalizes a word', () => {
expect(capitalize('hello')).toBe('Hello');
});
it('gives a word proper casing', () => {
expect(capitalize('HELLO')).toBe('Hello');
});
it('capitalizes single letter words', () => {
expect(c... | 388 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/clamp.test.ts | import {clamp} from '../clamp';
describe('clamp', () => {
it('adjusts the given number to be at least the min', () => {
const min = 10;
const number = clamp(9, min, 50);
expect(number).toBe(min);
});
it('adjusts the given number to be no more than the max', () => {
const max = 100;
const num... | 389 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/closest-parent-match.test.ts | import {closestParentMatch} from '../closest-parent-match';
describe('closest-parent-match', () => {
it('matches first parent element', () => {
const {parent, child, matcher} = setUpParentAndChild();
const closestParent = closestParentMatch(child, matcher);
expect(parent).toBe(closestParent);
});
i... | 390 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/color-transformers.test.ts | import {
hsbToRgb,
rgbToHex,
rgbToHsb,
rgbString,
hsbToHex,
colorToHsla,
} from '../color-transformers';
describe('colorUtilities', () => {
describe('rgbString', () => {
it('returns rgb string for rgb', () => {
expect(rgbString({red: 132, green: 11, blue: 2})).toMatch(
'rgb(132, 11, 2)'... | 391 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/color-validation.test.ts | import {isLight, isDark} from '../color-validation';
describe('isLight', () => {
it('will return true if the color is light', () => {
const isColorLight = isLight({red: 255, green: 255, blue: 255});
expect(isColorLight).toBe(true);
});
it('will return false if the color is dark', () => {
const isCol... | 392 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/css.test.ts | import {classNames, variationName, getResponsiveProps} from '../css';
describe('classNames', () => {
it('returns a single string from multiple classes', () => {
expect(classNames('btn', 'btn-sm')).toBe('btn btn-sm');
});
it('filters out falsy values', () => {
expect(
classNames(
'btn',
... | 393 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/debounce.test.ts | import {debounce} from '../debounce';
const identity = (value: any) => value;
describe('debounce', () => {
beforeAll(() => {
jest.useFakeTimers();
});
afterAll(() => {
jest.useRealTimers();
});
it('debounces a function', () => {
let callCount = 0;
const debounced = debounce((value: any) =... | 394 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/duration.test.ts | import {
ensureTwoDigits,
secondsToTimeComponents,
secondsToTimestamp,
secondsToDurationTranslationKey,
} from '../duration';
describe('<VideoThumbnail /> utilities', () => {
describe('ensureTwoDigits', () => {
it('stringifies the number when greater than 9', () => {
expect(ensureTwoDigits(12)).toB... | 395 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/focus.test.ts | import type {MouseEvent} from 'react';
import {
handleMouseUpByBlurring,
focusNextFocusableNode,
nextFocusableNode,
findFirstKeyboardFocusableNode,
focusFirstKeyboardFocusableNode,
findLastKeyboardFocusableNode,
} from '../focus';
describe('handleMouseUpByBlurring()', () => {
it('calls blur on the curre... | 396 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/get-width.test.ts | import {getWidth} from '../get-width';
describe('getWidth', () => {
it('will return a pixel value', () => {
const width = getWidth({width: 200}, null, 'width');
expect(width).toBe(`200px`);
});
describe('value argument', () => {
it('will return a pixel value from a nested object', () => {
cons... | 397 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/get.test.ts | import {get} from '../get';
describe('get', () => {
it('returns undefined when the path does not exist', () => {
expect(get({}, 'a')).toBeUndefined();
});
it('returns a value for a single keypath', () => {
expect(get({hello: 'polaris'}, 'hello')).toBe('polaris');
});
it('returns the value for a com... | 398 |
0 | petrpan-code/Shopify/polaris/polaris-react/src/utilities | petrpan-code/Shopify/polaris/polaris-react/src/utilities/tests/is-element-in-viewport.test.ts | import {isElementInViewport} from '../is-element-in-viewport';
describe('isElementInViewport', () => {
const originalGetBoundingClientRect = Element.prototype.getBoundingClientRect;
afterEach(() => {
Element.prototype.getBoundingClientRect = originalGetBoundingClientRect;
});
it('returns true when in vie... | 399 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.