Skip to content

Commit a1e9a3c

Browse files
committed
文档整理完善
1 parent 0b76dc6 commit a1e9a3c

15 files changed

+281
-46
lines changed

SUMMARY.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,17 @@
101101
* [lib-theme](use/libs/ui/lib-theme.md)
102102
* [lib-lock-screen](use/libs/ui/lib-lock-screen.md)
103103
* [lib-widget](use/libs/ui/lib-widget.md)
104-
* [路由相关]()
105-
* [lib-router](use/libs/router/lib-router.md)
106-
* [lib-router-compiler](use/libs/router/lib-router-compiler.md)
107-
* [lib-router-annotation](use/libs/router/lib-router-annotation.md)
104+
* [路由组件信息]()
105+
* [lib-router](use/libs/router/lib-router.md)
106+
* [lib-router-compiler](use/libs/router/lib-router-compiler.md)
107+
* [lib-router-annotation](use/libs/router/lib-router-annotation.md)
108+
* [三方组件信息]()
109+
* [三方组件集]()
110+
* [common-wrapper](use/services/services-wrapper.md)
111+
* [三方组件]()
112+
* [services-google-pay](use/services/services-google-pay.md)
113+
* [services-google-ad](use/services/services-google-ad.md)
114+
* [services-google](use/services/services-google.md)
108115
* [框架使用]()
109116
* [运行Demo](sample/start.md)
110117
* [独立开发](sample/customize.md)

use/common/common-permission.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# CommonPermission
2+
3+
![CommonPermission](https://img.shields.io/badge/AndroidAppFactory-CommonPermission-brightgreen)
4+
[ ![Github](https://img.shields.io/badge/Github-CommonPermission-brightgreen?style=social) ](https://github.com/bihe0832/AndroidAppFactory/tree/master/CommonPermission)
5+
[ ![Maven Central](https://img.shields.io/maven-central/v/com.bihe0832.android/common-permission) ](https://search.maven.org/artifact/com.bihe0832.android/common-permission)
6+
7+
## 功能简介
8+
9+
关于权限相关功能的二次封装
10+
11+
## 组件使用
12+
13+
#### 引用仓库
14+
15+
引用仓库可以参考 [组件使用](./../start.md) 中添加依赖的部分
16+
17+
#### 组件使用
18+
19+
```groovy
20+
implementation 'com.bihe0832.android:common-permission:+'
21+
```
22+
23+
## 组件功能
24+
25+
### AAFPermissionManager
26+
27+
- 权限获取、检查、权限相关的文案、图标配置、发起权限申请
28+
29+
### PermissionFragment && PermissionItem
30+
31+
- 设置中关于使用权限的列表展示
32+
33+
### PermissionsActivityWithSpecial
34+
35+
- 一些特殊权限的申请UI,目前仅包含位置权限

use/libs/noui/lib-android-os.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,10 @@ implementation 'com.bihe0832.android:lib-android-os:+'
2222

2323
## 组件功能
2424

25-
### OSUtils
25+
### BuildUtils
2626

27-
- 根据进程ID获取进程名
27+
- 合规的获取 SDK 版本号,系统版本等信息
2828

29-
- 当前系统版本,API 版本,是不是Android Q
30-
3129
### DisplayUtil
3230

3331
- 隐藏软键盘、虚拟导航判断
@@ -36,3 +34,17 @@ implementation 'com.bihe0832.android:lib-android-os:+'
3634

3735
- dp,sp,px 等各类数据单位之间转换
3836

37+
#### ManufacturerUtil
38+
39+
- 获取厂商、品牌、型号等基本信息
40+
41+
- 获取当前使用语言
42+
43+
- 是否指定厂商、对应厂商的操作系统版本
44+
45+
### OSUtils
46+
47+
- 根据进程ID获取进程名
48+
49+
- 当前系统版本,API 版本,是不是Android Q
50+

use/libs/noui/lib-device-network.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,19 @@ implementation 'com.bihe0832.android:lib-device-network:+'
2828

2929
- 获取设备当前电量等级及充电状态
3030

31-
#### DeviceIDUtils
32-
33-
- 获取各种类型的设备ID,例如:Imei、Mac 地址、AndroidID、CID
34-
35-
#### ManufacturerUtil
31+
#### ShakeManager
3632

37-
- 获取厂商、品牌、型号等基本信息
33+
- 手机传感器封装,通用的摇一摇实现
3834

39-
- 获取当前使用语言
35+
#### DeviceIDUtils
4036

41-
- 是否指定厂商、对应厂商的操作系统版本
37+
- 获取各种类型的设备ID,例如:Imei、Mac 地址、AndroidID、CID
4238

43-
#### ShakeManager
39+
### 网络相关
4440

45-
- 手机传感器封装,通用的摇一摇实现
41+
#### ARPUtils
4642

47-
### 网络相关
43+
- 发送 UDP 信息,发送ARP请求
4844

4945
#### DeviceInfoManager
5046

@@ -64,6 +60,10 @@ implementation 'com.bihe0832.android:lib-device-network:+'
6460

6561
- 根据运营商代码 获取运营商名称
6662

63+
#### MacUtils
64+
65+
- 根据 ARP 表 获取 IP 对应的 Mac地址
66+
6767
#### MobileUtil
6868

6969
- 获取信号强度、移动网络是否可用、周边基站信息
@@ -75,3 +75,7 @@ implementation 'com.bihe0832.android:lib-device-network:+'
7575
#### WifiManagerWrapper
7676

7777
- 获取Wi-Fi 基本信息类的封装
78+
79+
#### WifiUtil
80+
81+
- 实现WIFI相关的网络信息获取方法,周边设备、信道、信号强度等

use/libs/noui/lib-encrypt.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,11 @@ implementation 'com.bihe0832.android:lib-encrypt:+'
2626
### AESUtils
2727

2828
- 各种类型的AES(自定义向量或无向量加密)计算,结果支持返回Base64、16进制字符串等
29-
29+
30+
### GzipUtils
31+
32+
- Gzip 的压缩与解压
33+
3034
### HexUtils
3135

3236
- 十六进制转换
@@ -43,6 +47,18 @@ implementation 'com.bihe0832.android:lib-encrypt:+'
4347

4448
- 通用的MessageDigest,MD5、SHA256底层都是调用它
4549

46-
### GzipUtils
50+
### RSAUtils
51+
52+
- RSA 加解密,支持"RSA/ECB/OAEPWithSHA-256AndMGF1Padding"、"RSA/ECB/PKCS1Padding" 等
53+
54+
### ZlibUtil
55+
56+
- 字符数组的压缩与解压缩
57+
58+
### AESKeyStoreUtils
59+
60+
- 基于系统提供的利用 Android Keystore 生成秘钥的 AES 加解密
61+
62+
### RSAKeyStoreUtils
4763

48-
- Gzip 的压缩与解压
64+
- 基于系统提供的利用 Android Keystore 生成秘钥的 RSA 加解密

use/libs/ui/lib-custom-view.md

+35
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,38 @@ implementation 'com.bihe0832.android:lib-custom-view:+'
4242

4343
- bgtv_isWidthHeightEqual:圆角矩形宽高相等,取较宽高中大值
4444

45+
### TextViewWithBackground
46+
47+
- 支持动态修改TextView背景,支持动态的内容有:
48+
49+
- bgtv_backgroundColor:背景色
50+
51+
- bgtv_cornerRadius:圆角弧度,单位dp
52+
53+
- bgtv_strokeWidth:圆角边框厚度,单位dp
54+
55+
- bgtv_strokeColor:圆角边框颜色
56+
57+
- bgtv_isRadiusHalfHeight:圆角弧度是高度一半
58+
59+
- bgtv_isWidthHeightEqual:圆角矩形宽高相等,取较宽高中大值
60+
61+
### TextViewWithBackgroundExt
62+
63+
- 基于Kotlin的扩展函数添加的 TextViewWithBackground 的扩展,使用 TextViewWithBackground 完成红点提醒的相关功能
64+
65+
### AccCircleProgress
66+
67+
- 圆环进度自定义View
68+
69+
### SlideFinishLayout
70+
71+
- 滑动解锁,此时整个UI右移
72+
73+
### SwipeMenuLayout
74+
75+
- 左滑删除
76+
77+
### SlideViewLayout
78+
79+
- 仿滑动解锁等滑动特效,仅内部LockBtn 在范围内滑动

use/libs/ui/lib-dialog.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ implementation 'com.bihe0832.android:lib-dialog:+'
3939

4040
- 封装对于多来源弹框但是只弹一次的通用处理逻辑,可参考:`AAFUniqueDialogManager`
4141

42+
### InputDialogUtils
43+
44+
- 支持输入的Dialog,基本用法同CommonDialog,仅增加一个输入框
45+
4246
### CommonDialog
4347

4448
- 通用弹框,所有组件显示可控,调用方式可以参考 `BaseTest` 里面的 `TestDialogFragment`,显示样式参考:
@@ -61,10 +65,6 @@ implementation 'com.bihe0832.android:lib-dialog:+'
6165

6266
<img src="./lib-dialog-radio.png" />
6367

64-
### InputDialog
65-
66-
- 支持输入的Dialog,基本用法同CommonDialog,仅增加一个输入框
67-
6868
### PopMenu
6969

7070
- 在指定View周围弹出一个带图标的菜单列表(类似右上角),调用方式可以参考 `BaseTest` 里面的 `TestTextView`
@@ -80,3 +80,7 @@ implementation 'com.bihe0832.android:lib-dialog:+'
8080
### BottomListDialog
8181

8282
- 底部弹出的,支持列表选的Dialog
83+
84+
### ImageDialog
85+
86+
- 纯图片Dialog

use/libs/ui/lib-textview.md

+9-20
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,6 @@ implementation 'com.bihe0832.android:lib-textview:+'
2323

2424
## 组件功能
2525

26-
### TextViewWithBackground
27-
28-
- 支持动态修改TextView背景,支持动态的内容有:
29-
30-
- bgtv_backgroundColor:背景色
31-
32-
- bgtv_cornerRadius:圆角弧度,单位dp
33-
34-
- bgtv_strokeWidth:圆角边框厚度,单位dp
35-
36-
- bgtv_strokeColor:圆角边框颜色
37-
38-
- bgtv_isRadiusHalfHeight:圆角弧度是高度一半
39-
40-
- bgtv_isWidthHeightEqual:圆角矩形宽高相等,取较宽高中大值
41-
42-
### TextViewWithBackgroundExt
43-
44-
- 基于Kotlin的扩展函数添加的 TextViewWithBackground 的扩展,使用 TextViewWithBackground 完成红点提醒的相关功能
45-
4626
### ExpandableTextView
4727

4828
- 可扩展TextView,用于扩展收起、展开、固定行尾字符等,具体的使用事例,可以参考 BaseTest 中 com.bihe0832.android.base.test.textview 下面的代码。支持自定义的内容有:
@@ -81,6 +61,14 @@ implementation 'com.bihe0832.android:lib-textview:+'
8161

8262
- 基于 ExpandableTextView 优化的收起展开型TextView
8363

64+
### HintTextView
65+
66+
- 渐变色的TextView
67+
68+
### MarqueeTextView
69+
70+
可滚动的Textview
71+
8472
### TextViewWithHTML
8573

8674
- 默认就支持HTML的TextView
@@ -98,3 +86,4 @@ implementation 'com.bihe0832.android:lib-textview:+'
9886
- ZixieTextImageSpan:图标扩展
9987

10088
- ZixieTextRadiusBackgroundSpan:圆角背景、文字边框等扩展
89+
File renamed without changes.

use/services/services-google-ad.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# ServicesGoogleAD
2+
3+
![ServicesGoogleAD](https://img.shields.io/badge/AndroidAppFactory-ServicesGoogleAD-brightgreen)
4+
[ ![Github](https://img.shields.io/badge/Github-ServicesGoogleAD-brightgreen?style=social) ](https://github.com/bihe0832/AndroidAppFactory/tree/master/ServicesGoogleAD)
5+
![Maven Central](https://img.shields.io/maven-central/v/com.bihe0832.android/services-google-ad)
6+
7+
## 功能简介
8+
9+
对谷歌广告SDK的二次封装
10+
11+
## 组件信息
12+
13+
#### 引用仓库
14+
15+
引用仓库可以参考 [组件使用](./../start.md) 中添加依赖的部分
16+
17+
#### 组件使用
18+
19+
```groovy
20+
implementation 'com.bihe0832.android:services-google-ad:+'
21+
```
22+
23+
## 组件功能
24+
25+
### AAFGoogleAD
26+
27+
- 对谷歌广告SDK的二次封装的总出口,提供广告预加载、插屏、Banner、激烈视频多种广告的调用实现
28+
29+
### BannerADManager
30+
31+
- 对 Banner 广告相关处理的封装
32+
33+
### InterstitialAdManager
34+
35+
- 对 InterstitialAd 相关处理的封装
36+
37+
### RewardedAdManager
38+
39+
- 对 RewardedAd 相关处理的封装
40+
41+
### RewardedInterstitialAdManager
42+
43+
- 对带有激励属性的 InterstitialAd 相关处理的封装
44+
45+
46+

use/services/services-google-pay.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# ServicesGooglePay
2+
3+
![ServicesGooglePay](https://img.shields.io/badge/AndroidAppFactory-ServicesGooglePay-brightgreen)
4+
[ ![Github](https://img.shields.io/badge/Github-ServicesGooglePay-brightgreen?style=social) ](https://github.com/bihe0832/AndroidAppFactory/tree/master/ServicesGooglePay)
5+
![Maven Central](https://img.shields.io/maven-central/v/com.bihe0832.android/services-google-pay)
6+
7+
## 功能简介
8+
9+
对谷歌支付SDK的二次封装
10+
11+
## 组件信息
12+
13+
#### 引用仓库
14+
15+
引用仓库可以参考 [组件使用](./../start.md) 中添加依赖的部分
16+
17+
#### 组件使用
18+
19+
```groovy
20+
implementation 'com.bihe0832.android:services-google-pay:+'
21+
```
22+
23+
## 组件功能
24+
25+
### AAFGooglePay
26+
27+
- 对谷歌支付SDK的二次封装的总出口,提供拉取商品列表,创建订单,订阅支付等
28+
29+
### AAFGooglePayListener
30+
31+
- 支付回调

0 commit comments

Comments
 (0)