Skip to content

ExportButton

Standardized export action for CSV, Excel, JSON, or PDF downloads.

Quick Start

Live Preview
from faststrap import ExportButton

ExportButton("Export CSV", endpoint="/export", export_format="csv")

With DataTable State

from faststrap import DataTable, ExportButton

params = DataTable.export_params(sort="name", direction="asc", search="alice")
ExportButton("Export", endpoint="/export", extra_params=params)

GET vs POST

  • method="get" creates a link or HTMX request
  • method="post" creates a form submit
ExportButton(
    "Export",
    endpoint="/export",
    method="post",
    export_format="xlsx",
)

Custom Filename

ExportButton(
    "Export",
    endpoint="/export",
    filename="report.xlsx",
)

HTMX Exports

ExportButton(
    "Export",
    endpoint="/export",
    use_hx=True,
    hx_target="#status",
    hx_swap="innerHTML",
)

Security Notes

Validate export formats server-side and require auth. Avoid using untrusted filenames.

API Reference

faststrap.components.forms.export_button.ExportButton(label='Export', *, endpoint=None, export_format='csv', filename=None, method='get', use_hx=False, hx_target=None, hx_swap='none', push_url=False, variant=None, outline=True, icon='download', extra_params=None, **kwargs)

Export button for CSV/Excel/JSON/PDF downloads.

Source code in src/faststrap/components/forms/export_button.py 
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
@register(category="forms")
@beta
def ExportButton(
    label: str = "Export",
    *,
    endpoint: str | None = None,
    export_format: ExportFormat = "csv",
    filename: str | None = None,
    method: ExportMethod = "get",
    use_hx: bool = False,
    hx_target: str | None = None,
    hx_swap: str | None = "none",
    push_url: bool = False,
    variant: VariantType | None = None,
    outline: bool = True,
    icon: str | None = "download",
    extra_params: dict[str, Any] | None = None,
    **kwargs: Any,
) -> Any:
    """Export button for CSV/Excel/JSON/PDF downloads."""
    cfg = resolve_defaults(
        "ExportButton",
        export_format=export_format,
        method=method,
        use_hx=use_hx,
        hx_swap=hx_swap,
        push_url=push_url,
        variant=variant,
        outline=outline,
    )
    c_format = cfg.get("export_format", export_format)
    c_method = cfg.get("method", method)
    c_use_hx = cfg.get("use_hx", use_hx)
    c_hx_swap = cfg.get("hx_swap", hx_swap)
    c_push_url = cfg.get("push_url", push_url)
    c_variant = cast(VariantType, cfg.get("variant", variant) or "secondary")
    c_outline = cfg.get("outline", outline)

    params: dict[str, Any] = {"format": c_format}
    if filename:
        params["filename"] = filename
    if extra_params:
        params.update(extra_params)

    user_cls = kwargs.pop("cls", "")
    attrs: dict[str, Any] = {"cls": merge_classes("faststrap-export-button", user_cls)}
    attrs.update(convert_attrs(kwargs))

    if endpoint:
        url = _build_url(endpoint, params)
    else:
        url = None

    if c_method == "get":
        if url:
            if c_use_hx:
                attrs.update(
                    {
                        "hx_get": url,
                        "hx_target": hx_target,
                        "hx_swap": c_hx_swap,
                    }
                )
                if c_push_url:
                    attrs["hx_push_url"] = "true"
            else:
                attrs["href"] = url
                if filename:
                    attrs["download"] = filename
        return Button(
            label,
            variant=c_variant,
            outline=c_outline,
            icon=icon,
            **attrs,
        )

    if c_use_hx:
        if url:
            attrs.update(
                {
                    "hx_post": url,
                    "hx_target": hx_target,
                    "hx_swap": c_hx_swap,
                }
            )
            if c_push_url:
                attrs["hx_push_url"] = "true"
        return Button(
            label,
            variant=c_variant,
            outline=c_outline,
            icon=icon,
            **attrs,
        )

    if not url:
        return Button(
            label,
            variant=c_variant,
            outline=c_outline,
            icon=icon,
            **attrs,
        )

    hidden_inputs = [
        FTInput(type="hidden", name="format", value=c_format),
    ]
    if filename:
        hidden_inputs.append(FTInput(type="hidden", name="filename", value=filename))
    if extra_params:
        for key, value in extra_params.items():
            normalized = _normalize_query_value(value)
            if normalized is None:
                continue
            if isinstance(normalized, list):
                hidden_inputs.extend(
                    FTInput(type="hidden", name=str(key), value=item) for item in normalized
                )
            else:
                hidden_inputs.append(FTInput(type="hidden", name=str(key), value=normalized))

    button = Button(
        label,
        variant=c_variant,
        outline=c_outline,
        icon=icon,
        type="submit",
        **attrs,
    )

    return FTForm(
        *hidden_inputs,
        button,
        method="post",
        action=endpoint,
    )