Skip to main content

API Reference

App

Assemble and launch the full app

create_app()

Create the Shiny app and serve www/ at /shypermaid.

run_app()

Launch the app and open it in a browser.

Modules

Shiny Core modules for embedding the editor and viewer in another app

editor_ui()

Code editor with an Auto-Update switch and a Render button.

editor_server()

Track the Mermaid code the viewer should draw.

viewer_ui()

Diagram canvas with theme, look, layout, and direction menus and tools.

viewer_server()

Send the code and render options to the browser for drawing.

Diagram helpers

Shiny free functions that prepare Mermaid code and render options

set_direction()

Rewrite the direction of a flowchart, state, class, or git graph diagram.

render_config()

Build the options passed to mermaid.initialize().