Context providers

ClientsProvider#

React Context Provider, useful to provide clients. Allows underlying Components to communicate with their target server(s).

<ClientsProvider value={clients}>  {children}</ClientsProvider>

Provides whether the user has entered presentation mode. Allows the underlying Components to know whether they should show edition capabilities.

<IsPresentingProvider value={isPresenting}>  {children}</IsPresentingProvider>

Plugins Context provider. Necessary to define the widgets that can be displayed as well as all other types of plugins.

<PluginsProvider value={plugins}>  {children}</PluginsProvider>

Theme Context provider. Accepts a partial Theme and adds defaults where needed to provide a full one.

<ThemeProvider value={theme}>  {children}</ThemeProvider>

React Context Provider, useful to provide the UserGroupNames. Allows underlying components to access the provided user group names.

<UserGroupNamesProvider value={userGroupNames}>  {children}</UserGroupNamesProvider>

React Context Provider, useful to provide the UserNames. Allows underlying components to access the provided user names.

<UserNamesProvider value={userNames}>  {children}</UserNamesProvider>

React Context Provider, useful to provide the current User. Allows underlying components to access the current user's information.

<UserProvider value={user}>  {children}</UserProvider>

Allows to provide headers to be set on "REGISTER" and "UPDATE" websocket messages sent to Atoti Server and triggered by useQueryResult.

<WebsocketHeadersProvider value={websocketHeaders}>  {children}</WebsocketHeadersProvider>