An open source design system that's fully customizable and agent ready
TypeScript
// Copyright (c) Meta Platforms, Inc. and affiliates.
'use client';
/**
* @file SideNavCollapseContext.ts
* @input createSharedContext, use
* @output Exports SideNavCollapseContext and useSideNavCollapse hook
* @position Internal context for sidenav collapse state
*
* Provides collapse state to SideNavCollapseButton and other
* sidenav children. Set by SideNav when isCollapsible is true.
* A button rendered outside the SideNav tree is out of context's reach and
* takes the controlled `collapsible` config as a prop instead.
*/
import {use} from 'react';
import {createSharedContext} from '../utils/sharedContext';
export interface SideNavCollapseState {
/** Whether the sidenav is currently collapsed */
isCollapsed: boolean;
/** Toggle collapse state */
toggle: () => void;
/** Whether collapse is enabled */
isCollapsible: boolean;
}
/** Object form of SideNav's `collapsible` prop. */
export interface SideNavCollapsibleConfig {
defaultIsCollapsed?: boolean;
isCollapsed?: boolean;
onCollapsedChange?: (isCollapsed: boolean) => void;
hasButton?: boolean;
buttonLabel?: string;
}
/**
* The controlled form: the consumer holds the state, so it can be handed to
* both SideNav and a SideNavCollapseButton rendered outside it.
*/
export interface SideNavControlledCollapsible extends SideNavCollapsibleConfig {
isCollapsed: boolean;
onCollapsedChange: (isCollapsed: boolean) => void;
}
/**
* @deprecated Pass the same controlled `collapsible` config to SideNav and to
* the out-of-tree SideNavCollapseButton instead. The state then reaches the
* button through props rather than through a ref.
*/
export interface SideNavImperativeCollapseHandle {
getCollapseState: () => SideNavCollapseState | null;
}
export const SideNavCollapseContext = createSharedContext<SideNavCollapseState>(
'SideNavCollapseContext',
1,
{
isCollapsed: false,
toggle: () => {},
isCollapsible: false,
},
);
SideNavCollapseContext.displayName = 'SideNavCollapseContext';
/**
* Read the sidenav collapse state from context.
* Returns { isCollapsed, toggle, isCollapsible }.
* When used outside a sidenav with isCollapsible, isCollapsible is false.
*/
export function useSideNavCollapse(): SideNavCollapseState {
return use(SideNavCollapseContext);
}