IBracketProps
interface
Component Props
Props for <OrigamBracket> — a tournament tree renderer supporting single-elimination, double-elimination and round-robin layouts. Purely presentational: accepts immutable rounds and emits interaction events.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- roundsrequiredIBracketRound[]
- Required. Pre-ordered list of rounds — from earliest (round-of-16) to final for single-elimination.
- variantTBracketVariant'single-elimination'
- Tournament shape. Round-robin renders a NxN matrix instead of a tree.
- direction'horizontal' | 'vertical''horizontal'
- Layout axis. Horizontal stacks rounds as columns. Vertical stacks rounds as rows.
- showRoundTitlesbooleantrue
- Toggle round headers.
- showScoresbooleantrue
- Toggle the score column on each competitor row.
- showSeedbooleanfalse
- Toggle the seed prefix on competitor names.
- interactivebooleantrue
- Whether match cards should be interactive (cursor, hover, keyboard focus).
- winnersLabelstring'Winners bracket'
- Heading shown above the winner-bracket tree in a double-elimination layout.
- losersLabelstring'Losers bracket'
- Heading shown above the loser-bracket tree in a double-elimination layout.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Single-elimination bracket