Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(sdk-react): make useSignal work with SSR #660

Merged
merged 2 commits into from
Feb 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/hot-tables-complain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@telegram-apps/sdk-react": minor
---

Prevent useSignal from erroring out during SSR by passing an optional getServerSnapshot function or the signal itself to useSyncExternalStore
19 changes: 14 additions & 5 deletions packages/sdk-react/src/useSignal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,19 @@ import { useSyncExternalStore } from 'react';
/**
* Returns the underlying signal value updating it each time the signal value changes.
* @param signal - a signal.
* @param getServerSnapshot - an optional function returning the signal value snapshot. It is used only during SSR
* to provide an initial value of the signal. When not set, defaults to the signal itself.
*/
export function useSignal<T>(signal: {
(): T;
sub(fn: VoidFunction): VoidFunction;
}): T {
return useSyncExternalStore((onStoreChange) => signal.sub(onStoreChange), signal);
export function useSignal<T>(
signal: {
(): T;
sub(fn: VoidFunction): VoidFunction;
},
getServerSnapshot?: () => T
): T {
return useSyncExternalStore(
(onStoreChange) => signal.sub(onStoreChange),
signal,
getServerSnapshot || signal
);
}