BracketRound

Data Display
stable

Renders a single round column (horizontal mode) or row (vertical mode) of a tournament bracket, containing its OrigamBracketMatch cards.

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

Anatomy of OrigamBracketRoundSchematic of the BracketRound column with 3 numbered parts. SEMI-FINALS Match card 1 Match card 2 1 2 3
Anatomy of <origam-bracket-round> — 3 parts: root column, round title heading and match list.
1.origam-bracket-round
Root flex column container. role="group" with aria-labelledby pointing to the title. Direction modifier switches to row for vertical mode.
2.origam-bracket-round__title
Round title

. Visible only when showRoundTitle=true. Gets a computed id for aria-labelledby.

3.origam-bracket-round__matches
Flex column container for match cards. justify-content: space-around distributes matches evenly. Gap driven by --origam-bracket-round---match-gap.

API

Props

All props accepted by this component, with their type, default value and description.

round
required
IBracketRound
Round payload containing id, title, matches array and optional side (winner/loser for double-elimination).
index
required
number
Zero-based index of this round within the bracket. Used to compute isFinalRound.
totalRounds
required
number
Total number of rounds in the bracket. Used together with index to flag the last round as the final.
showRoundTitle
boolean
true
Toggles the round title <h3> heading above the match list.
showScores
boolean
true
Forwarded to OrigamBracketMatch to toggle the score column.
showSeed
boolean
false
Forwarded to OrigamBracketMatch to toggle the seed prefix.
interactive
boolean
true
Forwarded to OrigamBracketMatch to toggle match-card interactivity.
color
'primary'
Intent color forwarded to OrigamBracketMatch cards.
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
tag
string
'div'
HTML element rendered as the round container root.
direction
'horizontal'
Layout direction. horizontal = column of matches (single-elimination); vertical = row of matches.
fontSize
TFontSize
fontWeight
TFontWeight
letterSpacing
TLetterSpacing

API

Slots

Content slots exposed by this component.

#round-title
Override the round title content. Receives the round data and its index.
#match
Override the rendering of each match. Receives match data, round and isFinal flag.
#competitor

API

Emits

Events emitted by this component.

@match-click
IBracketMatch, MouseEvent
Bubbled from OrigamBracketMatch when the match card is clicked (not inside a competitor row).
@competitor-click
IBracketCompetitor, IBracketMatch, 'A' | 'B', MouseEvent | KeyboardEvent
Bubbled from OrigamBracketMatch when a competitor row is clicked.
@winner-click
IBracketCompetitor, IBracketMatch, MouseEvent | KeyboardEvent
Bubbled from OrigamBracketMatch when the winner competitor row is clicked.

API

Exposed members

Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.

<T extends object>(props: T, exclude?: string[]) => Partial<T>
Utility to forward a filtered subset of props to a child component.

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

Bottom margin below the round title.
Font size of the round title.
Font weight of the round title.
Letter spacing of the round title.
Text transform of the round title. Default uppercase.
Gap between match cards in the round.

Inclusion

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

ARIA roles

group

Keyboard interactions

Keyboard interactions
KeyAction
TabMoves focus through each match card within the round.

Notes

  • The round container has aria-labelledby pointing to the title element id when showRoundTitle=true, giving screen readers the round name context.
  • The final round (last in the bracket) receives the --final modifier class. Consumers can use this for additional ARIA live-region announcements.

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

This is an internal sub-part: it is injected by its parent component and cannot render on its own. See the parent component page for a live example.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Standalone round

vue

Ecosystem

Family

Components from the same folder that share conventions and often compose together.