Struct SearchView 

pub struct SearchView<State: 'static> { /* private fields */ }

A search view’s content, before a presentation is chosen. See the module docs.

Implementations

impl<State: 'static> SearchView<State>

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

Set the field’s placeholder (M3ESearchAnchor.viewHintText), which also labels the view’s accessibility node.

pub fn leading(self, view: AnyView<State>) -> Self

Replace the header’s default back affordance (M3ESearchAnchor.viewLeading). The slot is never empty.

pub fn trailing(self, view: AnyView<State>) -> Self

Append a trailing header action. Setting any replaces the built-in clear button — M3ESearchAnchor.viewTrailing’s own widget.viewTrailing ?? [clear] precedence.

pub fn suggestions<V: View<State>>(self, view: V) -> Self

Set the body slot: the suggestion list this view shows under its header (M3ESearchAnchor.suggestionsBuilder’s output). A view with none shows an empty body.

pub fn on_submit<F: Fn(&mut State, String) + 'static>( self, on_submit: F, ) -> Self

Set the Enter handler (M3ESearchAnchor.viewOnSubmitted).

pub fn on_back<F: Fn(&mut State) + 'static>(self, on_back: F) -> Self

Set the header back affordance’s handler. show_search_view wires this to controller.pop(); a docked view falls back to its own on_dismiss when this is unset, since a docked back press is a dismissal. See the module docs’ header note for why this dismissal is not staged.

pub fn dismissable(self, dismissable: bool) -> Self

Whether the user can dismiss a full-screen view at all — its scrim tap, Escape and the Android back press (default true; see crate::overlay::modal). No effect on a docked view, whose lifetime is the app’s own open flag.

pub fn on_dismiss<F: Fn(&mut State) + 'static>(self, on_dismiss: F) -> Self

Set the dismiss callback.

• Docked: the host’s light dismiss (a press outside the panel, or Escape while it holds focus) and, unless on_back overrides it, the header’s back affordance — wire it to the flag DockedSearchViewView::open reads.
• Full-screen: the unstaged dismissal, delivered with &mut State during the event pass. show_search_view wires the staged (navigator-pop) path instead, so set this only for a Stack-mounted view with no navigator underneath it.

pub fn full_screen(self) -> SearchViewView<State>

Finish as the full-screen presentation: crate::overlay::modal’s host filling the whole area. show_search_view is the navigator push most callers want.

pub fn docked(self, anchor: &OverlayAnchor) -> DockedSearchViewView<State>

Finish as the docked presentation: an crate::overlay::anchored_overlay placed over anchor’s own rect (the bar’s — wrap it in crate::overlay::overlay_anchor).

Keep the host mounted and toggle DockedSearchViewView::open so its exit ramp can run (docs/LIMITATIONS.md’s shadcn-anchored-exit-needs-kept-mounted).

on_dismiss serves both exits here — the light dismiss and the header’s back affordance — so one closure closes the view however the user asks.

search_view(state.query.clone(), |s: &mut App, q| s.query = q)
    .suggestions(suggestion_list())
    .on_dismiss(|s: &mut App| s.search_open = false)
    .docked(&state.search_anchor)
    .open(state.search_open)