Skip to content

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

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

'use client';

/**
 * @file SideNavFocusTargetsContext.ts
 * @input The SideNav rail's rows and its collapse toggle, registered by their
 *   callback refs
 * @output Where focus goes when collapsing the rail removes the focused row
 * @position Internal to SideNav: not exported from the SideNav entry. SideNav
 *   provides it; SideNavItem registers its row and SideNavCollapseButton,
 *   rendered inside the SideNav, registers itself (`component:SideNav` AR3).
 */

import {createSharedContext} from '../utils/sharedContext';

export interface SideNavFocusTargets {
  /**
   * Registers a row's root element, and whether the collapsed rail renders
   * the row (it has an icon and is not nested); returns its unregister.
   */
  registerRow: (element: HTMLElement, isKeptInRail: boolean) => () => void;
  /** Registers a collapse toggle rendered inside the SideNav. */
  registerToggle: (element: HTMLElement) => () => void;
}

export const SideNavFocusTargetsContext =
  createSharedContext<SideNavFocusTargets | null>(
    'SideNavFocusTargetsContext',
    1,
    null,
  );
SideNavFocusTargetsContext.displayName = 'SideNavFocusTargetsContext';