Skip to content

An open source design system that's fully customizable and agent ready

TypeScript
1.7 KB
Raw Blame
// Copyright (c) Meta Platforms, Inc. and affiliates.

'use client';

/**
 * @file pressGroupContext.ts
 * @input The layer-scoped context factory (Layer/layerScopedContext) and
 *   the press-group marker (privateAttributes/pressGroupItem.stylex)
 * @output PressGroupContext: the pointer types a group's own tracker follows
 *   on its actions, or null outside one. PressGroupBandContext: whether the
 *   group draws an action's touch band. pressGroupItemProps: the marker Button
 *   writes
 * @position Internal; not exported from the hooks entry. Groups that track
 *   presses provide it, and Button reads it. A layer resets it, so a Button
 *   in a member's layer is not tracked.
 */

import {createLayerScopedContext} from '../Layer/layerScopedContext';

// Button reads the marker here, not from its private StyleX module: a
// swizzled Button imports each StyleX module by its public path.
export {pressGroupItemProps} from '../privateAttributes/pressGroupItem.stylex';

/**
 * The pointer types a group's tracker follows on its actions, such as
 * `['touch', 'pen']`, or null outside a tracking group. Those actions take no
 * `:active` paint, so one press never lights two.
 */
export const PressGroupContext =
  createLayerScopedContext<ReadonlyArray<string> | null>(
    'PressGroupContext',
    1,
    null,
  );
PressGroupContext.displayName = 'PressGroupContext';

/**
 * Whether a tracking group draws this action's touch band. Such a group's band
 * covers its tracked actions, and it reads their targets when a press begins.
 * So an action in it draws no band of its own.
 */
export const PressGroupBandContext = createLayerScopedContext<boolean>(
  'PressGroupBandContext',
  1,
  false,
);
PressGroupBandContext.displayName = 'PressGroupBandContext';