Giter Club home page Giter Club logo

spotlight's Introduction

Spotlight

alt text

Platform Download License API

Gradle

dependencies {
    implementation 'com.github.takusemba:spotlight:x.x.x'
}

Usage

Spotlight.with(this)
        .setOverlayColor(R.color.background)
        .setDuration(1000L)
        .setAnimation(new DecelerateInterpolator(2f))
        .setTargets(firstTarget, secondTarget, thirdTarget ...)
        .setClosedOnTouchedOutside(false)
        .setOnSpotlightStateListener(new OnSpotlightStateChangedListener() {
            @Override
            public void onStarted() {
                Toast.makeText(MainActivity.this, "spotlight is started", Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onEnded() {
                Toast.makeText(MainActivity.this, "spotlight is ended", Toast.LENGTH_SHORT).show();
            }
        })
        .start();
                        

if you want to show Spotlight immediately, use addOnGlobalLayoutListener to wait until views are drawn.

view.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver.OnGlobalLayoutListener() {
    @Override public void onGlobalLayout() {
        view.getViewTreeObserver().removeOnGlobalLayoutListener(this);
        Spotlight.with(this)...start();
    }
});


Simple Target

simply set a title and description, these position will be automatically calculated.

SimpleTarget simpleTarget = new SimpleTarget.Builder(this)
    .setPoint(100f, 340f)
    .setShape(new Circle(200f)) // or RoundedRectangle()
    .setTitle("the title")
    .setDescription("the description")
    .setOverlayPoint(100f, 100f)
    .setOnSpotlightStartedListener(new OnTargetStateChangedListener<SimpleTarget>() {
        @Override
        public void onStarted(SimpleTarget target) {
            // do something
        }
        @Override
        public void onEnded(SimpleTarget target) {
            // do something
        }
    })
    .build();


Custom Target

use your own custom view.

CustomTarget customTarget = new CustomTarget.Builder(this)
    .setPoint(100f, 340f)
    .setShape(new Circle(200f)) // or RoundedRectangle()
    .setOverlay(view)
    .setOnSpotlightStartedListener(new OnTargetStateChangedListener<CustomTarget>() {
        @Override
        public void onStarted(CustomTarget target) {
            // do something
        }
        @Override
        public void onEnded(CustomTarget target) {
            // do something
        }
    })
    .build();


Skip Target, Skip Spotlight

you can skip the current target or skip the all comming targets.

Spotlight spotlight = Spotlight.with(this)...start();

spotlight.closeCurrentTarget();

spotlight.closeSpotlight();

Custom Shape

custom shape is available implementing Shape interface

public class YourShape implements Shape {

    private float width;
    private float height;

    public YourShape(float width, float height) {
        this.width = width;
        this.height = height;
    }

    @Override
    public void draw(Canvas canvas, PointF point, float value, Paint paint) {
        // draw your shape using canvas.
    }
    ...
}

Sample

Clone this repo and check out the app module.

Change Log

Version: 1.8.0

  • rounded rectangle is added

Version: 1.5.0

  • custom shapes, skip feature

Version: 1.3.0

  • click handling added

Version: 1.2.0

  • overlay color added

Author

Licence

Copyright 2017 Taku Semba.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

spotlight's People

Contributors

adsamcik avatar bowang18 avatar fweinb avatar ghataa avatar jemshit avatar maherhanafi avatar mourjan avatar takusemba avatar xiryl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.