> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sublay.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Entity Votes

# `useEntityVotes`

## Overview

The `useEntityVotes` hook provides functionality to manage voting on an entity, including upvoting, downvoting, and removing votes. This hook is designed to handle optimistic updates to the entity’s state, ensuring a smooth user experience by immediately reflecting changes in the UI while making server requests in the background. It also supports callbacks for handling cases where a user is not logged in or does not have a username.

## Usage Example

```tsx theme={null}
import { useEntityVotes } from "@replyke/react-js";

function EntityVoteButtons({ entity, setEntity }: { entity: Entity; setEntity: React.Dispatch<React.SetStateAction<Entity>> }) {
  const {
    upvoteEntity,
    removeEntityUpvote,
    downvoteEntity,
    removeEntityDownvote,
  } = useEntityVotes({
    entity,
    setEntity,
  });

  return (
    <div>
      <button onClick={upvoteEntity}>Upvote</button>
      <button onClick={removeEntityUpvote}>Remove Upvote</button>
      <button onClick={downvoteEntity}>Downvote</button>
      <button onClick={removeEntityDownvote}>Remove Downvote</button>
    </div>
  );
}
```

## Parameters & Returns

### Parameters

The hook accepts an object with the following fields:

<ParamField path="entity" type="Entity | undefined" required>
  The current entity object.
</ParamField>

<ParamField path="setEntity" type="React.Dispatch<React.SetStateAction<Entity | undefined>>" required>
  Function to update the entity state in your component.
</ParamField>

### Returns

The hook returns an object containing the following functions:

<ResponseField name="upvoteEntity" type="function">
  Adds an upvote to the entity and updates the server.
</ResponseField>

<ResponseField name="removeEntityUpvote" type="function">
  Removes the user's upvote from the entity and updates the server.
</ResponseField>

<ResponseField name="downvoteEntity" type="function">
  Adds a downvote to the entity and updates the server.
</ResponseField>

<ResponseField name="removeEntityDownvote" type="function">
  Removes the user's downvote from the entity and updates the server.
</ResponseField>