express.module

express.module(fn)

Create a Shiny module using Shiny Express syntax

This function is used to create a Shiny module, where the code inside the function uses Shiny Express syntax. This is in contrast to the pair of functions :func:~shiny.module.ui() and :func:~shiny.module.server(), which are used to create Shiny modules with Core syntax.

Parameters

fn : Callable[Concatenate[Inputs, Outputs, Session, P], R]

The function that defines the module. The first three parameters of this function must be input, output, and session. Any additional parameters can used to pass information to the module.

See Also

Examples

#| standalone: true
#| components: [editor, viewer]
#| layout: vertical
#| viewerHeight: 400

## file: app.py
from shiny import reactive
from shiny.express import module, render, ui


# ============================================================
# Counter module
# ============================================================
@module
def counter(input, output, session, label, starting_value: int = 0):
    count = reactive.value(starting_value)
    with ui.card():
        ui.h2(f"This is {label}")
        ui.input_action_button("button", f"{label}")

        @render.text
        def out():
            return f"Click count is {count()}"

    @reactive.effect
    @reactive.event(input.button)
    def _():
        count.set(count() + 1)


# =============================================================================
# App that uses module
# =============================================================================
counter("counter1", "Counter 1", starting_value=0)
ui.hr()
counter("counter2", "Counter 2", starting_value=0)