خیلی مواقع پیش میاد که میخوایم واسه اپلیکیشن خودمون یکسری راهنما ها رو قرار بدیم تا کاربری که داره باهاش کار میکنه راحتتر متوجه بخش های مختلف اپلیکیشن ما بشه.

برای اینکار، اندروید کتابخونه راهنما زیادی داره و هر کدوم یکسری نکات مثبت و منفی دارن.

توی این پست قصد دارم یکی از اون کتابخونه ها رو معرفی کنم.

قبل از هرچیزی بهتره که یه دمو از کتابخونه ببینی تا با کارکرد اون آشنا بشی

پیشنهایش کتابخونه

بارگذاری کتابخونه ممکنه یکم طول بشه، پس لطفا صبور باش

خب دیگه وقتشه بریم سراغ استفاده از کتابخونه

افزودن به پروژه

برای اینکه بتونی از این کتابخونه راهنما استفاده کنی، باید این کد رو به app/build.gradle اضافه کنی

implementation 'com.github.nicholasmata:spotlight:0.2.0'

اینم باید به project/build.gradle اضافه کنی

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

نحوه استفاده

برای استفاده از این کتابخونه باید با توجه به نیازهات از کدهای زیر استفاده کنی

// Set target views.
val firstView = requireView().findViewById<View>(...)
val secondView = requireView().findViewById<View>(...)
// Use builder to interact with SpotlightView
builder = SpotlightBuilder(requireContext())
    .setInset(20)
    .setTargetView(firstView)
    .setTitle("First View")
    .setDescription("This is the first view")
    .setListener(object : SpotlightListener {
        override fun onEnd(targetView: View?) {
            // This is called when a target view has been dismissed
            when (targetView) {
                firstView -> {
                    // When the first view's spotlight ends then set the  
                    // target view to the second view. 
                    // Update title and description
                    builder
                        .setTitle("Second View")
                        .setDescription("This is the second view")
                        .setTargetView(secondView)
                }
                secondView -> {
                    // When the second view's spotlight ends don't continue on.
                    return
                }
            }
            builder.build().startSpotlight()
        }

        override fun onStart(targetView: View?) {}
    })
builder.build().startSpotlight()

یه خوبی که این کتابخونه داره حالت چند Viewای هم پشتیبانی میکنه.

یعنی اینکه میتونی یه دنباله از راهنماها رو بسازی.

مثلا : اول دکمه فلان رو توضیح بده، بعدش برو سروغ فلان View و الی تا آخر

درضمن، یه نکته ای رو هم باید بگم. اونم اینکه برای استفاده از این کتابخونه minSDK پروژه باید +24 باشه.

دانلود پروژه نمونه