Spotlight
Gradle
dependencies {
implementation 'com.github.takusemba:spotlight:x.x.x'
}
Usage
val spotlight = Spotlight.Builder(this)
.setTargets(firstTarget, secondTarget, thirdTarget ...)
.setBackgroundColor(R.color.spotlightBackground)
.setDuration(1000L)
.setAnimation(DecelerateInterpolator(2f))
.setContainer(viewGroup)
.setOnSpotlightListener(object : OnSpotlightListener {
override fun onStarted() {
Toast.makeText(this@MainActivity, "spotlight is started", Toast.LENGTH_SHORT).show()
}
override fun onEnded() {
Toast.makeText(this@MainActivity, "spotlight is ended", Toast.LENGTH_SHORT).show()
}
})
.build()
If you want to show Spotlight immediately, you have to wait until views are laid out.
// with core-ktx method.
view.doOnPreDraw { Spotlight.Builder(this)...start() }
Target
Create a Target to add Spotlight.
Target is a spot to be casted by Spotlight. You can add multiple targets to Spotlight.
val target = Target.Builder()
.setAnchor(100f, 100f)
.setShape(Circle(100f))
.setEffect(RippleEffect(100f, 200f, argb(30, 124, 255, 90)))
.setOverlay(layout)
.setOnTargetListener(object : OnTargetListener {
override fun onStarted() {
makeText(this@MainActivity, "first target is started", LENGTH_SHORT).show()
}
override fun onEnded() {
makeText(this@MainActivity, "first target is ended", LENGTH_SHORT).show()
}
})
.build()
Start/Finish Spotlight
val spotlight = Spotlight.Builder(this)...start()
spotlight.finish()
Next/Previous/Show Target
val spotlight = Spotlight.Builder(this)...start()
spotlight.next()
spotlight.previous()
spotlight.show(2)
Custom Shape
Shape defines how your target will look like. Circle and RoundedRectangle shapes are already implemented, but if you want your custom shape, it's arhivable by implementing Shape interface.
class CustomShape(
override val duration: Long,
override val interpolator: TimeInterpolator
) : Shape {
override fun draw(canvas: Canvas, point: PointF, value: Float, paint: Paint) {
// draw your shape here.
}
}
Custom Effect
Effect allows you to decorates your target. RippleEffect and FlickerEffect shapes are already implemented, but if you want your custom effect, it's arhivable by implementing Effect interface.
class CustomEffect(
override val duration: Long,
override val interpolator: TimeInterpolator,
override val repeatMode: Int
) : Effect {
override fun draw(canvas: Canvas, point: PointF, value: Float, paint: Paint) {
// draw your effect here.
}
}
Sample
Clone this repo and check out the app module.
Author
- Taku Semba
- Github - (https://github.com/takusemba)
- Twitter - (https://twitter.com/takusemba)
- Facebook - (https://www.facebook.com/takusemba)
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.
1.7k Nov 10, 2022
1.1k Dec 22, 2022
7 Dec 15, 2022
3k Jan 5, 2023
1.5k Jan 2, 2023
103 Oct 12, 2022
33 Dec 8, 2022
6.1k Dec 29, 2022
1.7k Nov 21, 2022
1.4k Dec 26, 2022
9.4k Dec 31, 2022
2.7k Dec 27, 2022
318 Dec 7, 2022
483 Nov 25, 2022
988 Nov 24, 2022
5 Sep 13, 2022
654 Dec 2, 2022
606 Nov 26, 2022