Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adjust Composable function signature to make source mandatory #135

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 3 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,44 +155,12 @@ binding.pdfView.initWithUrl(
```

#### Using with Jetpack Compose

For Jetpack Compose, utilize `PdfRendererViewCompose` to render PDF files.

To render a PDF from a URL:

```kotlin
PdfRendererViewCompose(
url = "your_pdf_url_here",
)
```

To render a PDF from a local file:

```kotlin
PdfRendererViewCompose(
file = yourFile,
)
```

To render a PDF from a URI:

```kotlin
PdfRendererViewCompose(
uri = yourUri,
)
```

You can also provide arguments for additional parameters such as `modifier`, `headers`, `lifecycleOwner`, and `statusCallBack`:
For Jetpack Compose, utilize PdfRendererViewCompose:

```kotlin
PdfRendererViewCompose(
url = "your_pdf_url_here",
modifier = Modifier,
headers = HeaderData(mapOf("Authorization" to "123456789")),
lifecycleOwner = LocalLifecycleOwner.current,
statusCallBack = object : PdfRendererView.StatusCallBack {
// Override functions here
},
source = PdfSource.Remote("your_pdf_url_here"),
lifecycleOwner = LocalLifecycleOwner.current
)
```

Expand Down
12 changes: 9 additions & 3 deletions app/src/main/java/com/rajat/sample/pdfviewer/ComposeActivity.kt
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.saveable.rememberSaveable
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalLifecycleOwner
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import com.rajat.pdfviewer.PdfRendererView
import com.rajat.pdfviewer.PdfSource
import com.rajat.pdfviewer.compose.PdfRendererViewCompose
import com.rajat.sample.pdfviewer.ui.theme.AndroidpdfviewerTheme
import java.io.File
Expand Down Expand Up @@ -99,9 +101,11 @@ fun MyPdfScreenFromUri(modifier: Modifier = Modifier) {

@Composable
fun MyPdfScreenFromUri(uri: Uri, modifier: Modifier = Modifier) {
val lifecycleOwner = LocalLifecycleOwner.current
PdfRendererViewCompose(
source = PdfSource.LocalUri(uri),
modifier = modifier,
uri = uri,
lifecycleOwner = lifecycleOwner,
statusCallBack = object : PdfRendererView.StatusCallBack {
override fun onPdfLoadStart() {
Log.i("statusCallBack", "onPdfLoadStart")
Expand Down Expand Up @@ -134,8 +138,8 @@ fun MyPdfScreenFromUri(uri: Uri, modifier: Modifier = Modifier) {
fun MyPdfScreenFromUrl(url: String, modifier: Modifier = Modifier) {
val lifecycleOwner = LocalLifecycleOwner.current
PdfRendererViewCompose(
source = PdfSource.Remote(url),
modifier = modifier,
url = url,
lifecycleOwner = lifecycleOwner,
statusCallBack = object : PdfRendererView.StatusCallBack {
override fun onPdfLoadStart() {
Expand Down Expand Up @@ -168,9 +172,11 @@ fun MyPdfScreenFromUrl(url: String, modifier: Modifier = Modifier) {

@Composable
fun MyPdfScreenFromFile() {
val lifecycleOwner = LocalLifecycleOwner.current
val pdfFile = File("path/to/your/file.pdf") // Replace with your file path
PdfRendererViewCompose(
file = pdfFile,
source = PdfSource.LocalFile(pdfFile),
lifecycleOwner = lifecycleOwner
)
}

Expand Down
10 changes: 10 additions & 0 deletions pdfViewer/src/main/java/com/rajat/pdfviewer/PdfSource.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package com.rajat.pdfviewer

import android.net.Uri
import java.io.File

sealed interface PdfSource {
data class Remote(val url: String) : PdfSource
data class LocalFile(val file: File) : PdfSource
data class LocalUri(val uri: Uri) : PdfSource
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
package com.rajat.pdfviewer.compose

import android.content.Context
import android.net.Uri
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalLifecycleOwner
Expand All @@ -10,68 +8,36 @@ import androidx.lifecycle.LifecycleOwner
import androidx.lifecycle.lifecycleScope
import com.rajat.pdfviewer.HeaderData
import com.rajat.pdfviewer.PdfRendererView
import java.io.File
import com.rajat.pdfviewer.PdfSource

@Composable
fun PdfRendererViewCompose(
url: String,
source: PdfSource,
modifier: Modifier = Modifier,
headers: HeaderData = HeaderData(),
lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current,
statusCallBack: PdfRendererView.StatusCallBack? = null,
) {
AndroidView(
factory = { context: Context -> PdfRendererView(context) },
update = { pdfRendererView: PdfRendererView ->
if (statusCallBack != null) {
pdfRendererView.statusListener = statusCallBack
}

pdfRendererView.initWithUrl(
url = url,
headers = headers,
lifecycleCoroutineScope = lifecycleOwner.lifecycleScope,
lifecycle = lifecycleOwner.lifecycle,
)
},
modifier = modifier,
)
}

@Composable
fun PdfRendererViewCompose(
file: File,
modifier: Modifier = Modifier,
statusCallBack: PdfRendererView.StatusCallBack? = null,
statusCallBack: PdfRendererView.StatusCallBack? = null
) {
AndroidView(
factory = { context -> PdfRendererView(context) },
update = { pdfRendererView: PdfRendererView ->
if (statusCallBack != null) {
pdfRendererView.statusListener = statusCallBack
}
update = { view ->
with(view) {
if (statusCallBack != null) {
statusListener = statusCallBack
}

pdfRendererView.initWithFile(file = file)
},
modifier = modifier
)
}

@Composable
fun PdfRendererViewCompose(
uri: Uri,
modifier: Modifier = Modifier,
statusCallBack: PdfRendererView.StatusCallBack? = null,
) {
AndroidView(
factory = { context -> PdfRendererView(context) },
update = { pdfRendererView: PdfRendererView ->
if (statusCallBack != null) {
pdfRendererView.statusListener = statusCallBack
when (source) {
is PdfSource.LocalFile -> initWithFile(source.file)
is PdfSource.LocalUri -> initWithUri(source.uri)
is PdfSource.Remote -> initWithUrl(
source.url,
headers,
lifecycleOwner.lifecycleScope,
lifecycleOwner.lifecycle
)
}
}

pdfRendererView.initWithUri(uri = uri)
},
modifier = modifier,
modifier = modifier
)
}
1 change: 0 additions & 1 deletion pdfViewer/src/main/res/layout/activity_pdf_viewer.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
android:layout_width="match_parent"
android:layout_height="match_parent"
app:pdfView_divider="@drawable/pdf_viewer_divider"
app:pdfView_engine="internal"
app:pdfView_showDivider="false" />

<ProgressBar
Expand Down
Loading