Upgrade to v1

v1 is the first stable release. Releases within v1.x stay backward compatible under semver. To move on from v1, see Upgrade to v2.

InstallCopy Anchor Link

npm i takumi-js@1

Breaking changes at a glanceCopy Anchor Link

TemplatesCopy Anchor Link

display defaults to inlineCopy Anchor Link

Early Takumi defaulted display to flex. v1 defaults to inline, as the CSS specification does, so components written for the web, including LLM-generated ones, lay out as expected.

Add display: flex, or the flex Tailwind class, to every container that needs flexbox.

<div
  style={{
    display: "flex",
    alignItems: "center",
    justifyContent: "center",
  }}
>
  {/* Your content here */}
</div>

JavaScript / TypeScriptCopy Anchor Link

Unified runtime detection and fallbackCopy Anchor Link

takumi-js now picks the right bindings for your environment, such as Node.js or Workers. You no longer import the NAPI (native Node addon) or WASM (WebAssembly) bindings directly.

import { ImageResponse } from "@takumi-rs/image-response"; 
import { ImageResponse } from "takumi-js/response"; 

emoji option for dynamic emoji loadingCopy Anchor Link

takumi-js adds an emoji option that selects the emoji provider, matching Next.js's ImageResponse API. It defaults to twemoji. To draw emoji from a font instead, set it to from-font and include an emoji font in fonts.

See Images & emoji.

import { ImageResponse } from "takumi-js/response";
import notoEmojiFont from "@fontsource/noto-color-emoji/files/noto-color-emoji-emoji-400-normal.woff2";

export function GET() {
  return new ImageResponse(<div>It works! 😀</div>, {
    emoji: "from-font", 
    fonts: [
      {
        name: "Noto Color Emoji",
        data: notoEmojiFont,
      },
    ],
  });
}

Lowercase image formatsCopy Anchor Link

Image format options in @takumi-rs/core now take lowercase strings only.

const image = await renderer.render(node, {
  format: "WebP"
  format: "webp"
});

putPersistentImage() takes ImageSourceCopy Anchor Link

renderer.putPersistentImage() no longer accepts a raw Buffer as the second argument. Pass an ImageSource object instead.

const data = await readFile("foo.png");

await renderer.putPersistentImage("foo.png", data); 
await renderer.putPersistentImage({ src: "foo.png", data }); 

Deprecated exports removedCopy Anchor Link

v1 removes all previously deprecated exports from @takumi-rs/core.

RustCopy Anchor Link

RenderOptions::builder() replaces RenderOptionsBuilderCopy Anchor Link

The standalone RenderOptionsBuilder struct is removed. Call RenderOptions::builder() instead. It uses typed-builder, which checks required fields at compile time, so build() needs no .unwrap().

let options = RenderOptionsBuilder::default().build().unwrap(); 
let options = RenderOptions::builder().build(); 

Viewport constructor parameter changeCopy Anchor Link

Viewport no longer implements From<(u32, u32)>. Use the explicit constructor.

let viewport = (800_u32, 600_u32).into(); 
let viewport = Viewport::new((800, 600)); 

Removed Rust APIsCopy Anchor Link

use takumi::TakumiError; 
use takumi::prelude::Error; 

Full changelogCopy Anchor Link

For every change, see the releases.