Package-level declarations

Types

Link copied to clipboard
data class FieldFocusRequest(val key: String, val id: Long)

One selection of a search result: two selections of the same key differ by id.

Link copied to clipboard
data class ResolvedSettingsEntry(val id: String, val title: String, val description: String?, val screenTitle: String, val route: Route, val keywords: List<String> = emptyList(), val isAppLocal: Boolean = false, val fieldKey: String? = null)

A catalog entry with its text resolved in the user's language, which is what the matcher reads.

Link copied to clipboard

The control a settings search result named, handed from the search field to the config screen it opened.

Link copied to clipboard

The searchable surface of Settings.

Link copied to clipboard
data class SettingsSearchEntry(val title: StringResource, val description: StringResource?, val route: Route, val screenTitle: StringResource, val keywords: StringResource? = null, val fieldKey: String? = null, val isAppLocal: Boolean = false)

One thing the user can search for: a settings screen, or a single control on one.

Link copied to clipboard

Ranks settings results by where the query landed, following the weights Meshtastic-Apple's settings search shipped (spec 019, FR-011): a hit on the name outranks one in the explanation, and an exact name outranks a prefix.

Link copied to clipboard

Backs the search field on the Settings screen.

Properties

Link copied to clipboard

Provided around each config screen; null where no search can have named a control, such as previews.

Link copied to clipboard

Tag for the collapsed settings search field, so a test can target it rather than the expanded overlay's copy.

Functions

Link copied to clipboard
fun SettingsSearchBar(viewModel: SettingsSearchViewModel, onNavigate: (Route) -> Unit, modifier: Modifier = Modifier, includeAppLocal: Boolean = true)

The search field at the top of Settings. Typing expands the bar over the screen and lists matching settings; choosing one navigates to the screen that holds it and asks that screen to scroll to the control. A screen whose list items carry no key for the control opens at the top.