Function: useDomainRelations()

function useDomainRelations(
   stack, 
   domainName, 
   query): object;

Defined in: react/src/hooks/domain.ts:317

Hook to retrieve relation documents for a specific domain. Maintains a real-time list of relations matching the query.

Parameters

Parameter	Type	Description
stack	string	The name of the stack.
domainName	string	The domain name to fetch relations for.
query	{ }	Optional Mango selector to filter relations.

Returns

object

Object containing the list of relation documents, loading state, and error.

Name	Type	Defined in
docs	RelationDocument[]	react/src/hooks/domain.ts:437
error	null	react/src/hooks/domain.ts:437
loading	boolean	react/src/hooks/domain.ts:437

Example

const ProjectTasks = () => {
    const { docs, loading } = useDomainRelations('my-stack', 'ProjectTasks', {
        sourceId: { $eq: 'Project-123' }
    });
    
    if (loading) return <div>Loading...</div>;
    
    return (
        <ul>
            {docs.map(rel => (
                <li key={rel._id}>Linked Task: {rel.targetId}</li>
            ))}
        </ul>
    );
};