`EmbedSettings`型

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

Where the embed code points: the address of the demo that holds embed.html, and the CDN folder the element loads from. Both default to this package's own.

インポート

import type { EmbedSettings } from "@johnmorrisdotca/uchusen-rockets";

定義

interface EmbedSettings {
    site?: string;
    cdn?: string;
    size?: number;
}

メンバー

名前	型	説明
`site` (省略可)	`string \| undefined`	The address of the published demo, where `embed.html` is.
`cdn` (省略可)	`string \| undefined`	The CDN or package path the element is loaded from.
`size` (省略可)	`number \| undefined`	Pixels across for the `iframe` (its largest width) and the `link` picture (its width; the height follows). 480 when left out.

例

import { embedCode, type EmbedSettings } from "@johnmorrisdotca/uchusen-rockets";

const settings: EmbedSettings = { site: "https://example.test/rockets/" };
console.log(embedCode({ rocket: "starship" }, "iframe", settings));

<iframe
  src="https://example.test/rockets/embed.html?rocket=starship"
  title="Rocket"
  loading="lazy"
  style="width:100%;max-width:480px;aspect-ratio:3 / 4;border:0"
></iframe>

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

ソースを見る GitHub で編集@johnmorrisdotca/uchusen-rockets 0.14.0 のソースから作成しました。

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

EmbedSettings型

定義

メンバー

例

`EmbedSettings`型