Skip to the content

Taisen Brackets対戦

Knockout brackets as SVG, from a list of ties.

Taisen (対戦, たいせん) is Japanese for a matchup: two sides facing each other. About the name

Contents

Reference · Draw a bracket, a table or a road to the final

BroadcastOptionstype

What every broadcast board takes: the width, the look, the icon, the flags, the language, a title and an id.

Import it

import type { BroadcastOptions } from "@johnmorrisdotca/taisen-brackets";

Definition

interface BroadcastOptions {
    width?: number;
    look?: BroadcastLook;
    icon?: BroadcastIcon;
    iconMark?: string;
    flags?: DrawOptions["flags"];
    flagHref?: DrawOptions["flagHref"];
    locale?: string | Locale;
    words?: Partial<Words>;
    title?: string;
    id?: string;
    className?: string;
}

Members

NameTypeDescription
width (optional)number | undefined

The width of the board; the height follows from the rows. Default 1280, from 320 to 4000.

look (optional)BroadcastLook | undefined

blue (the default), night or paper.

icon (optional)BroadcastIcon | undefined

The icon in the square at the left of the title: medal (the default), stopwatch, none, or an iconMark of your own.

iconMark (optional)string | undefined

A mark of your own for that square (inline SVG or an image address), in place of icon.

flags (optional)FlagRenderer | undefined

Draws a flag from its code, as for drawBracket; it is asked for the shape rect (Hata's "4:3").

flagHref (optional)((code: string) => string | null | undefined) | undefined

The address of a flag as a picture to load, tried where flags gives none.

locale (optional)string | Locale | undefined
words (optional)Partial<Words> | undefined
title (optional)string | undefined

The <title> of the drawing. Default: the board's own heading.

id (optional)string | undefined
className (optional)string | undefined

Examples

import { resultsBoard, type BroadcastOptions } from "@johnmorrisdotca/taisen-brackets";

const options: BroadcastOptions = { width: 1280, look: "blue", icon: "medal", locale: "ja" };
console.log(resultsBoard({ title: "Final", rows: [{ name: "A" }] }, options).startsWith("<svg"));
true

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/taisen-brackets 0.20.0.