Documents
thread-list
thread-list
Type
External
Status
Published
Created
Mar 17, 2026
Updated
May 19, 2026
Updated by
Dosu Bot
Source
View

import { ThreadListPrimitiveItemByIndexProps, ThreadListPrimitiveItemsProps, ThreadListPrimitiveLoadMoreProps, ThreadListPrimitiveNewProps, ThreadListPrimitiveRootProps } from "@/generated/typeDocs";
import { ThreadListPrimitive as ThreadListPrimitiveDocs } from "@/generated/primitiveDocs";

{/* AUTO-GENERATED PAGE by scripts/generate-api-reference.mts /}
{/
Do not edit manually. */}

For examples and usage patterns, see ThreadList.

{/* api-manual */}

Anatomy#

import { ThreadListPrimitive } from "@assistant-ui/react";

const ThreadList = () => (
  <ThreadListPrimitive.Root>
    <ThreadListPrimitive.New />
    <ThreadListPrimitive.Items>
      {() => <MyThreadListItem />}
    </ThreadListPrimitive.Items>
  </ThreadListPrimitive.Root>
);

{/* api-manual */}

{/* api-reference /}
{/
AUTO-GENERATED by scripts/generate-api-reference.mts /}
{/
Do not edit this block manually. */}

API Reference#

Root#

{ThreadListPrimitiveDocs.Root?.deprecated && (

Deprecated. {ThreadListPrimitiveDocs.Root.deprecated}

)}

{ThreadListPrimitiveDocs.Root?.description}

{ThreadListPrimitiveDocs.Root?.element && (

This primitive renders a {`<${ThreadListPrimitiveDocs.Root?.element}>`} element unless asChild is set.

)}

<ParametersTable {...ThreadListPrimitiveRootProps} />

New#

{ThreadListPrimitiveDocs.New?.deprecated && (

Deprecated. {ThreadListPrimitiveDocs.New.deprecated}

)}

{ThreadListPrimitiveDocs.New?.description}

{ThreadListPrimitiveDocs.New?.element && (

This primitive renders a {`<${ThreadListPrimitiveDocs.New?.element}>`} element unless asChild is set.

)}

<ParametersTable {...ThreadListPrimitiveNewProps} />

{/* api-manual.New */}

Data attributeValues
[data-active]Present when the new-thread button represents the current fresh thread.
{/* api-manual.New */}

Items#

{ThreadListPrimitiveDocs.Items?.deprecated && (

Deprecated. {ThreadListPrimitiveDocs.Items.deprecated}

)}

{ThreadListPrimitiveDocs.Items?.description}

{ThreadListPrimitiveDocs.Items?.element && (

This primitive renders a {`<${ThreadListPrimitiveDocs.Items?.element}>`} element unless asChild is set.

)}

<ParametersTable {...ThreadListPrimitiveItemsProps} />

ItemByIndex#

{ThreadListPrimitiveDocs.ItemByIndex?.deprecated && (

Deprecated. {ThreadListPrimitiveDocs.ItemByIndex.deprecated}

)}

{ThreadListPrimitiveDocs.ItemByIndex?.description}

{ThreadListPrimitiveDocs.ItemByIndex?.element && (

This primitive renders a {`<${ThreadListPrimitiveDocs.ItemByIndex?.element}>`} element unless asChild is set.

)}

<ParametersTable {...ThreadListPrimitiveItemByIndexProps} />

LoadMore#

{ThreadListPrimitiveDocs.LoadMore?.deprecated && (

Deprecated. {ThreadListPrimitiveDocs.LoadMore.deprecated}

)}

{ThreadListPrimitiveDocs.LoadMore?.description}

{ThreadListPrimitiveDocs.LoadMore?.element && (

This primitive renders a {`<${ThreadListPrimitiveDocs.LoadMore?.element}>`} element unless asChild is set.

)}

<ParametersTable {...ThreadListPrimitiveLoadMoreProps} />
{/* api-reference */}