ScratchCardLayout 开源项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00054/article/details/141991200

ScratchCardLayout 开源项目教程

scratchCardLayoutScratch card reveal effect inspired by Google pay, PhonePe and Zomato scratch card reward system.项目地址:https://gitcode.com/gh_mirrors/sc/scratchCardLayout

1. 项目介绍

ScratchCardLayout 是一个用于 Android 的开源库，旨在为任何视图添加刮刮卡效果。该库灵感来源于 Google Pay、PhonePe 和 Zomato 等应用中的刮刮卡奖励系统。通过使用 ScratchCardLayout，开发者可以轻松地将刮刮卡效果应用于任何复杂的布局，并支持自定义刮痕宽度、启用/禁用刮痕效果、设置刮痕图层（颜色或图像）等功能。此外，ScratchCardLayout 还提供了回调接口，以便在刮痕开始、进行和完成时获取通知。

2. 项目快速启动

2.1 添加依赖

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

dependencies {
    implementation 'in.codeshuffle:scratchcardlayout:1.0.8'
}

2.2 在 XML 布局中使用

在 XML 布局文件中，使用 ScratchCardLayout 包裹你想要添加刮刮卡效果的视图：

<in.codeshuffle.scratchcardview.ui.ScratchCardLayout
    android:id="@+id/scratchCard"
    android:layout_width="250dp"
    android:layout_height="250dp"
    android:layout_centerInParent="true"
    app:scratchWidth="40dp"
    app:scratchEnabled="true"
    app:scratchDrawable="@drawable/your_drawable"
    app:scratchRevealFullAtPercent="100">
    <!-- 你的复杂视图 -->
</in.codeshuffle.scratchcardview.ui.ScratchCardLayout>

2.3 在 Java 代码中配置

在 Java 代码中，获取 ScratchCardLayout 的引用并进行配置：

// 获取视图引用
ScratchCardLayout scratchCardLayout = findViewById(R.id.scratchCard);

// 设置刮痕图层（程序化）
scratchCardLayout.setScratchDrawable(getResources().getDrawable(R.drawable.car));

// 设置刮痕宽度
scratchCardLayout.setScratchWidth(30f);

// 当刮痕达到一定百分比时完全显示布局
scratchCardLayout.setRevealFullAtPercent(40);

// 启用/禁用刮痕效果
scratchCardLayout.setScratchEnabled(true);

// 移除所有已刮痕
scratchCardLayout.resetScratch();

// 显示刮痕卡（显示布局效果）
scratchCardLayout.revealScratch();

2.4 实现回调接口

如果需要监听刮痕的开始、进度和完成事件，可以实现 ScratchListener 接口：

// 在你的类中实现 ScratchListener 接口
public class YourClass extends SomeBaseClass implements ScratchListener {

    // 设置监听器
    scratchCardLayout.setScratchListener(this);

    // 刮痕开始
    @Override
    public void onScratchStarted() {
        // 处理刮痕开始事件
    }

    // 刮痕进度
    @Override
    public void onScratchProgress(ScratchCardLayout scratchCardLayout, int atLeastScratchedPercent) {
        // 处理刮痕进度事件
    }

    // 刮痕完成
    @Override
    public void onScratchComplete() {
        // 处理刮痕完成事件
    }
}