# AndroidDocViewer

**Repository Path**: panhstrevor/AndroidDocViewer

## Basic Information

- **Project Name**: AndroidDocViewer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-30
- **Last Updated**: 2025-09-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

当前版本：[![](https://jitpack.io/v/seapeak233/AndroidDocViewer.svg)](https://jitpack.io/#seapeak233/AndroidDocViewer)

# AndroidDocViewer
Android文档本地预览方案<持续优化中...>

## 前言
自从腾讯X5的TBSReader收费之后，我一直在搜索可用的原生离线预览文件的方案，经过一番查找，各类方案都有或多或少的缺失。  
在转换思路之后发现，JS的方案对比原生来说，选型的成熟度高太多了，且浏览器支持可缩放的行为，可以极大的减少原生手势相关的工作量。  
所以，该项目的思路是：将各类文档预览可用的JS方案打包成html+css+js，存放到Android的assets目录，使用webView加载本地html。

## TODO LIST
- [x] 支持pdf
- [x] 支持word
- [x] 支持ppt
- [x] 支持excel
- [x] 支持txt
- [x] 支持Markdown
------ 
- [x] 支持Fragment引用的形式
- [ ] 支持View引用的形式
- [ ] 支持在线加载状态

## 使用
* 引入aar:
```
implementation 'com.github.seapeak233:AndroidDocViewer:<Tag>'
```
* 提供了一个Fragment容器，将DocConfig内容放入其中
```
// DocConfig(:url(文件链接), :type(预览类型DocType))
// DocType 的类型有五种 TXT, WORD, EXCEL, PPT, PDF
// 用法DEMO 👇👇👇
val config = DocConfig("file:///android_asset/sample3.xls", DocType.EXCEL)
val fragment = DocViewerFragment.newInstance(config)
// 将DocViewerFragment放入Activity提供的容器中即可预览
```
* 或者直接查看 [MainActivity](https://github.com/seapeak233/AndroidDocViewer/blob/main/app/src/main/java/com/seapeak/example/MainActivity.kt) 和 [PreviewActivity](https://github.com/seapeak233/AndroidDocViewer/blob/main/app/src/main/java/com/seapeak/example/PreviewActivity.kt)

## 实际截图
![Excel预览](https://github.com/seapeak233/AndroidDocViewer/blob/main/static/excel_shot.png)
![Pdf预览](https://github.com/seapeak233/AndroidDocViewer/blob/main/static/pdf_shot.png)
![PPT预览](https://github.com/seapeak233/AndroidDocViewer/blob/main/static/ppt_shot.png)
![Word预览](https://github.com/seapeak233/AndroidDocViewer/blob/main/static/word_shot.png)

## 非常感谢方案思路
| 名称           | 仓库链接                                              | 版本号      |
| -------------- | ----------------------------------------------------- | ----------- |
| sheetjs        | [sheetjs](https://github.com/SheetJS/sheetjs)         | 0.20.3      |
| pdfjs          | [pdfjs](https://github.com/mozilla/pdf.js)            | 4.0.269     |
| pptx-preview   | [pptx-preview](https://github.com/501351981/pptx-preview) | 1.0.6   |
| docxjs         | [docxjs](https://github.com/VolodymyrBaydalka/docxjs) | 0.3.6       |