Synchronizer hooks
This is the collection of synchronizer hooks within the ui-react module. There are 6 synchronizer hooks in total.
useCreateSynchronizer
The useCreateSynchronizer hook is used to create a Synchronizer within a React application along with convenient memoization and callbacks.
useSynchronizer
The useSynchronizer hook is used to get a reference to a Synchronizer object from within a Provider component context.
useSynchronizerIds
The useSynchronizerIds hook is used to retrieve the Ids of all the named Synchronizer objects present in the current Provider component context.
useSynchronizerOrSynchronizerById
The useSynchronizerOrSynchronizerById hook is used to get a reference to a Synchronizer object from within a Provider component context, or have it passed directly to this hook.
useSynchronizerStatus
The useSynchronizerStatus hook returns a the status of a Synchronizer, and registers a listener so that any changes to it will cause a re-render.
useSynchronizerStatusListener
The useSynchronizerStatusListener hook registers a listener function with the Synchronizer that will be called when its status changes.