Skip to content

Commit c916e80

Browse files
committed
update readme
1 parent 228b855 commit c916e80

1 file changed

Lines changed: 21 additions & 5 deletions

File tree

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,19 @@ Allow for custom retrievers to be specified and defined to allow custom retrieva
5555
```loadingContent: @Composable BoxScope.()```
5656
This allows for specifying a composable to display during the loading of the pdf from a url.
5757

58-
### Common Parameters
58+
```options: PdfOptions```
59+
Configurable options for controlling how the pdf is viewed, and what actions are available
60+
61+
```pageDivider: @Composable```
62+
Composable that will be displayed between each rendered page of the pdf.
63+
64+
```onClick: ((Offset) -> Unit)?```
65+
Call back for single clicking on the pdf
66+
67+
```onLongClick: ((Offset) -> Unit)?```
68+
Callback for long clicking on the pdf
69+
70+
### PdfOptions Parameters
5971
```maxScale: Float```
6072
Max zoom scaling factor. Defaults to 5 (500%)
6173

@@ -65,11 +77,15 @@ Allow the user to pinch to zoom. Defaults to true.
6577
```backgroundColor: Color```
6678
Background color to display behind the rendered pdf. Defaults to `Color.White`
6779

68-
```pageDivider: @Composable```
69-
Composable that will be displayed between each rendered page of the pdf.
80+
```allowPrinting: Boolean```
81+
Enables the printing functionality that is accessible through `options.print()`. Default: true
82+
83+
```allowSharing: Boolean```
84+
Enables the sharing functionality that is accessible through `options.share()`. Default: true
7085

71-
```enableActions: Boolean```
72-
Enable long pressing the document to show pdf actions such as print document
86+
```removeFileWhenFinished: Boolean```
87+
Removes the downloaded file after the composable falls out of scope or the file passed into the
88+
composable if this is set to true. Default: true
7389

7490
### Example
7591

0 commit comments

Comments
 (0)