Skip to main content

useRecoilStoreID()

Provides a StoreID associated with the currently active <RecoilRoot>.

function useRecoilStoreID(): StoreID

The StoreID is associated with the closest ancestor <RecoilRoot> (which does not have the override prop set to false with another ancestor) or <RecoilBridge>.

The type of StoreID is opaque. The ID provided matches the storeID passed to atom effects that are associated with the same <RecoilRoot>.