本文へ移動

Hata旗

国や地域の旗を読み込み、対応する表示の形を選び、絵ごとの資料・作者・ライセンスを保てます。

「旗（はた）」は、旗を表す日本語です。 名前について（英語）

目次

リファレンス · 必要なときの旗の読み込み

flagDataUri関数

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

A flag as a data: URI by its code, loaded when asked for: ready for an <img src> or a CSS url().

インポート

import { flagDataUri } from "@johnmorrisdotca/hata/load";

定義

function flagDataUri(code: string, options?: FlagOptions): Promise<string | null>

引数

名前型説明
codestring

A flag's code, in any case.

options (省略可)FlagOptions | undefined

How to frame it first, as for frame(), and which variant; the flag as it is when left out.

戻り値

Promise<string | null>

A promise of data:image/svg+xml,…, or of null when the code has no flag here.

例

import { flagDataUri } from "@johnmorrisdotca/hata/load";

const previewImage=document.createElement("img");
previewImage.src = (await flagDataUri("US-TX", { shape: "4:3" })) ?? "";

ソースを見るGitHub で編集@johnmorrisdotca/hata 1.6.0 のソースから作成しました。

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