Fetch entity reactions

Fetch a paginated list of users who reacted to an entity

Overview

useFetchEntityReactions returns a function that fetches individual reaction records for an entity. Use this to show “who reacted” lists, optionally filtered by a specific reaction type.

Usage Example

import { useFetchEntityReactions } from "@sublay/react-js";
import { useState, useEffect } from "react";

function WhoUpvoted({ entityId }: { entityId: string }) {
  const fetchReactions = useFetchEntityReactions();
  const [reactions, setReactions] = useState([]);

  useEffect(() => {
    fetchReactions({ entityId, page: 1, reactionType: "upvote" }).then(
      (res) => setReactions(res.data)
    );
  }, [entityId]);

  return (
    <ul>
      {reactions.map((r) => <li key={r.id}>{r.user?.username}</li>)}
    </ul>
  );
}

Parameters

entityId · string · required

The entity to fetch reactions for.

page · number · required

Page number (1-indexed).

limit · number

Results per page. Default: 20.

reactionType · ReactionType

Filter to a specific reaction type.

sortDir · "asc" | "desc"

Sort direction by creation date. Default: "desc".

spaceReputationId · string

Resolves each reactor’s reputation into a spaceReputation number on the embedded user. Accepts a space <uuid>, "none" (project-general bucket), or "context" (server-derived from the request context). Empty string, "general", and null are rejected. See Reputation.

spaceReputationDescendants · boolean

When true, spaceReputation is the subtree sum (the space plus all its descendants). Only honored when spaceReputationId is an explicit <uuid>.

Returns

data · Reaction[]

Array of reaction records. Each includes id, userId, reactionType, targetId, targetType, createdAt. The user field is populated when user data is available; when spaceReputationId is set it carries an added spaceReputation number. See Reputation.

pagination · PaginationMetadata

Pagination metadata for the result set.

• page — current page number
• pageSize — number of results returned
• totalItems — total number of reactions matching the query
• totalPages — total number of pages
• hasMore — whether additional pages are available