@teamsparta/stack-core/dist/responsive/StackBreakpointProvider.d.ts

stack core

import * as react_jsx_runtime from 'react/jsx-runtime';
import { PropsWithChildren } from 'react';
import { Breakpoint } from './types.js';

/**
 * @description Breakpoint를 주입받기 위한 Context 값입니다.
 * sm, md, lg 외 다른 키(BreakpointOverride 증강)를 추가할 수 있습니다.
 */
type BreakpointContextValue = Partial<Record<Breakpoint, number>>;
declare const useBreakpointContext: (consumerName: string) => Partial<Record<Breakpoint, number>>;
/**
 * @description Breakpoint를 주입하는 Provider입니다.
 * 들어온 device 별칭(mobile/tablet/desktop)을 sm/md/lg로 정규화하고,
 * 지정하지 않은 티어는 sm/md/lg 기본값({ sm: 0, md: 820, lg: 1024 })으로 채웁니다.
 * @example <StackBreakpointProvider md={768}>
 */
declare function StackBreakpointProvider({ children, ...overrides }: PropsWithChildren<BreakpointContextValue>): react_jsx_runtime.JSX.Element;

export { type BreakpointContextValue, StackBreakpointProvider, useBreakpointContext };