Skip to content

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

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

'use client';

/**
 * @file SideNavRenderContext.ts
 * @input createSharedContext, use
 * @output Exports SideNavRenderContext and useSideNavRenderMode hook
 * @position Internal context for controlling SideNav rendering mode
 *
 * When AppShell renders the SideNav in multiple locations (inline, top bar,
 * mobile drawer), this context tells SideNav which parts to render:
 * - 'default': full sidebar (desktop inline)
 * - 'topbar': heading + footerIcons only, laid out horizontally (mobile top bar)
 * - 'drawer': children only, skip heading + footerIcons (mobile drawer)
 */

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

export type SideNavRenderMode =
  'default' | 'topbar' | 'drawer' | 'drawer-content';

export const SideNavRenderContext = createSharedContext<SideNavRenderMode>(
  'SideNavRenderContext',
  1,
  'default',
);
SideNavRenderContext.displayName = 'SideNavRenderContext';

/**
 * Read the current SideNav render mode from context.
 */
export function useSideNavRenderMode(): SideNavRenderMode {
  return use(SideNavRenderContext);
}