Fix offline transactions for React Native #1137
main fromrefs/pull/1137/head·merged by kevin-dp(GitHub profile, opens in a new tab) Fix @tanstack/offline-transactions for React Native / Expo#
This PR fixes https://github.com/TanStack/db/issues/1013
Problem#
The DefaultOnlineDetector attempted to use browser-specific APIs (window.addEventListener('online'), document.addEventListener('visibilitychange')) which don't exist in React Native. This caused errors when using the package in RN/Expo environments.
Solution#
Introduced platform-specific OnlineDetector implementations:
WebOnlineDetector- Uses browser APIs (window.online/offline,document.visibilitychange)ReactNativeOnlineDetector- Uses RN primitives (@react-native-community/netinfofor network status,AppStatefor foreground/background)
The RN implementation is exposed via a separate entrypoint to avoid bundling RN modules for web users.
Usage#
Web (unchanged):
import { startOfflineExecutor } from '@tanstack/offline-transactions'
React Native / Expo:
import { startOfflineExecutor } from '@tanstack/offline-transactions/react-native'
The RN entrypoint automatically uses ReactNativeOnlineDetector. All other APIs remain the same.
Peer Dependencies (for RN users)#
npm install @react-native-community/netinfo
The package declares react-native and @react-native-community/netinfo as optional peer dependencies.
- 1
More templates
@tanstack/angular-db
npm i https://pkg.pr.new/@tanstack/angular-db@1137@tanstack/db
npm i https://pkg.pr.new/@tanstack/db@1137@tanstack/db-ivm
npm i https://pkg.pr.new/@tanstack/db-ivm@1137@tanstack/electric-db-collection
npm i https://pkg.pr.new/@tanstack/electric-db-collection@1137@tanstack/offline-transactions
npm i https://pkg.pr.new/@tanstack/offline-transactions@1137@tanstack/powersync-db-collection
npm i https://pkg.pr.new/@tanstack/powersync-db-collection@1137@tanstack/query-db-collection
npm i https://pkg.pr.new/@tanstack/query-db-collection@1137@tanstack/react-db
npm i https://pkg.pr.new/@tanstack/react-db@1137@tanstack/rxdb-db-collection
npm i https://pkg.pr.new/@tanstack/rxdb-db-collection@1137@tanstack/solid-db
npm i https://pkg.pr.new/@tanstack/solid-db@1137@tanstack/svelte-db
npm i https://pkg.pr.new/@tanstack/svelte-db@1137@tanstack/trailbase-db-collection
npm i https://pkg.pr.new/@tanstack/trailbase-db-collection@1137@tanstack/vue-db
npm i https://pkg.pr.new/@tanstack/vue-db@1137commit:
07980caSize Change: 0 B
Total Size: 90.5 kB
compressed-size-action::db-package-sizeℹ️ View Unchanged
Filename Size ./packages/db/dist/esm/collection/change-events.js1.39 kB ./packages/db/dist/esm/collection/changes.js1.19 kB ./packages/db/dist/esm/collection/events.js388 B ./packages/db/dist/esm/collection/index.js3.32 kB ./packages/db/dist/esm/collection/indexes.js1.1 kB ./packages/db/dist/esm/collection/lifecycle.js1.67 kB ./packages/db/dist/esm/collection/mutations.js2.34 kB ./packages/db/dist/esm/collection/state.js3.46 kB ./packages/db/dist/esm/collection/subscription.js3.62 kB ./packages/db/dist/esm/collection/sync.js2.38 kB ./packages/db/dist/esm/deferred.js207 B ./packages/db/dist/esm/errors.js4.49 kB ./packages/db/dist/esm/event-emitter.js748 B ./packages/db/dist/esm/index.js2.69 kB ./packages/db/dist/esm/indexes/auto-index.js742 B ./packages/db/dist/esm/indexes/base-index.js766 B ./packages/db/dist/esm/indexes/btree-index.js1.93 kB ./packages/db/dist/esm/indexes/lazy-index.js1.1 kB ./packages/db/dist/esm/indexes/reverse-index.js513 B ./packages/db/dist/esm/local-only.js837 B ./packages/db/dist/esm/local-storage.js2.1 kB ./packages/db/dist/esm/optimistic-action.js359 B ./packages/db/dist/esm/paced-mutations.js496 B ./packages/db/dist/esm/proxy.js3.75 kB ./packages/db/dist/esm/query/builder/functions.js733 B ./packages/db/dist/esm/query/builder/index.js4.08 kB ./packages/db/dist/esm/query/builder/ref-proxy.js1.05 kB ./packages/db/dist/esm/query/compiler/evaluators.js1.42 kB ./packages/db/dist/esm/query/compiler/expressions.js430 B ./packages/db/dist/esm/query/compiler/group-by.js1.87 kB ./packages/db/dist/esm/query/compiler/index.js1.96 kB ./packages/db/dist/esm/query/compiler/joins.js2 kB ./packages/db/dist/esm/query/compiler/order-by.js1.45 kB ./packages/db/dist/esm/query/compiler/select.js1.06 kB ./packages/db/dist/esm/query/expression-helpers.js1.43 kB ./packages/db/dist/esm/query/ir.js673 B ./packages/db/dist/esm/query/live-query-collection.js360 B ./packages/db/dist/esm/query/live/collection-config-builder.js5.4 kB ./packages/db/dist/esm/query/live/collection-registry.js264 B ./packages/db/dist/esm/query/live/collection-subscriber.js1.93 kB ./packages/db/dist/esm/query/live/internal.js145 B ./packages/db/dist/esm/query/optimizer.js2.56 kB ./packages/db/dist/esm/query/predicate-utils.js2.97 kB ./packages/db/dist/esm/query/subset-dedupe.js921 B ./packages/db/dist/esm/scheduler.js1.3 kB ./packages/db/dist/esm/SortedMap.js1.3 kB ./packages/db/dist/esm/strategies/debounceStrategy.js247 B ./packages/db/dist/esm/strategies/queueStrategy.js428 B ./packages/db/dist/esm/strategies/throttleStrategy.js246 B ./packages/db/dist/esm/transactions.js2.9 kB ./packages/db/dist/esm/utils.js924 B ./packages/db/dist/esm/utils/browser-polyfills.js304 B ./packages/db/dist/esm/utils/btree.js5.61 kB ./packages/db/dist/esm/utils/comparison.js852 B ./packages/db/dist/esm/utils/cursor.js457 B ./packages/db/dist/esm/utils/index-optimization.js1.51 kB ./packages/db/dist/esm/utils/type-guards.js157 B Size Change: 0 B
Total Size: 3.47 kB
compressed-size-action::react-db-package-sizeℹ️ View Unchanged
Filename Size ./packages/react-db/dist/esm/index.js225 B ./packages/react-db/dist/esm/useLiveInfiniteQuery.js1.17 kB ./packages/react-db/dist/esm/useLiveQuery.js1.12 kB ./packages/react-db/dist/esm/useLiveSuspenseQuery.js559 B ./packages/react-db/dist/esm/usePacedMutations.js401 B Can we document this in the readme?
@claude update the readme of the @tanstack/offline-transactions package to explain how to use that package for web vs for React Native as i did in this PR description.
Claude finished @kevin-dp's task in 1m 22s —— View job
Documentation updated successfully#
Tasks completed#
- Read current README to understand structure
- Update README with platform-specific usage instructions (web vs React Native)
- Commit and push changes
Summary#
I've updated the
@tanstack/offline-transactionsREADME to document the platform-specific usage for web vs React Native. The changes include:Installation Section#
- Split into separate sections for Web and React Native/Expo
- Documented the required
@react-native-community/netinfopeer dependency for React Native
Platform Support Section (new)#
- Explained the different underlying APIs used:
- Web: Browser APIs (
window.online/offline,document.visibilitychange) - React Native: React Native primitives (
@react-native-community/netinfo,AppState)
- Web: Browser APIs (
Quick Start Section#
- Split into separate examples for Web and React Native
- Showed the different import paths:
- Web:
import { ... } from '@tanstack/offline-transactions' - React Native:
import { ... } from '@tanstack/offline-transactions/react-native'
- Web:
- Emphasized that all other APIs remain identical between platforms
Platform Support Section (bottom)#
- Updated from "Browser Support" to "Platform Support"
- Added React Native/Expo version requirements and storage details
The documentation now clearly guides users on how to use the package in both web and React Native environments, matching the implementation details from this PR.
--- •
- Resolvedby kevin-dp(GitHub profile, opens in a new tab)@@ -55,3 +74,7 @@5574 await offlineTx.commit()5675 ```577677+### React Native / Expo78+79+```typescript80+import { startOfflineExecutor } from '@tanstack/offline-transactions/react-native'
@Claude no need to repeat all the same code as we already show for the web example. Just show that the import is different.
KyleAMathews(GitHub profile, opens in a new tab) approved these changes
kevin-dp(GitHub profile, opens in a new tab) closed this
Sign in to join this conversation.
🦋 Changeset detected#
Latest commit: 619bec1ec04fe3bb0e49f5ef15a2f14cc5ed279d
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR