API

The guides on this site teach concepts and workflows; for the full, autogenerated API reference — every class, function, and argument — we use Read The Docs. Click the image below to open it.

It is organized into a few groups:

• Trame API: trame.app, trame.widgets, trame.ui, trame.decorators, trame.assets, trame.env — the core building blocks used in every application.
• Client API: the JavaScript/TypeScript side of trame.
• Core Classes: server, widget, ui — the underlying objects the Trame API is built on.
• Tools: standalone command-line utilities, such as the multi-user server (tools.serve), the widget generator (tools.widgets), and the profiler (tools.profiler).