BroadcastOptions型
リファレンスの説明と例は英語です。見出しと目次は日本語です。
What every broadcast board takes: the width, the look, the icon, the flags, the language, a title and an id.
インポート
import type { BroadcastOptions } from "@johnmorrisdotca/taisen-brackets";定義
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;
}メンバー
| 名前 | 型 | 説明 |
|---|---|---|
width (省略可) | number | undefined | The width of the board; the height follows from the rows. Default 1280, from 320 to 4000. |
look (省略可) | BroadcastLook | undefined |
|
icon (省略可) | BroadcastIcon | undefined | The icon in the square at the left of the title: |
iconMark (省略可) | string | undefined | A mark of your own for that square (inline SVG or an image address), in place of |
flags (省略可) | FlagRenderer | undefined | Draws a flag from its code, as for |
flagHref (省略可) | ((code: string) => string | null | undefined) | undefined | The address of a flag as a picture to load, tried where |
locale (省略可) | string | Locale | undefined | |
words (省略可) | Partial<Words> | undefined | |
title (省略可) | string | undefined | The |
id (省略可) | string | undefined | |
className (省略可) | string | undefined |
例
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出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。