Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mreram/ShowCaseView

:flashlight:The ShowcaseView library is designed to highlight and showcase specific parts of apps to the user with an attractive and flat overlay.
https://github.com/mreram/ShowCaseView

android customview guide guideline guideview intro introduction onboarder onboarding showcase showcaseview showcaseview-library tour tour-guide tour-guide-app

Last synced: 8 days ago
JSON representation

:flashlight:The ShowcaseView library is designed to highlight and showcase specific parts of apps to the user with an attractive and flat overlay.

Host: GitHub
URL: https://github.com/mreram/ShowCaseView
Owner: mreram
License: apache-2.0
Archived: true
Created: 2018-01-19T22:47:49.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-02-13T16:07:18.000Z (10 months ago)
Last Synced: 2024-11-11T16:45:12.610Z (about 1 month ago)
Topics: android, customview, guide, guideline, guideview, intro, introduction, onboarder, onboarding, showcase, showcaseview, showcaseview-library, tour, tour-guide, tour-guide-app
Language: Java
Homepage:
Size: 4.88 MB
Stars: 589
Watchers: 12
Forks: 128
Open Issues: 26
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-android - ShowCaseView - The ShowcaseView library is designed to highlight and showcase specific parts of apps to the user with a attractive and flat overlay. (Libraries / GUI)
awesome-android - ShowCaseView - The ShowcaseView library is designed to highlight and showcase specific parts of apps to the user with a attractive and flat overlay. (Libraries / GUI)

README

        # :flashlight:ShowCaseView:flashlight:

[![Release](https://jitpack.io/v/mreram/ShowCaseView.svg)](https://jitpack.io/#mreram/ShowCaseView)

[![APK](https://img.shields.io/badge/APK-Demo-brightgreen.svg)](https://github.com/mreram/ShowCaseView/raw/master/demo-flatShowCaseView.apk)

[![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=11) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-FlatShowCaseView-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/6713)

[![awesome-android](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/JStumpp/awesome-android#gui)











## How to use:question:

Sample usage in your activity

```java

new GuideView.Builder(this)

    .setTitle("Guide Title Text")

    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")

    .setGravity(Gravity.auto) //optional

    .setDismissType(DismissType.anywhere) //optional - default DismissType.targetView

    .setTargetView(view)

    .setContentTextSize(12)//optional

    .setTitleTextSize(14)//optional

    .build()

    .show();

```



## Installation

	

maven:

```xml

   

     jitpack.io

     https://jitpack.io

   

```

	Step 2. Add the dependency

```xml

    com.github.mreram

    showcaseview

    1.4.1

```

gradle:

	

Add it in your root build.gradle at the end of repositories:

```groovy	

allprojects {

	repositories {

		...

		maven { url 'https://jitpack.io' }

	}

}

```	

	Step 2. Add the dependency

```groovy	

implementation 'com.github.mreram:showcaseview:1.4.1'

```

## Change type face

```java

new GuideView.Builder(this)

    .setTitle("Guide Title Text")

    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")

    .setTargetView(view)

    .setContentTypeFace(Typeface)//optional

    .setTitleTypeFace(Typeface)//optional

    .setDismissType(DismissType.outSide) //optional - default dismissible by TargetView

    .build()

    .show();

```

## Change title and Content text size

```java

new GuideView.Builder(this)

    .setTitle("Guide Title Text")

    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")

    .setTargetView(view)

    .setContentTextSize(12)//optional

    .setTitleTextSize(14)//optional

    .setDismissType(DismissType.outSide) //optional - default dismissible by TargetView

    .build()

    .show();

```	

## Change Gravity

```java

new GuideView.Builder(this)

    .setTitle("Guide Title Text")

    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")

    .setGravity(Gravity.CENTER)//optional

    .setTargetView(view) 

    .setDismissType(DismissType.outSide) //optional - default dismissible by TargetView

    .build()

    .show();

```     

	     

## use Spannable for Content

```java	

new GuideView.Builder(this)

    .setTitle("Guide Title Text")

    .setTargetView(view)

    .setContentSpan((Spannable) Html.fromHtml("testing spannable"))

    .setDismissType(DismissType.outSide) //optional - default dismissible by TargetView

    .build()

    .show();

```

## Set Listener 

```java	

new GuideView.Builder(MainActivity.this)

    .setTitle("Guide Title Text")

    .setContentText("Guide Description Text\n .....Guide Description Text\n .....Guide Description Text .....")

    .setGravity(Gravity.CENTER)

    .setTargetView(view1)

    .setDismissType(DismissType.outSide) //optional - default dismissible by TargetView

    .setGuideListener(new GuideListener() {

        @Override

        public void onDismiss(View view) {

           //TODO ...

        }

     })

    .build()

    .show();

```

### DismissType Attribute

| Type | Description |

| ------ | ------ |

| outside | Dismissing with click on outside of MessageView |

| anywhere | Dismissing with click on anywhere |

| targetView | Dismissing with click on targetView(targetView is assigned with setTargetView method) |

| outsideTargetAndMessage | Dismissing with click on outside of MessageView and target View |

### PointerType Attribute

| Type | Description |

| ------ | ------ |

| circle | Show circle pointer towards targetView |

| arrow | Show arrow pointer towards targetView |

| none | Show no pointer or line towards targetView |

## Contribution :collision:

Pull requests are welcome! :clap:

You can improve/fix some part of it .

Add Tests:

Assuming that the code in question already has automated (unit) tests, do add tests for the code you submit.

This isn't a hard rule. There are various cases where you may need to add code without test coverage (e.g. when adding a Object), but if it can be tested, it should be tested.

## License

```

   Copyright 2018 Mohammad Reza Eram

   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.