Spotlight

KO | EN

gitlite — search

#hacktoberfest #llm #go #android #machine-learning #rust #linux #docker #nodejs #cli #kubernetes #vue #awesome-list #ios

(★ 48)

A elegant and fun way to help a user understand specific parts of your application.

Spotlight 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Spotlight

[![](https://jitpack.io/v/nicholasmata/spotlight.svg)](https://jitpack.io/#nicholasmata/spotlight)
[![Android 24 +](https://img.shields.io/badge/Android-24+-blue.svg)](https://developer.android.com/studio/releases/platforms#7.0)
<p align="center">
<img src="./screenshots/sample.gif" width="300">

## Overview
A great way to add tutorials to your Android application. Simple to use and highly customizable.

* [Installation](#installation)
* [Basic Usage](#basic-usage)
* [Advanced Usage](#advanced-usage)
    * [Themes](#themes)
    * [Layout Manager](#layout-manager)

### Why use this library over others?
I know there are many libraries available to do achieve a similiar goal. The reason I developed this library was because all the libraries I have used in the past were very limited in feature set and expandibility.

## Installation
### Gradle
Add JitPack repository to your app's `build.gradle`
```gradle
allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
```
Add the dependency to your app's `build.gradle`
```gradle
implementation 'com.github.nicholasmata:spotlight:0.2.0'
```

## Basic Usage

```kt
// 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()
```

## Advanced Usage

### Themes

In it's current implementation it only contains one theme called `simple`.<br/>
`simple` is the default theme

**How do I modify the background style?** Default is transparent dark gray<br/>
**How do I modify the target views style?** Default is clear/transparent

This can be achieved by creating a custom class `SpotlightStyler` and setting the `styler` property on the `SpotlightView` instance.

**How do I implement a custom message view?**<br/>
**How do I implement a custom indicator view?**

This is done by creating layout xml resources and setting `messageLayout` and `indicatorLayout` on the `SpotlightView` instance.

### Layout Manager

By default the `SpotlightView` uses `DefaultLayoutManager`. This is the libraries default implementation of `SpotlightLayoutManager` used to layout/position the message and indicator view. This works by choosing a side of the target view with the largest empty space.

Spotlight

Spotlight 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Spotlight

Spotlight 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README