Compose Navigation

1
/*
2
 *   Copyright © 2023-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.graphics.RectF
13
import android.os.Bundle
14
import android.widget.Toast
15
import androidx.activity.compose.setContent
16
import androidx.activity.enableEdgeToEdge
17
import androidx.appcompat.app.AppCompatActivity
18
import androidx.compose.foundation.background
19
import androidx.compose.foundation.layout.Box
20
import androidx.compose.foundation.layout.fillMaxSize
21
import androidx.compose.foundation.layout.padding
22
import androidx.compose.foundation.layout.statusBarsPadding
23
import androidx.compose.material.icons.Icons
24
import androidx.compose.material.icons.automirrored.filled.ArrowBack
25
import androidx.compose.material3.ElevatedButton
26
import androidx.compose.material3.ExperimentalMaterial3Api
27
import androidx.compose.material3.Icon
28
import androidx.compose.material3.IconButton
29
import androidx.compose.material3.MaterialTheme
30
import androidx.compose.material3.Scaffold
31
import androidx.compose.material3.Text
32
import androidx.compose.material3.TopAppBar
33
import androidx.compose.runtime.Composable
34
import androidx.compose.runtime.remember
35
import androidx.compose.ui.Alignment
36
import androidx.compose.ui.Modifier
37
import androidx.core.net.toUri
38
import androidx.navigation.compose.NavHost
39
import androidx.navigation.compose.composable
40
import androidx.navigation.compose.rememberNavController
41
import com.pspdfkit.catalog.R
42
import com.pspdfkit.catalog.SdkExample
43
import com.pspdfkit.catalog.tasks.ExtractAssetTask
44
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
45
import com.pspdfkit.configuration.activity.UserInterfaceViewMode
46
import com.pspdfkit.configuration.page.PageFitMode
47
import com.pspdfkit.configuration.page.PageLayoutMode
48
import com.pspdfkit.configuration.page.PageScrollDirection
49
import com.pspdfkit.configuration.page.PageScrollMode
50
import com.pspdfkit.forms.TextFormConfiguration
51
import com.pspdfkit.jetpack.compose.interactors.DefaultListeners
52
import com.pspdfkit.jetpack.compose.interactors.getDefaultDocumentManager
53
import com.pspdfkit.jetpack.compose.interactors.rememberDocumentState
54
import com.pspdfkit.jetpack.compose.views.DocumentView
55

56
private const val URL_PARAM = "url_param"
57

58
/**
59
 * This activity shows how DocumentView can be used with Navigation Component.
60
 */
61
class NavHostExample(context: Context) : SdkExample(context, R.string.navHostExampleTitle, R.string.navHostExampleDescription) {
62
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
63
        // Extract the document from the assets.
64
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { url ->
65
            context.startActivity(
66
                Intent(context, NavHostActivity::class.java).apply {
67
                    putExtra(URL_PARAM, url.toUri().toString())
68
                }
69
            )
70
        }
71
    }
72
}
73

74
/**
75
 * This activity will create a simple navigation flow between two screens, each containing a DocumentView.
76
 */
77
class NavHostActivity : AppCompatActivity() {
78
    override fun onCreate(savedInstanceState: Bundle?) {
79
        super.onCreate(savedInstanceState)
80
        val path = intent.getStringExtra(URL_PARAM) ?: ""
81
        enableEdgeToEdge()
82
        setContent {
83
            MaterialTheme {
84
                Scaffold {
85
                    val navController = rememberNavController()
86
                    NavHost(
87
                        navController = navController,
88
                        startDestination = "ScreenOne",
89
                        modifier = Modifier.fillMaxSize().padding(it)
90
                    ) {
91
                        composable("ScreenOne") { ScreenOne(path) { navController.navigate("ScreenTwo") } }
92
                        composable("ScreenTwo") { ScreenTwo(path) { navController.popBackStack() } }
93
                    }
94
                }
95
            }
96
        }
97
    }
98
}
99

100
/**
101
 * ScreenOne contains a DocumentView
102
 */
103
@Composable
104
fun ScreenOne(path: String, navigate: () -> Unit) {
105
    Box(modifier = Modifier.fillMaxSize(), contentAlignment = Alignment.BottomCenter) {
106
        val context = androidx.compose.ui.platform.LocalContext.current
107
        val pdfActivityConfiguration = remember {
108
            PdfActivityConfiguration
109
                .Builder(context)
110
                .layoutMode(PageLayoutMode.AUTO)
111
                .scrollMode(PageScrollMode.CONTINUOUS)
112
                .fitMode(PageFitMode.FIT_TO_WIDTH)
113
                .pagePadding(8)
114
                .scrollDirection(PageScrollDirection.VERTICAL)
115
                .setUserInterfaceViewMode(UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_HIDDEN)
116
                .autosaveEnabled(false)
117
                .formEditingEnabled(false)
118
                .build()
119
        }
120

121
        val documentState = rememberDocumentState(documentUri = path.toUri(), configuration = pdfActivityConfiguration)
122
        DocumentView(
123
            documentState = documentState,
124
            documentManager = getDefaultDocumentManager(
125
                documentListener = DefaultListeners.documentListeners(
126
                    onDocumentLoaded = { i ->
127
                        i.formProvider
128
                            .addFormElementToPage<TextFormConfiguration>(
129
                                "text-field-1",
130
                                TextFormConfiguration.Builder(0, RectF(30f, 750f, 200f, 720f))
131
                                    .setText("Hello new Text")
132
                                    .build()
133
                            )
134
                        Toast.makeText(context, "Document loaded!", Toast.LENGTH_SHORT).show()
135
                    }
136
                )
137
            )
138
        )
139
        ElevatedButton(navigate, modifier = Modifier) {
140
            Text("Navigate by NavController")
141
        }
142
    }
143
}
144

145
/**
146
 * ScreenTwo contains a DocumentView with a slightly different configuration.
147
 */
148
@OptIn(ExperimentalMaterial3Api::class)
149
@Composable
150
fun ScreenTwo(path: String, navigate: () -> Unit) {
151
    Box(modifier = Modifier.fillMaxSize()) {
152
        val context = androidx.compose.ui.platform.LocalContext.current
153
        val pdfActivityConfiguration = remember {
154
            PdfActivityConfiguration
155
                .Builder(context)
156
                .layoutMode(PageLayoutMode.AUTO)
157
                .scrollMode(PageScrollMode.PER_PAGE)
158
                .fitMode(PageFitMode.FIT_TO_WIDTH)
159
                .pagePadding(8)
160
                .scrollDirection(PageScrollDirection.VERTICAL)
161
                .setUserInterfaceViewMode(UserInterfaceViewMode.USER_INTERFACE_VIEW_MODE_HIDDEN)
162
                .autosaveEnabled(false)
163
                .formEditingEnabled(true)
164
                .build()
165
        }
166

167
        val documentState = rememberDocumentState(documentUri = path.toUri(), configuration = pdfActivityConfiguration)
168
        DocumentView(
169
            documentState = documentState,
170
            documentManager = getDefaultDocumentManager(
171
                documentListener = DefaultListeners.documentListeners(
172
                    onDocumentLoaded = { i ->
173
                        i.formProvider
174
                            .addFormElementToPage<TextFormConfiguration>(
175
                                "text-field-editable",
176
                                TextFormConfiguration.Builder(0, RectF(30f, 750f, 200f, 720f))
177
                                    .setText("Hello new Text")
178
                                    .build()
179
                            )
180
                        Toast.makeText(context, "Document loaded!", Toast.LENGTH_SHORT).show()
181
                    }
182
                )
183
            )
184
        )
185
        Box(modifier = Modifier.background(MaterialTheme.colorScheme.surface)) {
186
            TopAppBar(
187
                title = { Text("${documentState.getTitle()}") },
188
                navigationIcon = {
189
                    IconButton(navigate) {
190
                        Icon(Icons.AutoMirrored.Default.ArrowBack, contentDescription = "Back")
191
                    }
192
                },
193
                modifier = Modifier.statusBarsPadding()
194
            )
195
        }
196
    }
197
}