ProgressButton 开源项目教程

ProgressButton 开源项目教程

ProgressButtonCustom button class that displays a progress bar around it to gauge项目地址:https://gitcode.com/gh_mirrors/prog/ProgressButton

项目介绍

ProgressButton 是一个用于 Android 的开源库，它允许开发者在不改变布局的情况下，通过几行代码为按钮添加进度显示功能。这个库的主要特点包括：

• 无需布局更改
• 代码简洁易用
• 高度可配置
• 内置淡入淡出动画

项目快速启动

添加依赖

首先，在你的项目的 build.gradle 文件中添加以下依赖：

allprojects {
    repositories {
        mavenCentral()
    }
}

dependencies {
    implementation 'com.github.razir.progressbutton:progressbutton:2.1.0'
}

基本使用

在你的 Activity 中，按照以下步骤使用 ProgressButton：

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)

    // 绑定按钮到 Activity 生命周期
    bindProgressButton(myButton)

    // （可选）启用淡入淡出动画
    myButton.attachTextChangeAnimator()

    // 显示进度，带有 "Loading" 文本
    myButton.showProgress {
        buttonTextRes = R.string.loading
        progressColor = Color.WHITE
    }

    // 隐藏进度，显示 "Submit" 文本
    myButton.hideProgress(R.string.submit)
}

应用案例和最佳实践

显示 AnimatedDrawable

你可以显示一个 AnimatedDrawable 来表示按钮的完成状态：

val animatedDrawable = ContextCompat.getDrawable(this, R.drawable.animated_check)
// 定义的边界是必需的
animatedDrawable?.setBounds(0, 0, animatedDrawable.intrinsicWidth, animatedDrawable.intrinsicHeight)

myButton.showProgress {
    buttonTextRes = R.string.completed
    progressDrawable = animatedDrawable
}

使用 LiveData

你可以直接将 LiveData 集成到按钮中，这样按钮的状态会根据 LiveData 自动改变：

// 这是一个包含所有按钮状态的枚举
enum class ButtonStates {
    LOADING, ENABLED, DISABLED, FINISHED
}

// liveData 变量
val buttonState = MutableLiveData<ButtonStates>()

// 在 Fragment 或 Activity 中
binding.progressButton.attachToLiveData(buttonState)

// 发布按钮状态到 liveData
buttonState.postValue(ButtonStates.LOADING)

典型生态项目

ProgressButton 可以与 Jetpack Compose 结合使用，如果你正在使用 Jetpack Compose，只需调用 ProgressButton 可组合函数：

@Composable
fun ProgressButton(
    buttonState: ButtonState,
    text: String,
    completedText: String
) {
    // 你的实现代码
}

通过这些步骤，你可以轻松地将 ProgressButton 集成到你的 Android 项目中，并利用其强大的功能来提升用户体验。

ProgressButtonCustom button class that displays a progress bar around it to gauge项目地址:https://gitcode.com/gh_mirrors/prog/ProgressButton