Bouquet is a PDF reader library written completely in Jetpack Compose, this was created using PDFRender and coroutine. The library supports both horizontal and vertical viewing.
- Different sources available out of box (Base64, URL, URI)
- Double tap to zoom and pan
- You can retrieve the open file to share
- Loading progress indication
- Current page and total page number
- Error handling
Step 1. Add INTERNET permissions on your AndroidManifest.xml
<uses-permission android:name="android.permission.INTERNET" />Step 2. Add the MavenCentral repository to your build file Add it in your root build.gradle at the end of repositories:
allprojects {
repositories {
mavenCentral()
}
}
Step 3. Add the dependency
dependencies {
implementation 'io.github.grizzi91:bouquet:1.1.2'
}
Step 4. You can use the library by creating the state in a Composable This is for portrait viewing
val pdfState = rememberVerticalPdfReaderState(
resource = ResourceType.Remote("https://myreport.altervista.org/Lorem_Ipsum.pdf"),
isZoomEnable = true
)This is for landscape viewing
val pdfState = rememberHorizontalPdfReaderState(
resource = ResourceType.Remote("https://myreport.altervista.org/Lorem_Ipsum.pdf"),
isZoomEnable = true
)Or you can host the state in a ViewModel
class BouquetViewModel : ViewModel() {
val pdfHorizontalReaderState = HorizontalPdfReaderState(
resource = ResourceType.Remote("https://myreport.altervista.org/Lorem_Ipsum.pdf"),
isZoomEnable = true
)
val pdfVerticallReaderState = VerticalPdfReaderState(
resource = ResourceType.Remote("https://myreport.altervista.org/Lorem_Ipsum.pdf"),
isZoomEnable = true
)
}Step 5. Then pass the state to the PDFReader function
VerticalPDFReader(
state = pdfState,
modifier = Modifier
.fillMaxSize()
.background(color = Color.Gray)
)or
HorizontalPDFReader(
state = pdfState,
modifier = Modifier
.fillMaxSize()
.background(color = Color.Gray)
)You can use Modifier to modify dimension, background color or shape and other parameter of the PDFReader view.
You can choose different sources using the sealed class ResourceType
Remote source, with support for headers
ResourceType.Remote(
url = "https://myreport.altervista.org/Lorem_Ipsum.pdf",
headers = hashMapOf("headerKey" to "headerValue")
)Local source
ResourceType.Local(
// URI
)Base64 source
ResourceType.Base64(
// Base64 string
)Asset source
ResourceType.Asset(R.raw.pdf)In case of errors, for example with the remote resource, you can recover the error from the state.
LaunchedEffect(key1 = pdfState.error) {
pdfState.error?.let {
// Show error
}
}After the opening of the pdf you can share it from the 'file' field of the state.
state.file?.let {
FloatingActionButton(
onClick = {
shareFile(it)
}
) {
Icon(
painter = painterResource(id = android.R.drawable.ic_menu_share),
contentDescription = "share"
)
}
}For managing the download progress, current page number, total page number, scrolling status etc. you can refer to the sample app.
Copyright [2022] [Graziano Rizzi]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.