Skip to content

Websockets Implementation for the Connecting screen#310

Draft
codingLogan wants to merge 7 commits intomasterfrom
lr/CTT-156
Draft

Websockets Implementation for the Connecting screen#310
codingLogan wants to merge 7 commits intomasterfrom
lr/CTT-156

Conversation

@codingLogan
Copy link
Copy Markdown
Collaborator

How the feature works

The hosting app does a lot of the heavy lifting and passes in what is required by the UI

  • Set up an Observable that will emit appropriate messages
    • members/updated
    • members/priority_data_ready
  • Set up a function that can return true when the socket connection is healthy.
  • Send in a feature flag value of true to enable the usage of the above Observable

How to pass the values into the UI package

In the consuming app, pass in a new prop object to the ConnectWidget named webSocketConnection

webSocketConnection={{
  isConnected: () => function that returns a boolean,
  webSocketMessages$: Observable,
}}

To enable the widget to use those values, you must also enable the useWebSockets experimental feature

experimentalFeatures={{
  ...other features
  useWebSockets: boolean,
}}

@codingLogan codingLogan self-assigned this Apr 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant