IBracketRound

interface
Data & Models

A round (column in horizontal mode, row in vertical mode) of the tournament tree. Title is required — OrigamBracket renders it above/beside the matches list. The side property is only meaningful for double-elimination.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

id
required
string | number
Stable identifier — used as key and in slot scopes.
title
required
string
Pre-translated label ("Quarter-finals", "Semi-finals", "Final"). The component does not call useT.
matches
required
IBracketMatch[]
Ordered list of matches that belong to this round.
side
TBracketRoundSide
Optional bracket-side marker for double-elimination layouts. Drives grouping into Winner/Loser Bracket/Grand Final sections.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Defining a semi-final round

typescript