Reference · Draw a bracket, a table or a road to the final
drawBracketfunction
Draws a bracket as an SVG string. input is a list of matchups, { matchups, teams } or a layout from layoutBracket.
The same input and options always give the same string: no clock, no random number, no counter.
Import it
import { drawBracket } from "@johnmorrisdotca/taisen-brackets";
Definition
function drawBracket(input: BracketLayout | readonly Matchup[] | BracketInput, options?: DrawOptions): string
Parameters
| Name | Type | Description |
|---|---|---|
input | readonly Matchup[] | BracketInput | BracketLayout | The matchups, a |
options (optional) | DrawOptions | The look, size, theme, language, background and everything else a drawing can be told. |
Returns
string
The SVG, a string that begins with <svg, with its own style and no script.
Examples
import { drawBracket } from "@johnmorrisdotca/taisen-brackets";
const svg = drawBracket([{ sides: ["Aurora", "Harbour"], score: [2, 1] }, { sides: ["Cascade", "Delta"], score: [0, 1] }, { sides: ["Aurora", "Delta"], score: [3, 1] }], { theme: "dark", size: "square" });
console.log(svg.startsWith("<svg"));trueWhat it prints (run when this page was built)