This is the collection of relationships hooks within the ui-react
module. There are 8 relationships hooks in total.
useLinkedRowIds
The useLinkedRowIds
hook gets the linked Row
Ids
for a given Row
in a linked list Relationship
, and registers a listener so that any changes to that result will cause a re-render.
useLinkedRowIdsListener
The useLinkedRowIdsListener
hook registers a listener function with the Relationships
object that will be called whenever the linked Row
Ids
in a Relationship
change.
useLocalRowIds
The useLocalRowIds
hook gets the local Row
Ids
for a given remote Row
in a Relationship
, and registers a listener so that any changes to that result will cause a re-render.
useLocalRowIdsListener
The useLocalRowIdsListener
hook registers a listener function with the Relationships
object that will be called whenever the local Row
Ids
in a Relationship
change.
useRemoteRowId
The useRemoteRowId
hook gets the remote Row
Id
for a given local Row
in a Relationship
, and registers a listener so that any changes to that result will cause a re-render.
useRemoteRowIdListener
The useRemoteRowIdListener
hook registers a listener function with the Relationships
object that will be called whenever a remote Row
Id
in a Relationship
changes.
useCreateRelationships
The useCreateRelationships
hook is used to create a Relationships
object within a React application with convenient memoization.
useRelationships
The useRelationships
hook is used to get a reference to a Relationships
object from within a Provider
component context.