import { BranchPickerPrimitiveNextProps, BranchPickerPrimitivePreviousProps, BranchPickerPrimitiveRootProps } from "@/generated/typeDocs";
import { BranchPickerPrimitive as BranchPickerPrimitiveDocs } from "@/generated/primitiveDocs";

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

For examples and usage patterns, see BranchPicker.

{/* api-manual */}

Anatomy#

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

const BranchPicker = () => (
  <BranchPickerPrimitive.Root>
    <BranchPickerPrimitive.Previous />
    <BranchPickerPrimitive.Number /> / <BranchPickerPrimitive.Count />
    <BranchPickerPrimitive.Next />
  </BranchPickerPrimitive.Root>
);

{/* api-manual */}

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

API Reference#

Root#

{BranchPickerPrimitiveDocs.Root?.deprecated && (

Deprecated. {BranchPickerPrimitiveDocs.Root.deprecated}

)}

{BranchPickerPrimitiveDocs.Root?.description}

{BranchPickerPrimitiveDocs.Root?.element && (

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

<BranchPickerPrimitive.Root hideWhenSingleBranch={true}>
  <BranchPickerPrimitive.Previous />
  <BranchPickerPrimitive.Count />
  <BranchPickerPrimitive.Next />
</BranchPickerPrimitive.Root>

<ParametersTable {...BranchPickerPrimitiveRootProps} />

Next#

{BranchPickerPrimitiveDocs.Next?.deprecated && (

Deprecated. {BranchPickerPrimitiveDocs.Next.deprecated}

)}

{BranchPickerPrimitiveDocs.Next?.description}

{BranchPickerPrimitiveDocs.Next?.element && (

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

<BranchPickerPrimitive.Next>
  Next →
</BranchPickerPrimitive.Next>

<ParametersTable {...BranchPickerPrimitiveNextProps} />

Previous#

{BranchPickerPrimitiveDocs.Previous?.deprecated && (

Deprecated. {BranchPickerPrimitiveDocs.Previous.deprecated}

)}

{BranchPickerPrimitiveDocs.Previous?.description}

{BranchPickerPrimitiveDocs.Previous?.element && (

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

<BranchPickerPrimitive.Previous>
  ← Previous
</BranchPickerPrimitive.Previous>

<ParametersTable {...BranchPickerPrimitivePreviousProps} />

Count#

{BranchPickerPrimitiveDocs.Count?.deprecated && (

Deprecated. {BranchPickerPrimitiveDocs.Count.deprecated}

)}

{BranchPickerPrimitiveDocs.Count?.description}

{BranchPickerPrimitiveDocs.Count?.element && (

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

<div>
  Branch <BranchPickerPrimitive.Count /> of {totalBranches}
</div>

{BranchPickerPrimitiveDocs.Count?.props && (

)}

Number#

{BranchPickerPrimitiveDocs.Number?.deprecated && (

Deprecated. {BranchPickerPrimitiveDocs.Number.deprecated}

)}

{BranchPickerPrimitiveDocs.Number?.description}

{BranchPickerPrimitiveDocs.Number?.element && (

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

{BranchPickerPrimitiveDocs.Number?.props && (

)}
{/* api-reference */}