medplum / medplum / 21969915900

92%

main: 92%

push

github

docs: Add lifecycle hooks documentation to useSubscription (#8422)

* Add lifecycle hooks documentation to useSubscription

Document the four lifecycle hooks (onWebSocketOpen, onWebSocketClose,
onSubscriptionConnect, onSubscriptionDisconnect) available in the
useSubscription hook. Includes explanation of when to use them for
handling reconnection scenarios and catching up on missed events,
particularly useful for mobile applications.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Rahul Agarwal <rahul@medplum.com>

* docs: Simplify lifecycle hooks example and add WebSocket clarification

- Simplified code example to focus on core use cases (connection indicator + search refresh)
- Added clarification about two separate concepts: WebSocket connection (one per client) vs Subscriptions (multiple per connection)
- Converted to .mdx and switched to MedplumCodeBlock component
- Updated wording to be more concise

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Signed-off-by: Rahul Agarwal <rahul@medplum.com>

* docs: Use compilable example code for useSubscription lifecycle hooks

Move the lifecycle hooks example to packages/examples/src/react/use-subscription.tsx
so the code is compiled and validated during build. This ensures the example
stays in sync with the actual API.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Rahul Agarwal <rahul@medplum.com>

* fix: Remove JSX.Element type annotation to fix build

The JSX namespace is not available without importing React in the new
JSX transform. Removing the return type annotation allows TypeScript
to infer the correct type.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Rahul Agarwal <rahul@medplum.com>

* fix: Add return type to LiveChatComponent and fix broken doc link

- Add ReactNode return type to LiveChatComponent to satisfy linting rules
- Fix broken markdown link from .md to .mdx extension
- Ensures CI linting and... (continued)

17140 of 19435 branches covered (88.19%)

Branch coverage included in aggregate %.

31272 of 33014 relevant lines covered (94.72%)

13742.34 hits per line