React

import { NexusProvider, useNexus } from '@inverge/nexus/react'

NexusProviderPropsCopy Anchor Link

clientCopy Anchor Link

client?: Nexus

Provide either a ready instance, or a config to init one.

configCopy Anchor Link

config?: NexusConfig

childrenCopy Anchor Link

children: React.ReactNode

FunctionsCopy Anchor Link

NexusProvider()Copy Anchor Link

NexusProvider({ client, config, children }: NexusProviderProps): React.ReactElement

Provides a Nexus instance to the tree. Pass a config to auto-init, or a client you created yourself.

Parameters

Returns React.ReactElement

useNexus()Copy Anchor Link

useNexus(): Nexus

The Nexus instance from context (falls back to the global singleton).

Returns Nexus

useTrackEvent()Copy Anchor Link

useTrackEvent(): (name: string, properties?: Record<string, unknown>) => void

Track an event with a stable callback.

Returns (name: string, properties?: Record<string, unknown>) => void

useFlag()Copy Anchor Link

useFlag(key: string): boolean

Whether a feature flag is enabled (call nexus.flags.load() first).

Parameters

Returns boolean

useRemoteConfig()Copy Anchor Link

useRemoteConfig(): Nexus['remoteConfig']

Subscribe to Remote Config; re-renders when the config changes. Returns the service so you can call getString/getBool/…

Returns Nexus['remoteConfig']

useRemoteConfigValue()Copy Anchor Link

useRemoteConfigValue<T = unknown>(key: string, fallback?: T): T

A single Remote Config value, re-rendered on change.

Parameters

Returns T