`BoardOptions`型

リファレンスの説明と例は英語です。見出しと目次は日本語です。

What every board takes.

インポート

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

定義

interface BoardOptions {
    size?: BoardSizeName | {
        width: number;
        height: number;
    };
    theme?: "auto" | "light" | "dark";
    flags?: DrawOptions["flags"];
    flagHref?: DrawOptions["flagHref"];
    flagShape?: "round" | "square";
    locale?: string | Locale;
    words?: Partial<Words>;
    title?: string;
    id?: string;
    className?: string;
}

メンバー

名前	型	説明
`size` (省略可)	`BoardSizeName \| { width: number; height: number; } \| undefined`	One of `BOARD_SIZES` (`tv` by default), or a size of your own, `{ width, height }`, at least 200 each way.
`theme` (省略可)	`"auto" \| "light" \| "dark" \| undefined`	`auto` (the default) follows the page's light or dark, `light` and `dark` fix it.
`flags` (省略可)	`FlagRenderer \| undefined`	Draws a flag from its code, as for `drawBracket`: a synchronous function from a code (`CA-BC`, `JP`) and `{ shape, size, theme }` to an SVG string, such as one made from `@johnmorrisdotca/hata`.
`flagHref` (省略可)	`((code: string) => string \| null \| undefined) \| undefined`	The address of a flag as a picture to load, tried where `flags` gives none.
`flagShape` (省略可)	`"round" \| "square" \| undefined`	`round` (the default) or `square`: the shape a flag is asked for and drawn in.
`locale` (省略可)	`string \| Locale \| undefined`	The language: `en`, `fr`, `ja`, `es`, `de` or a `Locale`.
`words` (省略可)	`Partial<Words> \| undefined`
`title` (省略可)	`string \| undefined`	The `<title>` of the drawing. Default: the board's own heading.
`id` (省略可)	`string \| undefined`	Prefix for the drawing's ids. Default: a hash of the state and the options.
`className` (省略可)	`string \| undefined`

例

import { rankingList, type BoardOptions } from "@johnmorrisdotca/taisen-brackets";

const board: BoardOptions = { size: "tablet", theme: "dark", flagShape: "square", locale: "fr" };
console.log(rankingList({ entries: [{ name: "A", points: 1 }] }, board).startsWith("<svg"));

true

出力（このページを作ったときに実行した結果）

ソースを見る GitHub で編集@johnmorrisdotca/taisen-brackets 0.20.0 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。

BoardOptions型

定義

メンバー

例

`BoardOptions`型