feature-docs/org.meshtastic.feature.docs.ui

Package-level declarations

Types

class ComposeResourceImageTransformer : ImageTransformer

Resolves local markdown image references (e.g. ../../assets/screenshots/foo.png) to bundled Compose resources via Res.getUri and loads them asynchronously using Coil 3's rememberAsyncImagePainter.

Properties

DOCS_SEARCH_BAR_EXPANDED_INPUT_FIELD_TAG

const val DOCS_SEARCH_BAR_EXPANDED_INPUT_FIELD_TAG: String

Tag for the field instance the full-screen overlay shows once expanded.

DOCS_SEARCH_BAR_INPUT_FIELD_TAG

const val DOCS_SEARCH_BAR_INPUT_FIELD_TAG: String

Tag for the collapsed field; distinct from DOCS_SEARCH_BAR_EXPANDED_INPUT_FIELD_TAG so tests can target it alone.

Functions

ChirpyAssistantContent

@Composable

fun ChirpyAssistantContent(state: AIDocAssistantSessionState, onDraftChange: (String) -> Unit, onSubmit: () -> Unit, onNavigateToPage: (String) -> Unit, modifier: Modifier = Modifier)

Standalone chat content layout extracted for preview compatibility.

ChirpyAssistantContentPreview

@Composable

fun ChirpyAssistantContentPreview()

Previews the Chirpy assistant chat content without ModalBottomSheet wrapper, since ModalBottomSheet requires a sheet host that is unavailable in previews.

ChirpyAssistantLoadingPreview

@Composable

fun ChirpyAssistantLoadingPreview()

ChirpyAssistantSheet

@Composable

fun ChirpyAssistantSheet(state: AIDocAssistantSessionState, modelReadiness: ModelReadiness, onDraftChange: (String) -> Unit, onSubmit: () -> Unit, onDismiss: () -> Unit, onNavigateToPage: (String) -> Unit, modifier: Modifier = Modifier)

Chirpy AI Assistant bottom sheet with chat UI. Hidden entirely when the assistant reports unsupported.

ChirpyFab

@Composable

fun ChirpyFab(modelReadiness: ModelReadiness, onClick: () -> Unit, modifier: Modifier = Modifier)

Expressive Chirpy FAB that communicates model state through motion.

DocsBrowserScreen

@Composable

fun DocsBrowserScreen(pages: List<DocPage>, isLoading: Boolean, searchQuery: String, onSearchQueryChange: (String) -> Unit, onSelectPage: (String) -> Unit, onBack: () -> Unit, modifier: Modifier = Modifier, isAiSupported: Boolean = false, modelReadiness: ModelReadiness = ModelReadiness.Checking, showFab: Boolean = false, showChirpy: Boolean = false, chirpyState: AIDocAssistantSessionState = AIDocAssistantSessionState(), onChirpyToggle: () -> Unit = {}, onChirpyDismiss: () -> Unit = {}, onChirpyDraftChange: (String) -> Unit = {}, onChirpySubmit: () -> Unit = {}, onChirpyNavigateToPage: (String) -> Unit = {})

Main documentation browser screen showing a grouped TOC.

DocsBrowserScreenEmptyPreview

@Composable

fun DocsBrowserScreenEmptyPreview()

DocsBrowserScreenPreview

@Composable

fun DocsBrowserScreenPreview()

DocsPageContentPreview

@Composable

fun DocsPageContentPreview()

DocsPageNotFoundPreview

@Composable

fun DocsPageNotFoundPreview()

DocsPageRouteScreen

@Composable

fun DocsPageRouteScreen(pageId: String, content: DocPageContent?, isLoading: Boolean, translationSource: TranslationSource = TranslationSource.BUNDLED, isNonEnglish: Boolean = false, isAiSupported: Boolean = false, modelReadiness: ModelReadiness = ModelReadiness.Checking, showChirpy: Boolean = false, chirpyState: AIDocAssistantSessionState = AIDocAssistantSessionState(), onChirpyToggle: () -> Unit = {}, onChirpyDismiss: () -> Unit = {}, onChirpyDraftChange: (String) -> Unit = {}, onChirpySubmit: () -> Unit = {}, onChirpyNavigateToPage: (String) -> Unit = {}, onBack: () -> Unit, onNavigateToPage: (String) -> Unit = {}, modifier: Modifier = Modifier)

Routes a page ID to the appropriate page renderer surface.

DocsSearchBar

@Composable

fun DocsSearchBar(query: String, onQueryChange: (String) -> Unit, modifier: Modifier = Modifier, scrollBehavior: SearchBarScrollBehavior? = null, expandedContent: @Composable ColumnScope.() -> Unit = {})

Search bar for filtering documentation pages by keywords.

DocsSearchBarEmptyPreview

@Composable

fun DocsSearchBarEmptyPreview()

DocsSearchBarWithQueryPreview

@Composable

fun DocsSearchBarWithQueryPreview()