IBracketCompetitor

interface
Data & Models

A single competitor or team in a bracket match — intentionally generic (no sport/e-sport-specific distinction). Consumers can stash any extra payload under metadata.

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 to detect the winner via winnerId.
name
required
string
Display name (team name, player tag, …).
seed
number
Optional seed number (1 = top seed). Rendered before the name when showSeed is enabled.
avatar
string
Optional avatar URL (team logo, country flag, player portrait). Rendered as a small <img> left of the name.
metadata
Record<string, unknown>
Free-form payload — never read by the component.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Creating a competitor object

typescript