lineupCode関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The text that puts the size line-up in a page, for each way a page is made, as embedCode does for a single body: a script tag, an ES module, React, Vue, Angular, Svelte or an iframe of the demo's embed.html.
Every way is built, parsed or run by the package's tests.
インポート
import { lineupCode } from "@johnmorrisdotca/wakusei-planets";定義
function lineupCode(options: LineupEmbed, kind?: EmbedKind, settings?: EmbedSettings): string引数
| 名前 | 型 | 説明 |
|---|---|---|
options | LineupEmbed | The stars, the planets, the layout, where the camera starts and the width. |
kind (省略可) | "html" | "iframe" | "module" | "react" | "vue" | "angular" | "svelte" | The way the page is made; |
settings (省略可) | EmbedSettings | The CDN and the demo's address, when they are not the package's own. |
戻り値
string
The text to paste into the page's source.
例
import { lineupCode } from "@johnmorrisdotca/wakusei-planets";
console.log(lineupCode({ stars: "largest", at: "vy-canis-majoris" }, "react"));import { useEffect } from "react";
export function Lineup() {
useEffect(() => {
// The element needs a browser, so it is imported in an effect, never at the top of the file.
void import("@johnmorrisdotca/wakusei-planets/lineup");
}, []);
return <wakusei-lineup stars="largest" at="vy-canis-majoris" />;
}出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。