Custom Search UI Compose

1
/*
2
 *   Copyright © 2025-2026 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.kotlin
9

10
import android.content.Context
11
import android.content.Intent
12
import android.net.Uri
13
import android.os.Bundle
14
import androidx.activity.compose.setContent
15
import androidx.activity.viewModels
16
import androidx.appcompat.app.AppCompatActivity
17
import androidx.compose.foundation.background
18
import androidx.compose.foundation.layout.Box
19
import androidx.compose.foundation.layout.fillMaxSize
20
import androidx.compose.foundation.layout.fillMaxWidth
21
import androidx.compose.foundation.layout.padding
22
import androidx.compose.foundation.layout.statusBarsPadding
23
import androidx.compose.material3.MaterialTheme
24
import androidx.compose.material3.Scaffold
25
import androidx.compose.material3.Text
26
import androidx.compose.material3.TextField
27
import androidx.compose.runtime.getValue
28
import androidx.compose.runtime.mutableStateOf
29
import androidx.compose.runtime.setValue
30
import androidx.compose.ui.Modifier
31
import androidx.lifecycle.ViewModel
32
import androidx.lifecycle.ViewModelProvider
33
import androidx.lifecycle.viewModelScope
34
import androidx.lifecycle.viewmodel.CreationExtras
35
import com.pspdfkit.catalog.R
36
import com.pspdfkit.catalog.SdkExample
37
import com.pspdfkit.catalog.tasks.ExtractAssetTask
38
import com.pspdfkit.catalog.ui.theming.CatalogTheme
39
import com.pspdfkit.configuration.PdfConfiguration
40
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
41
import com.pspdfkit.configuration.activity.UserInterfaceViewMode
42
import com.pspdfkit.document.PdfDocument
43
import com.pspdfkit.document.search.TextSearch
44
import com.pspdfkit.jetpack.compose.interactors.DefaultListeners
45
import com.pspdfkit.jetpack.compose.interactors.DocumentState
46
import com.pspdfkit.jetpack.compose.interactors.getDefaultDocumentManager
47
import com.pspdfkit.jetpack.compose.interactors.rememberDocumentState
48
import com.pspdfkit.jetpack.compose.views.DocumentView
49
import com.pspdfkit.ui.search.SearchResultHighlighter
50
import com.pspdfkit.utils.getSupportParcelableExtra
51
import kotlinx.coroutines.Dispatchers
52
import kotlinx.coroutines.launch
53
import kotlin.getValue
54

55
class CustomSearchUiComposeExample(context: Context) : SdkExample(context, R.string.customSearchUiComposeExampleTitle, R.string.customSearchUiComposeExampleDescription) {
56
    /** Configuration is handled inside [CustomSearchUiComposeActivity] */
57
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
58
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
59
            val intent = Intent(context, CustomSearchUiComposeActivity::class.java)
60
            intent.putExtra(CustomSearchUiComposeActivity.EXTRA_URI, Uri.fromFile(documentFile))
61
            context.startActivity(intent)
62
        }
63
    }
64
}
65

66
class CustomSearchUiComposeActivity : AppCompatActivity() {
67

68
    private val viewModel: CustomSearchUiComposeViewModel by viewModels { CustomSearchUiComposeViewModel.Factory }
69

70
    private var highlighter: SearchResultHighlighter? = null
71

72
    override fun onCreate(savedInstanceState: Bundle?) {
73
        super.onCreate(savedInstanceState)
74

75
        val uri = intent.getSupportParcelableExtra(EXTRA_URI, Uri::class.java)!!
76

77
        highlighter = SearchResultHighlighter(this)
78

79
        setContent {
80
            CatalogTheme {
81
                val searchQuery = viewModel.searchQuery
82

83
                Scaffold(
84
                    modifier = Modifier.background(color = MaterialTheme.colorScheme.onPrimary)
85
                        .statusBarsPadding(),
86
                    topBar = {
87
                        TextField(
88
                            value = searchQuery,
89
                            onValueChange = viewModel::performSearch,
90
                            modifier = Modifier.fillMaxWidth(),
91
                            placeholder = { Text(text = "Search") }
92
                        )
93
                    }
94
                ) { paddingValues ->
95

96
                    val pdfActivityConfiguration = PdfActivityConfiguration
97
                        .Builder(this)
98
                        .setUserInterfaceViewMode(UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_HIDDEN)
99
                        .build()
100

101
                    val documentState = rememberDocumentState(uri, pdfActivityConfiguration)
102

103
                    Box(Modifier.padding(paddingValues)) {
104
                        DocumentView(
105
                            documentState = documentState,
106
                            modifier = Modifier.fillMaxSize(),
107
                            documentManager = getDefaultDocumentManager(
108
                                documentListener = DefaultListeners.documentListeners(
109
                                    onDocumentLoaded = { document ->
110
                                        viewModel.onDocumentLoaded(
111
                                            document,
112
                                            pdfActivityConfiguration.configuration,
113
                                            documentState,
114
                                            highlighter
115
                                        )
116
                                    }
117
                                )
118
                            )
119
                        )
120
                    }
121
                }
122
            }
123
        }
124
    }
125

126
    companion object {
127
        const val EXTRA_URI = "JetpackComposeActivity.DocumentUri"
128
    }
129
}
130

131
class CustomSearchUiComposeViewModel : ViewModel() {
132

133
    var searchQuery by mutableStateOf("")
134
        private set
135

136
    private var document: PdfDocument? = null
137

138
    private var textSearch: TextSearch? = null
139
    private var highlighter: SearchResultHighlighter? = null
140

141
    fun onDocumentLoaded(document: PdfDocument, pdfConfiguration: PdfConfiguration, documentState: DocumentState, highlighter: SearchResultHighlighter?) {
142
        this.document = document
143
        textSearch = TextSearch(
144
            document,
145
            pdfConfiguration
146
        )
147
        highlighter?.let {
148
            documentState.documentConnection.addDrawableProvider(it)
149
        }
150
        this.highlighter = highlighter
151
    }
152

153
    fun performSearch(query: String) {
154
        searchQuery = query
155

156
        viewModelScope.launch(Dispatchers.Default) {
157
            textSearch?.performSearch(searchQuery)?.let { results ->
158
                if (results.isNotEmpty()) {
159
                    highlighter?.addSearchResults(results)
160
                } else {
161
                    highlighter?.clearSearchResults()
162
                }
163
            }
164
        }
165
    }
166

167
    companion object {
168
        val Factory: ViewModelProvider.Factory = object : ViewModelProvider.Factory {
169
            @Suppress("UNCHECKED_CAST")
170
            override fun <T : ViewModel> create(
171
                modelClass: Class<T>,
172
                extras: CreationExtras
173
            ) = CustomSearchUiComposeViewModel() as T
174
        }
175
    }
176
}