Interface Config

An optional config to provide to brackets-viewer.js

Hierarchy

  • Config

Properties

onMatchClick? onMatchLabelClick? customRoundName? selector? participantOriginPlacement? separatedChildCountLabel? showSlotsOrigin? showLowerBracketSlotsOrigin? showPopoverOnMatchLabelClick? highlightParticipantOnHover? showRankingTable? clear?

Properties

Optional onMatchClick

onMatchClick?: MatchClickCallback

A callback to be called when a match is clicked.

Optional onMatchLabelClick

onMatchLabelClick?: MatchClickCallback

A callback to be called when a match's label is clicked.

Optional customRoundName

customRoundName?: ((...args) => undefined | string)

Type declaration

    • (...args): undefined | string

    • A function to deeply customize the names of the rounds. If you just want to translate some words, please use addLocale() instead.

      Parameters

      • Rest ...args: [info: RoundNameInfo, t: (<Scope, SubKey, T>(key, options?) => T["returnObjects"] extends true
            ? StringMap
            : string)]

      Returns undefined | string

Optional selector

selector?: string

An optional selector to select the root element.

Optional participantOriginPlacement

participantOriginPlacement?: Placement

Where the position of a participant is placed relative to its name.

  • If none, the position is not added.
  • If before, the position is prepended before the participant name. "#1 Team"
  • If after, the position is appended after the participant name, in parentheses. "Team (#1)"

Optional separatedChildCountLabel

separatedChildCountLabel?: boolean

Whether to show the child count of a BoX match separately in the match label.

  • If false, the match label and the child count are in the same place. (Example: "M1.1, Bo3")
  • If true, the match label and the child count are in an opposite place. (Example: "M1.1 (right-->) Bo3")

Optional showSlotsOrigin

showSlotsOrigin?: boolean

Whether to show the origin of a slot (wherever possible).

Optional showLowerBracketSlotsOrigin

showLowerBracketSlotsOrigin?: boolean

Whether to show the origin of a slot (in the lower bracket of an elimination stage).

Optional showPopoverOnMatchLabelClick

showPopoverOnMatchLabelClick?: boolean

Display a popover when the label of a match with child games is clicked.

Optional highlightParticipantOnHover

highlightParticipantOnHover?: boolean

Whether to highlight every instance of a participant on hover.

Optional showRankingTable

showRankingTable?: boolean

Whether to show a ranking table on round-robin stages.

Optional clear

clear?: boolean

Whether to clear any previously displayed data.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc