Skip to content

Commit 5f57921

Browse files
authored
Update README.md
1 parent 8aed31d commit 5f57921

File tree

1 file changed

+14
-29
lines changed

1 file changed

+14
-29
lines changed

README.md

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -65,27 +65,27 @@ val horizontalVueReaderState = rememberHorizontalVueReaderState(
6565
resource = VueResourceType.Local(
6666
uri = context.resources.openRawResource(
6767
R.raw.lorem_ipsum
68-
).toFile(".pdf").toUri(),
68+
).toFile("pdf").toUri(),
6969
fileType = VueFileType.PDF
7070
),
7171
cache = 3 // By default 0
7272
)
7373

74-
// .toFile is an util extension function to convert cany input stream to a file
74+
// .toFile is an util extension function to convert any input stream to a file
7575
```
7676
#### This is for vertical viewing
7777
```kotlin
7878
val verticalVueReaderState = rememberVerticalVueReaderState(
7979
resource = VueResourceType.Local(
8080
uri = context.resources.openRawResource(
8181
R.raw.lorem_ipsum
82-
).toFile(".pdf").toUri(),
82+
).toFile("pdf").toUri(),
8383
fileType = VueFileType.PDF
8484
),
8585
cache = 3 // By default 0
8686
)
8787

88-
// .toFile is an util extension function to convert cany input stream to a file
88+
// .toFile is an util extension function to convert any input stream to a file
8989
```
9090
**Step 5.** Invoke load() method to initalize source
9191
```kotlin
@@ -261,7 +261,7 @@ rememberHorizontalVueReaderState(resource = VueResourceType.Custom)
261261
})
262262
```
263263
# Import PDF and Images
264-
This launcher should be used when resource type is any of [VueResourceType](JetPDFVue/src/main/java/com/pratikk/jetpdfvue/state/VueResourceType.kt)
264+
## This launcher should be used when resource type is of [VueResourceType](JetPDFVue/src/main/java/com/pratikk/jetpdfvue/state/VueResourceType.kt)
265265
### 1. Create launcher
266266
```kotlin
267267
val launcher = horizontalVueReaderState.getImportLauncher(interceptResult = {file ->
@@ -279,13 +279,20 @@ horizontalVueReaderState.launchImportIntent(
279279
launcher = launcher
280280
)
281281
```
282-
This launcher should be used when preview is required to be on next screen
282+
## General file picker to import image from gallery/camera, pdf from device storage
283283
### 1. Create launcher
284284
```kotlin
285285
val vueFilePicker = rememberSaveable(saver = VueFilePicker.Saver) {
286286
VueFilePicker()
287287
}
288-
val launcher = vueFilePicker.getLauncher()
288+
val launcher = vueFilePicker.getLauncher(
289+
interceptResult = {
290+
//Perform file operation on imported file
291+
},
292+
onResult = {
293+
//Get the final file
294+
}
295+
)
289296
```
290297
### 2. Launch Import Intent
291298
```kotlin
@@ -300,28 +307,6 @@ vueFilePicker.launchIntent(
300307
launcher = launcher
301308
)
302309
```
303-
### 3. VueFilePicker States
304-
```kotlin
305-
val filePickerState = vueFilePicker.vueFilePickerState
306-
when(filePickerState){
307-
VueFilePickerState.VueFilePickerIdeal -> {
308-
/**
309-
* State when no file has been picked yet
310-
* */
311-
}
312-
is VueFilePickerState.VueFilePickerImported -> {
313-
/**
314-
* State when file has been imported
315-
* file uri can be retrieved by (filePickerState as VueFilePickerState.VueFilePickerImported).uri
316-
* file type can be retrieved by (filePickerState as VueFilePickerState.VueFilePickerImported).getFileType(context)
317-
*
318-
* Navigate to preview screen and load pdf by using Local resource type
319-
* Or just share the file
320-
* */
321-
322-
}
323-
}
324-
```
325310
# Share PDF
326311
```kotlin
327312
horizontalVueReaderState.sharePDF(context)

0 commit comments

Comments
 (0)