Use entity list actions

Overview

useEntityListActions provides the low-level Redux-backed actions that power useEntityList. In most cases you should use useEntityList directly. Use this hook when you need to trigger fetch, create, or delete operations from a component that is separate from the one consuming the list state.

Usage Example

import { useEntityListActions } from "@sublay/react-js";

function RefreshButton() {
  const { fetchEntities } = useEntityListActions();

  const handleRefresh = async () => {
    await fetchEntities("my-feed", {
      page: 1,
      sortBy: "hot",
      limit: 20,
    });
  };

  return <button onClick={handleRefresh}>Refresh</button>;
}

Return Values

(listId: string, options: FetchEntitiesOptions) => Promise<Entity[] | null>

Fetches a page of entities and dispatches the result into the Redux list state.

Show FetchEntitiesOptions

number

required

Page number (1-indexed).

"createdAt" | "hot" | "top" | "controversial" | "metadata.field"

required

Sort algorithm. See Fetching Entities for options.

number

required

Results per page.

Which reaction top ranks by. Only sent while sortBy is "top".

"asc" | "desc"

Sort direction.

"auto" | "numeric" | "text" | "boolean" | "timestamp"

Type hint for metadata sorts.

string

Filter by source ID.

string

Filter by space ID.

string

Filter by user ID.

boolean

Only show entities from followed users.

"day" | "week" | "month" | "year"

Time window filter.

Populate related data.

number | null

With "topComments" included: top comments per entity (server default 1, max 5).

ReactionType | null

With "topComments" included: the reaction whose raw count ranks them (server default "upvote").

KeywordsFilters

Filter by keywords.

TitleFilters

Filter by title content.

ContentFilters

Filter by body content.

AttachmentsFilters

Filter by attachments.

LocationFilters

Filter by geographic proximity.

MetadataFilters

Filter by metadata fields.

(listId: string, options: CreateEntityOptions) => Promise<Entity | undefined>

Creates an entity and inserts it into the specified list.

(listId: string, options: { entityId: string }) => Promise<void>

Deletes an entity and removes it from the specified list.

Overview

Auth Hooks

Current User

User Profiles

Entities

Entity Lists

Spaces

Spaces — Rules

Space Lists

Workspaces

Events

Comments

Reactions

Reputation

Follows

Connections

Blocks

Collections

App Notifications

Push Notifications

Chat — Conversations

Chat — Messages

Chat — Core

Search

Reports

Storage

Crypto

Project

Custom Tables

Overview

Usage Example

Return Values

​Overview

​Usage Example

​Return Values

Overview

Usage Example

Return Values