-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* jetpack compose doc * android sdk v4.4.0
- Loading branch information
Showing
22 changed files
with
212 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| --- | ||
| sidebar_position: 13 | ||
| title: Compose 模块 | ||
| --- | ||
|
|
||
| Growingio 无埋点 SDK 支持 Jetpack Compose 框架，包括页面事件，无埋点点击事件和圈选功能。 | ||
|
|
||
| -------- | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| ### SDK说明 | ||
| | 关键词 | 是否集成| 输入数据类 | 输出数据类 | 最低SDK版本 | | ||
| | :------- | :------: | --:| ---:| :---| | ||
| | compose | 需要手动集成 | `ComposeData` | `ComposeJson` | 4.4.0 | | ||
|
|
||
| ### 依赖方式 | ||
| <Tabs | ||
| groupId="code-language" | ||
| defaultValue="common" | ||
| values={[ | ||
| {label: '依赖', value: 'common'}, | ||
| {label: 'BoM', value: 'bom'}, | ||
| ] | ||
| }> | ||
|
|
||
| <TabItem value="common"> | ||
|
|
||
| ```groovy | ||
| dependencies { | ||
| implementation 'com.growingio.android:compose:4.4.0' | ||
| } | ||
| ``` | ||
| </TabItem> | ||
|
|
||
| <TabItem value="bom"> | ||
|
|
||
| ```groovy | ||
| dependencies { | ||
| // Import the BoM for the GrowingIO platform | ||
| implementation platform('com.growingio.android:autotracker-bom:4.4.0') | ||
| implementation 'com.growingio.android:compose' | ||
| } | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ### 使用方式 | ||
|
|
||
| 1. 初始化时添加 ComposeLibraryGioModule 模块 | ||
|
|
||
| ```kotlin | ||
| GrowingAutotracker.startWithConfiguration(this, | ||
| AutotrackConfiguration("accountId", "urlScheme") | ||
| //... | ||
| .addPreloadComponent(ComposeLibraryGioModule())) | ||
| ``` | ||
|
|
||
| 2. 引入 Kotlin Compiler Plugin 插件 | ||
|
|
||
| 在引入无埋点插件的前提下，添加新的KCP插件. | ||
|
|
||
| ```toml | ||
| [plugins] | ||
| growingio-compose-plugin = {id = "com.growingio.compose.plugin",version = "4.4.0"} | ||
| ``` | ||
|
|
||
| ```groovy | ||
| plugins { | ||
| //id 'com.growingio.compose.plugin' | ||
| alias(libs.plugins.growingio.compose.plugin) | ||
| } | ||
| ``` | ||
|
|
||
| > 该KCP插件主要为无埋点事件控件的路径`xpath`赋予可读性更高的名称。理论上不集成该插件也能正常发送无埋点事件。 | ||
| 最后不要忘记在项目下的`build.gradle`中声明该插件 | ||
| ```groovy | ||
| plugins { | ||
| alias libs.plugins.growingio.compose.plugin apply false | ||
| } | ||
| ``` | ||
|
|
||
| 3. 设置无埋点页面 | ||
|
|
||
| 在 `@composable` 组件下将要声明的页面组件使用 `GrowingComposePage` 包裹。各个参数分别为：`alias`为页面唯一识别名称，`modifier`为需要的组件修饰符，`attributes`为页面属性，`content`则为作为Page的 composable 组件内容。 | ||
|
|
||
| ```kotlin | ||
| GrowingComposePage( | ||
| alias = "PageName", | ||
| modifier: Modifier = Modifier, | ||
| attributes: Map<String, String> = hashMapOf(), | ||
| content = { | ||
| PageScreen( | ||
| modifier = modifier, | ||
| //... | ||
| ) | ||
| } | ||
| ) | ||
| ``` | ||
| 至此，compose 无埋点框架配置完成。 | ||
|
|
||
| :::warning Dialog | ||
| 直接包裹AlertDialog将只会发送Page事件，无埋点事件的path无法与page事件绑定。原因为Compose的AlertDialog是一个新的window渲染而来，无法直接穿透获取，所以无埋点事件无法向上遍历得到page节点的alias值。这边建议将page页面包裹AlertDialog的下一级组件。 | ||
| ::: | ||
|
|
||
| ### 无埋点的配置接口 | ||
|
|
||
| 1. `Modifier.growingTag(tag: String)` 为设置的组件设置别名，反映在无埋点事件的`xpath`路径中; | ||
| 2. `Modifier.interruptClick()` 在GrowingIO Compose SDK 中获取点击组件是由上而下遍历的且取最后一个可点击组件的过程，所以当多个可点击组件重叠时会优先取到最后面的组件。使用该方法可以控制无埋点事件优先取到 `interruptClick` 装饰的组件； | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.