Fragula 使用指南

Fragula 使用指南

Fragula 🧛 Fragula is a swipe-to-dismiss extension for navigation component library for Android 项目地址: https://gitcode.com/gh_mirrors/fr/Fragula

1. 项目目录结构及介绍

Fragula 是一个专为Android设计的滑动解散扩展组件，用于导航组件库。其仓库遵循清晰的组织结构。以下是关键的目录结构及其简介：

• [fragula-core]: 核心模块，包含了实现滑动解散功能的基础类和方法。
• [fragula-compose]: 特定于Jetpack Compose的支持模块，添加此依赖可以将Fragula的功能集成到Compose应用中。
• [editorconfig] 和 [gitignore]: 维护代码风格一致性与忽略特定文件或模式。
• [LICENSE]: 许可证文件，表明该项目采用Apache-2.0许可协议。
• [README.md]: 项目的主要说明文件，提供了快速入门指导和详细使用方法。
• 构建相关文件如 build.gradle, gradle.properties, settings.gradle.kts, 以及Gradle Wrapper的文件(gradlew, gradlew.bat)，用于编译和管理项目。

2. 项目启动文件介绍

在实际应用中，无需直接操作Fragula项目的源码作为启动点。不过，要启用Fragula特性，你需要在你的Android应用程序中的主要Activity布局文件（通常为activity_main.xml）进行以下修改：

• 将原本的NavHostFragment替换为FragulaNavHostFragment，确保导航的核心组件能够支持滑动解散功能。

示例代码段：

<androidx.fragment.app.FragmentContainerView
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:name="com.fragula2.FragulaNavHostFragment"
    android:id="@+id/nav_host"
    app:navGraph="@navigation/nav_graph"
    app:defaultNavHost="true"/>

3. 项目的配置文件介绍

Gradle 配置

为了使项目能够使用Fragula，你需要在应用级别的build.gradle文件中添加相应的依赖项：

dependencies {
    implementation 'com.fragula2:fragula-core:2.10.1'
}

如果你的应用使用了Jetpack Compose，则需要额外添加对fragula-compose的依赖。

此外，在你的项目根目录下的build.gradle中，确保已经设置了JitPack仓库以获取最新版本的Fragula，如果从较旧的文档参考而来。

Navigation Graph XML

另一个重要的“配置”文件是你项目的Navigation Graph (nav_graph.xml)。在这里，你需将传统 <fragment> 转换成 <swipeable>，以标记那些支持滑动解散的页面。

示例：

<navigation>
    <swipeable android:id="@+id/detailFragment"
               android:name="com.example.fragula.DetailFragment">
        <!-- 可以在这里定义参数 -->
    </swipeable>
</navigation>

通过上述步骤，你可以配置并启动具备Fragula功能的Android应用，享受滑动解散带来的流畅用户体验。记住，合理的配置和遵循项目文档是成功集成的关键。

Fragula 🧛 Fragula is a swipe-to-dismiss extension for navigation component library for Android 项目地址: https://gitcode.com/gh_mirrors/fr/Fragula