{"id":15025603,"url":"https://github.com/takusemba/spotlight","last_synced_at":"2026-10-18T21:33:50.262Z","repository":{"id":37470866,"uuid":"96007003","full_name":"TakuSemba/Spotlight","owner":"TakuSemba","description":"Android Library that lights items for tutorials or walk-throughs etc...","archived":false,"fork":false,"pushed_at":"2022-12-03T07:25:18.000Z","size":2025,"stargazers_count":3670,"open_issues_count":31,"forks_count":364,"subscribers_count":45,"default_branch":"master","last_synced_at":"2026-09-14T17:15:44.377Z","etag":null,"topics":["android","android-app","android-library","android-ui","java","spotlight","ui","ux"],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TakuSemba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-02T06:42:18.000Z","updated_at":"2026-09-14T03:11:13.000Z","dependencies_parsed_at":"2023-01-22T15:15:17.096Z","dependency_job_id":null,"html_url":"https://github.com/TakuSemba/Spotlight","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/TakuSemba/Spotlight","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TakuSemba%2FSpotlight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TakuSemba%2FSpotlight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TakuSemba%2FSpotlight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TakuSemba%2FSpotlight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TakuSemba","download_url":"https://codeload.github.com/TakuSemba/Spotlight/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TakuSemba%2FSpotlight/sbom","scorecard":{"id":137714,"data":{"date":"2025-08-04","repo":{"name":"github.com/TakuSemba/Spotlight","commit":"d19e4ddc8dc0b2ced3b55d2a34dd68af96692d2d"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":2.9,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 1/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T07:03:50.746Z","repository_id":37470866,"created_at":"2025-08-16T07:03:50.746Z","updated_at":"2025-08-16T07:03:50.746Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38341912,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","android-app","android-library","android-ui","java","spotlight","ui","ux"],"created_at":"2024-09-24T20:02:40.326Z","updated_at":"2026-10-18T21:33:49.881Z","avatar_url":"https://github.com/TakuSemba.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spotlight\n\n\u003cimg src=\"https://github.com/TakuSemba/Spotlight/blob/master/arts/logo_yello.png\" alt=\"alt text\" style=\"width:200;height:200\"\u003e\n\n![Build Status](https://app.bitrise.io/app/bcf0d555e7b41eb2/status.svg?token=2wvl_JilEbg6HB3B1tfKpA\u0026branch=master)\n![Download](https://api.bintray.com/packages/takusemba/maven/spotlight/images/download.svg)\n![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)\n![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)\n\n## Gradle\n\n```groovy\ndependencies {\n    implementation 'com.github.takusemba:spotlight:x.x.x'\n}\n```\n\n\n## Usage\n\n```kt\nval spotlight = Spotlight.Builder(this)\n    .setTargets(firstTarget, secondTarget, thirdTarget ...)\n    .setBackgroundColor(R.color.spotlightBackground)\n    .setDuration(1000L)\n    .setAnimation(DecelerateInterpolator(2f))\n    .setContainer(viewGroup)\n    .setOnSpotlightListener(object : OnSpotlightListener {\n      override fun onStarted() {\n        Toast.makeText(this@MainActivity, \"spotlight is started\", Toast.LENGTH_SHORT).show()\n      }\n      override fun onEnded() {\n        Toast.makeText(this@MainActivity, \"spotlight is ended\", Toast.LENGTH_SHORT).show()\n      }\n    })\n    .build()         \n```\n\nIf you want to show Spotlight immediately, you have to wait until views are laid out.\n\n```kt\n// with core-ktx method.\nview.doOnPreDraw { Spotlight.Builder(this)...start() }\n```\n\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n\u003cimg src=\"https://github.com/TakuSemba/Spotlight/blob/master/arts/customTarget.gif\" align=\"left\" width=\"30%\"\u003e\n\n## Target\nCreate a Target to add Spotlight.\n\nTarget is a spot to be casted by Spotlight. You can add multiple targets to Spotlight.\n\n```kt\nval target = Target.Builder()\n    .setAnchor(100f, 100f)\n    .setShape(Circle(100f))\n    .setEffect(RippleEffect(100f, 200f, argb(30, 124, 255, 90)))\n    .setOverlay(layout)\n    .setOnTargetListener(object : OnTargetListener {\n      override fun onStarted() {\n        makeText(this@MainActivity, \"first target is started\", LENGTH_SHORT).show()\n      }\n      override fun onEnded() {\n        makeText(this@MainActivity, \"first target is ended\", LENGTH_SHORT).show()\n      }\n    })\n    .build()\n```\n\n\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n## Start/Finish Spotlight\n\n```kt\nval spotlight = Spotlight.Builder(this)...start()\n\nspotlight.finish()\n```\n\n## Next/Previous/Show Target\n\n```kt\nval spotlight = Spotlight.Builder(this)...start()\n\nspotlight.next()\n\nspotlight.previous()\n\nspotlight.show(2)\n```\n\n## Custom Shape\n`Shape` defines how your target will look like.\n[Circle](https://github.com/TakuSemba/Spotlight/blob/master/spotlight/src/main/java/com/takusemba/spotlight/shape/Circle.kt) and [RoundedRectangle](https://github.com/TakuSemba/Spotlight/blob/master/spotlight/src/main/java/com/takusemba/spotlight/shape/RoundedRectangle.kt) shapes are already implemented, but if you want your custom shape, it's arhivable by implementing `Shape` interface.\n\n\n```kt\nclass CustomShape(\n    override val duration: Long,\n    override val interpolator: TimeInterpolator\n) : Shape {\n\n  override fun draw(canvas: Canvas, point: PointF, value: Float, paint: Paint) {\n    // draw your shape here.\n  }\n}\n```\n\n## Custom Effect\n`Effect` allows you to decorates your target.\n[RippleEffect](https://github.com/TakuSemba/Spotlight/blob/master/spotlight/src/main/java/com/takusemba/spotlight/effet/RippleEffect.kt) and [FlickerEffect](https://github.com/TakuSemba/Spotlight/blob/master/spotlight/src/main/java/com/takusemba/spotlight/effet/FlickerEffect.kt) shapes are already implemented, but if you want your custom effect, it's arhivable by implementing `Effect` interface.\n\n\n```kt\nclass CustomEffect(\n    override val duration: Long,\n    override val interpolator: TimeInterpolator,\n    override val repeatMode: Int\n) : Effect {\n\n  override fun draw(canvas: Canvas, point: PointF, value: Float, paint: Paint) {\n    // draw your effect here.\n  }\n}\n```\n\n## Sample\nClone this repo and check out the [app](https://github.com/TakuSemba/Spotlight/tree/master/app) module.\n\n## Author\n\n* **Taku Semba**\n    * **Github** - (https://github.com/takusemba)\n    * **Twitter** - (https://twitter.com/takusemba)\n    * **Facebook** - (https://www.facebook.com/takusemba)\n\n## Licence\n```\nCopyright 2017 Taku Semba.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakusemba%2Fspotlight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftakusemba%2Fspotlight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftakusemba%2Fspotlight/lists"}