# Guide

**Repository Path**: mlethe/Guide

## Basic Information

- **Project Name**: Guide
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-31
- **Last Updated**: 2026-02-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 引导组件

### 简介

Guide，是一款的高性能、高可定制的新手引导组件库，支持自定义蒙版颜色、透明度。支持完全自定义提示样式。

- **交互穿透 (Interactive Pass-through)**：支持挖孔响应机制，允许用户直接点击高亮区域内的组件（如点击、长按、拖动组件），实现“边引导，边操作”的沉浸式体验。
- **自由定制提示UI**：支持通过继承 Component 传入自定义的 View 实现自定义样式。
- **多种形状支持**：内置圆形 (Circle)、矩形&圆角矩形 (RoundRect) 、自定义（Custom）的高亮区域。

## 依赖工程

编辑 `build.gradle`:

```groovy
allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

dependencies {
    implementation 'com.github.Mlethe:Guide:1.0.1'
}
```

## 示例

```kotlin
val guide = GuideBuilder()
    .setTargetView(binding.btnTarget)
    .setTargetGraphStyle(GraphStyle.ROUND_RECT)
    .setTargetRadius(50)
    .setPadding(30)
//.setTargetGraphStyle(GraphStyle.CUSTOM) // 自定义高亮区域形状
//.setShape(CustomShape()) // 自定义高亮区的实现
    .setInterceptTouchTarget(false)
    .addComponent(CustomComponent("矩形-目标上面", Component.ANCHOR_TOP) {
        Toast.makeText(this, "下一步", Toast.LENGTH_SHORT).show()
        guide?.dismiss()
        nextGuide(binding.btnTarget)
    })
    .addComponent(CustomComponent("矩形-目标左边", Component.ANCHOR_LEFT))
    .addComponent(CustomComponent("矩形-目标右边", Component.ANCHOR_RIGHT))
    .addComponent(CustomComponent("矩形-目标下面", Component.ANCHOR_BOTTOM))
    .addComponent(BottomComponent("目标组件可以点击"))
    .setOnSlideListener { state ->
        Log.e("guideLog", "滑动方向：$state")
    }
    .setOnShowListener(object : GuideBuilder.OnShowListener {
        override fun onShown() {
            Log.e("guideLog", "矩形引导显示")
        }

        override fun onDismiss() {
            Log.e("guideLog", "矩形引导关闭")
        }
    })
    .createGuide()
    .show(this)
```