framejs.io

Appearance

marimo ​

Use framejs frames as widgets in marimo notebooks with reactive bindings.

Installation ​

bash
pip install framejs

Formerly metaframe-widget

The framejs Python package was previously published as metaframe-widget (and the class as MetaframeWidget). Both old names still work, but new code should use framejs / Frame.

Basic usage ​

Wrap the widget with mo.ui.anywidget() to get reactive bindings:

python
import marimo as mo
from framejs import Frame

w = mo.ui.anywidget(Frame(url="https://framejs.app/j/f14d583125634c23851453c8038ddb7c", height="200px"))
w

The url can be any metaframe URL form:

python
# Raw / full URL — code inlined in the hash
Frame(url="https://framejs.io/#?js=...")

# Expiring snapshot — content-addressed, kept ~30 days (editor: "Create expiring snapshot")
Frame(url="https://framejs.io/j/<sha256>")

# Durable, editable frame — permanent (editor: "Save")
# framejs.io/j/<uuid> and framejs.app/j/<uuid> are equivalent
Frame(url="https://framejs.io/j/<uuid>")

Prefer the durable /j/<uuid> form in notebooks you keep — see Short URLs for the full comparison.

Then in a separate cell, w.outputs will reactively update when the metaframe emits output — any cell referencing it re-runs automatically.

python
w.set_inputs({"data": [1, 2, 3]})

Piping widgets ​

For piping, access the underlying widget via .widget:

python
source.widget.pipe_to(sink.widget, output_key="result", input_key="data")

See examples/marimo/demo.py in the repo for a complete example.

Developer guide ​

Running locally with Docker ​

bash
just marimo-docker

Open http://localhost:2718 in your browser.

To use a different port:

bash
MARIMO_PORT=3000 just marimo-docker

Running locally without Docker ​

bash
pip install -e "python/[dev]"
pip install -e "examples/marimo[dev]"
marimo edit examples/marimo/demo.py

Publishing ​

The widget is published from the canonical python/ directory:

bash
just python-build          # builds python/dist/
just python-publish-local  # publishes to PyPI

Or via git tag for CI: git tag python-v0.1.0 && git push origin python-v0.1.0