Struct WidgetFilter 

pub struct WidgetFilter {
    pub key: String,
    pub label: String,
    pub kind: WidgetFilterKind,
    pub default: Option<String>,
    pub active: Option<String>,
    pub active_start: Option<String>,
    pub active_end: Option<String>,
    pub carry: String,
    pub carry_lead: String,
}

A control the admin renders in a widget’s header, declared at registration time and rendered for every widget kind.

Before this existed the only filter in the admin was a [7d][30d][90d] chip strip hardcoded inside line.html, which meant a bar chart or a table could not be filtered at all, and no widget could offer anything but a period. A filter is now data: the widget declares it, the admin renders it, and the value arrives in WidgetParams.

Widget::new("orders_by_status", "Orders", WidgetKind::Bar, data_fn)
    .filter(WidgetFilter::period_default())
    .filter(WidgetFilter::choice("status", "Status", [
        ("open", "Open"), ("paid", "Paid"),
    ]))

The chosen value is sticky per user: picking one persists to the user’s admin preferences, so it survives a reload the same way a period chip does.

Fields

key: String

Query-parameter name. "period" for a period filter, "start"/"end" are implied by a date range, anything else for a choice.

label: String

Label shown beside the control.

kind: WidgetFilterKind

Which control to render.

default: Option<String>

Value selected when the user has never touched this filter.

active: Option<String>

Resolved value for THIS request — URL, else the user’s saved choice, else default. Filled in by the handler; ignored at registration.

active_start: Option<String>

Resolved range ends, for a WidgetFilterKind::DateRange only. Filled in by the handler; ignored at registration.

active_end: Option<String>

carry: String

Query-string fragment carrying every OTHER filter’s current value, e.g. "&status=paid&period=7d". Filled in by the handler.

It lives here, computed in Rust, because the alternative was assembling it in the template with split/trim gymnastics — and a control that gets this wrong silently resets its neighbours the moment you touch it.

carry_lead: String

The same fragment without the leading &, for a control that starts the query string rather than appending to one (a <select> whose own value htmx appends via hx-include).

Implementations

impl WidgetFilter

pub fn period<I, V, L>(presets: I) -> Self

where I: IntoIterator<Item = (V, L)>, V: Into<String>, L: Into<String>,

A period chip strip with custom presets.

pub fn period_default() -> Self

The conventional [7d] [30d] [90d] strip — what line.html hardcoded.

pub fn date_range() -> Self

A start/end date pair. Reaches the closure as params.start / params.end, which take precedence over period when both are present.

pub fn choice<I, V, L>( key: impl Into<String>, label: impl Into<String>, options: I, ) -> Self

where I: IntoIterator<Item = (V, L)>, V: Into<String>, L: Into<String>,

A <select> writing ?<key>=. Read it back with params.choice(key).

pub fn with_default(self, value: impl Into<String>) -> Self

Pre-select a value on first paint.

pub fn active_value(&self) -> Option<&str>

The value in force for this request.

Trait Implementations

impl Clone for WidgetFilter

fn clone(&self) -> WidgetFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WidgetFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WidgetFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WidgetFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.