@json-render/image

JSON スペックを Satori を使用して SVG および PNG 画像に変換する画像レンダラー。

クイックスタート

import { renderToPng } from "@json-render/image/render";
import type { Spec } from "@json-render/core";

const spec: Spec = {
  root: "frame",
  elements: {
    frame: {
      type: "Frame",
      props: { width: 1200, height: 630, backgroundColor: "#1a1a2e" },
      children: ["heading"],
    },
    heading: {
      type: "Heading",
      props: { text: "Hello World", level: "h1", color: "#ffffff" },
      children: [],
    },
  },
};

const png = await renderToPng(spec, {
  fonts: [{ name: "Inter", data: fontData, weight: 400, style: "normal" }],
});

標準コンポーネントの使用

import { defineCatalog } from "@json-render/core";
import { schema, standardComponentDefinitions } from "@json-render/image";

export const imageCatalog = defineCatalog(schema, {
  components: standardComponentDefinitions,
});

カスタムコンポーネントの追加

import { z } from "zod";

const catalog = defineCatalog(schema, {
  components: {
    ...standardComponentDefinitions,
    Badge: {
      props: z.object({ label: z.string(), color: z.string().nullable() }),
      slots: [],
      description: "A colored badge label",
    },
  },
});

標準コンポーネント

コンポーネント	カテゴリ	説明
Frame	ルート	ルートコンテナ。幅、高さ、背景を定義。ルートである必要があります。
Box	レイアウト	パディング、マージン、ボーダー、絶対位置を持つコンテナ
Row	レイアウト	水平 flex レイアウト
Column	レイアウト	垂直 flex レイアウト
Heading	コンテンツ	h1-h4 見出しテキスト
Text	コンテンツ	フルスタイリング機能付きのボディテキスト
Image	コンテンツ	URL からの画像
Divider	装飾	水平線区切り
Spacer	装飾	空の垂直スペース

主なエクスポート

エクスポート	目的
renderToSvg	スペックを SVG 文字列にレンダリング
renderToPng	スペックを PNG バッファにレンダリング (@resvg/resvg-js が必要)
schema	画像要素スキーマ
standardComponents	事前構築されたコンポーネントレジストリ
standardComponentDefinitions	AI プロンプト用のカタログ定義

サブパスエクスポート

エクスポート	説明
@json-render/image	フルパッケージ: スキーマ、コンポーネント、レンダリング関数
@json-render/image/server	スキーマとカタログ定義のみ (React/Satori なし)
@json-render/image/catalog	標準コンポーネント定義とタイプ
@json-render/image/render	レンダリング関数のみ