Add new changes here as they land
- Add
refreshto Recoil callback interface (#1413) - Fix transitive selector refresh for some cases (#1409)
useRecoilStoreID()hook to get an ID for the current store. (#1417)storeIDadded to atom effects interface (#1414)<RecoilRoot>will only callinitializeState()during initial render. (#1372)
- Memory management
- useTransition() compatibility
- Re-renders from Recoil updates now occur 1) earlier, 2) in sync with React updates in the same batch, and 3) before transaction observers instead of after.
- Fix TypeScript exports (#1397)
- Fix TypeScript exports (#1389)
- Added
useRecoilRefresher_UNSTABLE()hook which forces a selector to re-run it'sget(), and is a no-op for an atom. (#972, #1294, #1302) - Atom effect improvements:
- Add
getLoadable(),getPromise(), andgetInfo_UNSTABLE()to Atom Effects interface for reading other atoms. (#1205, #1210) - Add
isResetparameter toonSet()callback to know if the atom is being reset or not. (#1358, #1345)
- Add
Loadableimprovements:- Publish
RecoilLoadableinterface with factories and type checking for Loadables. (#1263, #1264, #1312) - Ability to map Loadables with other Loadables. (#1180)
- Re-implement Loadable as classes. (#1315)
- Publish
- Improved dev-mode checks:
- Atoms freeze default, initialized, and async values. Selectors should not freeze upstream dependencies. (#1261, #1259)
- Perform runtime check that required options are provided when creating atoms and selectors. (#1324)
- Fix user-thrown promises in selectors for some cases.
- Allow class instances in family parameters for Flow
- Performance optimizations to suppress re-rendering components:
- When subscribed selectors evaluate to the same value. (#749, #952)
- On initial render when not using React Concurrent Mode (#820)
- When selector async deps resolve, but React re-renders before chained promises have executed.
- Fixed #1072 where in some cases selectors with async deps would not update in response to state updates
- Selector cache configuration: introduced
cachePolicy_UNSTABLEoption for selectors and selector families. This option allows you to control the behavior of how the selector evicts entries from its internal cache. - Improved
useRecoilTransaction_UNSTABLE()hook for transactions with multiple atoms (#1085)
- Fix TypeScript typing for
selectorFamily(),getCallback(),useGetRecoilValueInfo(), andSnapshot#getNodes()(#1060, #1116, #1123) - Allow mutable values in selectors to be used with waitFor*() helpers (#1074, #1096)
- Atom Effects fixes:
- Fix onSet() handler to get the proper new value when an atom is reset or has an async default Promise that resolves (#1059, #1050, #738) (Slightly breaking change)
- Fix support for multiple Atom effects cleanup handlers (#1125)
- Fix selector subscriptions when atoms with effects are initialized via a
Snapshot(#1135, #1107)
- Optimization for async selectors when dependencies resolve to cached values (#1037)
- Remove unnecessary warning message (#1034, #1062)
- Fix TypeScript exports
For supporting garbage collection in the future there is a slight breaking change that Snapshot's will only be valid for the duration of the callback or render. A new retain() API can be used to persist them longer. This is not enforced yet, but Recoil will now provide a warning in dev-mode if a Snapshot is used past its lifetime. (#1006)
- Add
overrideprop to<RecoilRoot>(#973) - Add
getCallback()to selector evaluation interface (#989) - Improved TypeScript and Flow typing for
Loadables (#966, #1022)
- Improve scalability (time and memory) of Atom families by cleaning up a legacy feature.
- Throwing an error in an async selector should be properly caught by
<ErrorBoundary>'s (#998, #1017) - Fix for Atom Effects
onSet()should not be called when triggered fromsetSelf()initializing with a Promise or from the sameonSet()handler. (#974, #979, #953, #986) - Improved support for Safari (#967, #609)
- Objects stored in selectors are properly frozen in dev mode (#911)
- More reliable async selectors
- Improved performance using HAMT data structures (b7d1cfddec66dae).
- Changed semantics of waitForAny() such that it will always return loadables unless everything is loading. This better aligns behaviour of waitForAny() and waitForNone()
- Added a waitForAllSettled helper analogous to Promise.allSettled. (4c95591)
- Friendly error message for misuse of useRecoilCallback (#870)
- Friendly error message if you try to use an async function as a selector setter, which is not supported. (#777)
- Improved React Native support. (#748, #702)
- Added useGetRecoilValueInfo_UNSTABLE() hook for dev tools. (#713, #714)
- Selectors now treat any non-Promise that is thrown as an error, rather than only instances of Error. (f0e66f727)
- A child of RecoilRoot could sometimes have its state updated after being unmounted. (#917)
- The error message for missing RecoilRoot wasn't displayed on React experimental releases. (#712)
- IE 11 compatibility (#894, d27c800d8)
- Errors shouldn't be frozen (#852)
- Atom effects could fail to initialize atoms in certain cases (#775).
- Async selectors would fail with multiple React roots (a618a3).
- Fixed peer dependencies
- Fix TypeScript exports
- Performance Improvements
- Experimental React Native support
- Experimental Atom Effects
- Experimental Snapshot construction
- Fix for bug affecting SSR
- Fix for bug affecting SSR on development builds
- Experimental React Concurrent Mode Support
- Performance
- Flow Types
- ES, CommonJS, and UMD packages
- Synchronization Across React Roots
- Preliminary Developer Tools API
- Test Infrastructure Fixes
- Fix exports for snapshot hooks
- TypeScript support now rolled into Recoil repository and package.
- Recoil Snapshot API for observing and managing global Recoil state.
- Throw error with meaningful message if user doesn't use an atom or selector with most Recoil hooks (#205) - Thanks @alexandrzavalii
- Improve testing (#321, #318, #294, #262, #295) - Thanks @aaronabramov, @Komalov, @mondaychen, @drarmstr, and @tyler-mitchell
- Improve open-source build (#249, #203, #33) - Thanks to @tony-go, @acutmore, and @jaredpalmer
- Some fixes for Server Side Rendering, though we do not officially support it yet. (#233, #220, #284) - Thanks @fyber-LJX, @Chrischuck, and @aulneau
- Fix selectors recording dependency subscriptions in some cases (#296) - Thanks @drarmstr
- Fix updaters in
useRecoilCallback()getting current state (#260) - Thanks @drarmstr - Fix error messages when throwing certain errors in the open-source build. (#199) - Thanks @jonthomp
- Reduce Flow errors for open-source builds (#308) - Thanks @Komalov
- Build system and repository syncing fixed.
- Fixed a bug where atoms that stored self-referential structures would cause an infinite loop. (#153)
- Fixed bugs affecting Server-Side Rendering. (#53)
- TypeScript support is now available via DefinitelyTyped.
atomFamilyandselectorFamily: these provide a standard way to create atoms and selectors using memoized functions. Compared with doing this yourself, in the future these will help with memory management.noWait,waitForNone,waitForAny,waitForAll: helpers for concurrency and other advanced logic in async selectors.constSelectoranderrorSelector: selectors that always evaluate to a constant or always throw an error.readOnlySelector: wraps a read-write atom or selector in a read-only interface, for when you need type covariance.