feature-settings/org.meshtastic.feature.settings.search

Package-level declarations

Types

data class ResolvedSettingsEntry(val title: String, val description: String?, val screenTitle: String, val route: Route, val isAppLocal: Boolean = false)

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

SettingsSearchCatalog

object SettingsSearchCatalog

The searchable surface of Settings.

SettingsSearchEntry

data class SettingsSearchEntry(val title: StringResource, val description: StringResource?, val route: Route, val screenTitle: StringResource, val isAppLocal: Boolean = false)

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

SettingsSearchMatcher

object SettingsSearchMatcher

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.

SettingsSearchViewModel

class SettingsSearchViewModel : ViewModel

Backs the search field on the Settings screen.

Properties

SETTINGS_SEARCH_BAR_INPUT_FIELD_TAG

const val SETTINGS_SEARCH_BAR_INPUT_FIELD_TAG: String

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

Functions

SettingsSearchBar

@Composable

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.

SettingsSearchNoResultsPreview

@Composable

fun SettingsSearchNoResultsPreview()

SettingsSearchResultsPreview

@Composable

fun SettingsSearchResultsPreview()