Skip to main content
Home
Browse packagesDocsSign in

@mizu/render@0.9.2
Built and signed on GitHub Actions

latest
lowlighter/mizu

🌊 Lightweight HTML templating library for any-side rendering

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
100%
Published
3 months ago (0.9.2)
class Mizu

Client side renderer.

Constructors

new
Client(options?: ClientOptions)

Client constructor.

Properties

readonly
context: Record<PropertyKey, any>

Rendering context.

All properties assigned to this object are available during rendering.

Changes to this object are reactive and will trigger a re-render of related elements. This is achieved using Context, which leverages Proxy handlers.

Note

You cannot reassign this property directly to ensure reactivity is maintained. To achieve a similar effect, use Object.assign().

Methods

flush(): Promise<void>

Flush the reactive render queue of Renderer.

render<T extends Arg<Renderer["render"]>>(
element?: T,
): Promise<T>

Start rendering all subtrees marked with the *mizu attribute.

const mizu = new Client({ context: { foo: "bar" } })
await mizu.render()

Static Properties

readonly
default: Client

Default Client instance.

defaults: Required<ClientOptions>

Default options for Client.

These default options are merged with the provided options when creating a new Client instance.

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@mizu/render

Import symbol

import { Mizu } from "@mizu/render/client";
or

Import directly with a jsr specifier

import { Mizu } from "jsr:@mizu/render/client";

Add Package

pnpm i jsr:@mizu/render
or (using pnpm 10.8 or older)
pnpm dlx jsr add @mizu/render

Import symbol

import { Mizu } from "@mizu/render/client";

Add Package

yarn add jsr:@mizu/render
or (using Yarn 4.8 or older)
yarn dlx jsr add @mizu/render

Import symbol

import { Mizu } from "@mizu/render/client";

Add Package

vlt install jsr:@mizu/render

Import symbol

import { Mizu } from "@mizu/render/client";

Add Package

npx jsr add @mizu/render

Import symbol

import { Mizu } from "@mizu/render/client";

Add Package

bunx jsr add @mizu/render

Import symbol

import { Mizu } from "@mizu/render/client";