Reference · Draw a bracket, a table or a road to the final
JudoQueueOptionstype
What a mat queue can be told: the size, the theme, how many rows, whether the first contest is marked as the current one, and the mat colours.
Import it
import type { JudoQueueOptions } from "@johnmorrisdotca/taisen-brackets";
Definition
interface JudoQueueOptions extends Omit<JudoBoardOptions, "style" | "coaches"> {
rows?: number;
current?: boolean;
colors?: readonly string[];
}
Members
| Name | Type | Description |
|---|---|---|
rows (optional) | number | undefined | The most contests drawn for a mat. Default: as many as fit at a readable size, up to 12. |
current (optional) | boolean | undefined | Show the first contest of each mat as the one on now (a green number). Default true. |
colors (optional) | readonly string[] | undefined | The colours the mats take in turn where a mat names none. Hex codes. |
title (optional) | string | undefined | The |
locale (optional) | string | Locale | undefined | The language: |
words (optional) | Partial<Words> | undefined | |
flags (optional) | FlagRenderer | undefined | Draws a country's flag from its code, as for |
flagHref (optional) | ((code: string) => string | null | undefined) | undefined | The address of a flag as a picture to load, tried where |
theme (optional) | "auto" | "light" | "dark" | undefined |
|
id (optional) | string | undefined | Prefix for the drawing's ids. Default: a hash of the state and the options. |
className (optional) | string | undefined | |
size (optional) | JudoBoardSizeName | { width: number; height: number; } | undefined |
|
swap (optional) | boolean | undefined | Draw blue first (on the left, or at the top) in place of white. Default false. |
Examples
import { judoMatQueue, type JudoQueueOptions } from "@johnmorrisdotca/taisen-brackets";
const options: JudoQueueOptions = { size: "tv", theme: "dark", rows: 4, current: true };
console.log(judoMatQueue({ mat: 1, contests: [{ number: 1, white: { name: "A" }, blue: { name: "B" } }] }, options).startsWith("<svg"));trueWhat it prints (run when this page was built)