{"id":13396015,"url":"https://github.com/amlcurran/ShowcaseView","last_synced_at":"2025-03-13T22:31:29.879Z","repository":{"id":4287465,"uuid":"5417266","full_name":"amlcurran/ShowcaseView","owner":"amlcurran","description":"[Archived] Highlight the best bits of your app to users quickly, simply, and cool...ly","archived":true,"fork":false,"pushed_at":"2018-02-01T16:31:39.000Z","size":15237,"stargazers_count":5602,"open_issues_count":95,"forks_count":1288,"subscribers_count":239,"default_branch":"master","last_synced_at":"2024-09-27T02:29:47.922Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/amlcurran.png","metadata":{"files":{"readme":"README-template.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-08-14T19:07:36.000Z","updated_at":"2024-09-11T15:31:16.000Z","dependencies_parsed_at":"2022-07-13T10:30:33.921Z","dependency_job_id":null,"html_url":"https://github.com/amlcurran/ShowcaseView","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amlcurran%2FShowcaseView","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amlcurran%2FShowcaseView/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amlcurran%2FShowcaseView/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amlcurran%2FShowcaseView/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amlcurran","download_url":"https://codeload.github.com/amlcurran/ShowcaseView/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243493657,"owners_count":20299693,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-07-30T18:00:37.722Z","updated_at":"2025-03-13T22:31:29.286Z","avatar_url":"https://github.com/amlcurran.png","language":"Java","readme":"ShowcaseView\n---\n\nThe ShowcaseView (SCV) library is designed to highlight and showcase specific parts of apps to the user with a distinctive and attractive overlay. This library is great for pointing out points of interest for users, gestures, or obscure but useful items.\n\n| Holo | \"New style\" | Material |\n| --- | --- | --- |\n| ![Holo style showcaseview](./example2@2x.png) | ![new style showcaseview](./example@2x.png) | ![Material style showcaseview](./material.png) |\n\nThe library is based on the \"Cling\" view found in the Launcher on Ice-Cream Sandwich and Jelly Bean.\n\nProject set-up\n====\n\n**ShowcaseView currently supports API LEVEL 11+**\n\nIf you're using a Gradle-based project, then you can add SCV as a dependency directly:\n\n~~~\ncompile 'com.github.amlcurran.showcaseview:library:@version@'\n~~~\n\nIf you're using Maven (but not Gradle), you can add the APKlib as a dependency:\n\n~~~\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.github.amlcurran.showcaseview\u003c/groupId\u003e\n  \u003cartifactId\u003elibrary\u003c/artifactId\u003e\n  \u003cversion\u003e@version@\u003c/version\u003e\n  \u003ctype\u003eapklib\u003c/type\u003e\n\u003c/dependency\u003e\n~~~\n\nIf you're using a standard project without either Maven or Gradle, you'll have to download the project, and the add the library manually to your project.\n\n\nUsage\n====\n\nTo use ShowcaseView, use the Builder pattern.\n\nAs an example:\n\n~~~\nnew ShowcaseView.Builder(this)\n    .setTarget(new ActionViewTarget(this, ActionViewTarget.Type.HOME))\n    .setContentTitle(\"ShowcaseView\")\n    .setContentText(\"This is highlighting the Home button\")\n    .hideOnTouchOutside()\n    .build();\n~~~\n\nYou can use styles to customise how a ShowcaseView looks. I'll write more documentation soon, but for now, check out the sample project's [styles](https://github.com/amlcurran/ShowcaseView/blob/master/sample/src/main/res/values/styles.xml).\n\nSample Project\n----\nThere's a sample project available which you can find in the project, or as an app on the [Google Play Store](https://play.google.com/store/apps/details?id=com.espian.showcaseview.sample).\n\nWhat's the legacy branch?\n----\nThe [legacy branch](https://github.com/amlcurran/ShowcaseView/tree/legacy) is still available for people to use. This has more features than the master branch, but it more unwieldy to use and less stable. I don't support it at all - you'll have to build and compile it yourself. It isn't available on Maven Central either.\n\nIs it worth using?\n----\nPerhaps. Why not ask\n[Google](https://github.com/googlecast/CastVideos-android), [iPlayer Radio](https://play.google.com/store/apps/details?id=uk.co.bbc.android.iplayerradio),\nor [AllCast](https://play.google.com/store/apps/details?id=com.koushikdutta.cast), which each use the library?\n\nPrevious users include The Guardian and HaxSync\n\nWhat's missing in v5\n---\n\n- ShowcaseViews: the class which queues up ShowcaseViews in a tutorial-type method. I never\nreally liked this class (generally, you should use SCV sparingly); I'll add it back in based on\nthe Builder class when I can.\n- Ghostly hand: this has gone for now until I can test-drive it back in.\n- Scale multiplier: this has gone for simplicity - if people really loved it I'll add in back in\n\nFAQs\n---\n\n**Where has X feature gone?**\n\nLook one paragraph up!\n\n**Waaaah, but I really liked feature X!!!**\n\nSwitch to the legacy branch and use that one then! All legacy features are in there.\n\n**What happened to all the other constructors?**\n\nGone. You should be using the new Target API.\n\n**What if I want to add feature X?**\n\nAt the moment, I'm not taking any feature requests. It's unlikely I'll take many anyway,\nunless I feel they are both useful and well tested. If you have some cosmetic tweak then I don't\nwant that added into the library as *another* option. But, if you need to make a tweak to the\nlibrary to add such a tweak to your own, overridden ShowcaseView then that is totally great.\n\n\nCopyright and Licensing\n----\n\nCopyright Alex Curran ([@amlcurran](https://twitter.com/amlcurran)) © 2012-2014. All rights reserved.\n\nThis library is distributed under an Apache 2.0 License.\n","funding_links":[],"categories":["Index `(light-weight pages)`","Java","引导图(Intro)","Index","Libs"],"sub_categories":["\u003cA NAME=\"Widget\"\u003e\u003c/A\u003eWidget"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famlcurran%2FShowcaseView","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famlcurran%2FShowcaseView","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famlcurran%2FShowcaseView/lists"}