ilokesto

진입점

@ilokesto/overlay는 하나의 root entrypoint를 노출합니다. runtime export는 createOverlayStore, createOverlayContext, OverlayProvider, OverlayHost, useOverlay, useOverlayItems, useOverlayItem입니다. contract type에는 adapter hook과 map, overlay item과 store, context contract, OverlayPlugin, provider prop, UseOverlayReturn이 있습니다.

import {
  OverlayProvider,
  useOverlay,
  useOverlayItems,
  useOverlayItem,
  createOverlayStore,
  createOverlayContext,
  type OverlayAdapterMap,
  type OverlayRenderProps,
  type OverlayPlugin,
  type OverlayStoreApi,
} from '@ilokesto/overlay';

provider, host, hook이 React API이기 때문에 패키지는 React를 peer dependency로 둡니다. 저장소는 @ilokesto/store 위에 만들어졌지만, 애플리케이션은 보통 저장소 명령을 직접 조립하기보다 provider와 hook을 통해 사용합니다.

실무 메모

레퍼런스 문서는 런타임 계약을 정확히 설명합니다. 가이드에서는 이 API를 제품별 helper로 감쌀 수 있지만, 같은 lifecycle 언어를 유지해야 합니다. open은 item을 만들고, close는 closing 상태를 시작하며, remove는 item을 완료하고 삭제하고, clear는 provider 범위의 모든 대기 중인 overlay를 끝냅니다.

목차