DocumentTitleOverlayState

data class DocumentTitleOverlayState(val title: String? = null, val isVisible: Boolean = false)

State of the document title overlay — the strip rendered directly below the main toolbar row that shows the current document's title. It is the Compose successor of the legacy pspdf__activity_title_overlay TextView, but lives inside the main toolbar composable (below the toolbar row), rather than as a separate overlay in the activity layout.

Kept host-agnostic (no Android imports) like the rest of compose/toolbar/state/, so the same state drives the SDK-mounted overlay in PdfActivity and a caller-rendered overlay in the Compose flavor.

This is independent of ToolbarFrame.title, the title rendered in the toolbar row itself (used on tablets); the two can be shown together or independently.

Constructors

Link copied to clipboard
constructor(title: String? = null, isVisible: Boolean = false)

Types

Link copied to clipboard
object Companion

Factory holder for common DocumentTitleOverlayState values.

Properties

Link copied to clipboard

Whether the overlay should be shown. The SDK host drives this from the same conditions that gated the legacy overlay (UI visible, feature enabled, no contextual toolbar, no active full-screen view, phone, no tab bar) plus the portrait-only rule: shown in portrait, hidden in landscape.

Link copied to clipboard

The document title to show, or null when there is nothing to show.