All Projects → mreram → Showcaseview

mreram / Showcaseview

Licence: apache-2.0
🔦The ShowcaseView library is designed to highlight and showcase specific parts of apps to the user with an attractive and flat overlay.

Programming Languages

java
68154 projects - #9 most used programming language

Projects that are alternatives of or similar to Showcaseview

Reactour
Tourist Guide into your React Components
Stars: ✭ 2,782 (+890.04%)
Mutual labels:  guide, introduction, intro, tour
openui5-tour
OpenUI5 Tour enables an user-friendly way to showcase products and features in your website.
Stars: ✭ 21 (-92.53%)
Mutual labels:  guide, showcase, tour, intro
guide
A new feature guide component by react 🧭
Stars: ✭ 597 (+112.46%)
Mutual labels:  guide, onboarding, tour
Core
D Language online tour (https://tour.dlang.org/) and online editor (https://run.dlang.io/)
Stars: ✭ 89 (-68.33%)
Mutual labels:  guide, introduction, tour
Pvview
A small library that helps you to make an amazing parallax view
Stars: ✭ 227 (-19.22%)
Mutual labels:  guide, introduction, onboarding
Swiftyoverlay
Show overlay and info on app components
Stars: ✭ 63 (-77.58%)
Mutual labels:  guide, showcase, tour
Androidonboarder
A simple way to make a beauty onboarding experience (app intro or welcome screen) for your users.
Stars: ✭ 269 (-4.27%)
Mutual labels:  introduction, intro, onboarding
React Native Onboarding Swiper
🛳 Delightful onboarding for your React-Native app
Stars: ✭ 596 (+112.1%)
Mutual labels:  introduction, intro, onboarding
GuideChimp
Create interactive guided product tours in minutes with the most non-technical friendly, lightweight and extendable library.
Stars: ✭ 138 (-50.89%)
Mutual labels:  guide, onboarding, tour
Intro.js
Lightweight, user-friendly onboarding tour library
Stars: ✭ 20,826 (+7311.39%)
Mutual labels:  guide, tour
Rn Falcon App Intro
rn-app-intro is a react native component implementing a parallax effect welcome page using base on react-native-swiper , similar to the one found in Google's app like Sheet, Drive, Docs...
Stars: ✭ 82 (-70.82%)
Mutual labels:  introduction, intro
ngx-ui-tour
✈️ UI tour for Angular 9+ apps
Stars: ✭ 36 (-87.19%)
Mutual labels:  onboarding, tour
Tooltip Sequence
A simple step by step tooltip helper for any site
Stars: ✭ 287 (+2.14%)
Mutual labels:  guide, tour
React Native App Intro
react-native-app-intro is a react native component implementing a parallax effect welcome page using base on react-native-swiper , similar to the one found in Google's app like Sheet, Drive, Docs...
Stars: ✭ 3,169 (+1027.76%)
Mutual labels:  introduction, intro
Enlighten
💡 An integrated spotlight-based onboarding and help library for macOS, written in Swift.
Stars: ✭ 44 (-84.34%)
Mutual labels:  guide, onboarding
Rakuguide
The Raku Guide
Stars: ✭ 155 (-44.84%)
Mutual labels:  guide, introduction
Onboardingscreen
create animated onboarding or welcome screen with MotionLayout
Stars: ✭ 239 (-14.95%)
Mutual labels:  intro, onboarding
VSpot
A nice focus view intro for your app. Focus a specific view on first time launch
Stars: ✭ 27 (-90.39%)
Mutual labels:  introduction, intro
Android-Onboarder
Android Onboarder is a simple and lightweight library that helps you to create cool and beautiful introduction screens for your apps without writing dozens of lines of code.
Stars: ✭ 85 (-69.75%)
Mutual labels:  onboarding, introduction
junior.guru
Learn to code and get your first job in tech 🐣
Stars: ✭ 27 (-90.39%)
Mutual labels:  guide, introduction

🔦ShowCaseView🔦

Release APK API Android Arsenal awesome-android

How to use❓

Sample usage in your activity

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:

<repositories>
   <repository>
     <id>jitpack.io</id>
     <url>https://jitpack.io</url>
   </repository>
</repositories>
Step 2. Add the dependency
<dependency>
    <groupId>com.github.mreram</groupId>
    <artifactId>showcaseview</artifactId>
    <version>1.2.0</version>
</dependency>

gradle:

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

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}
Step 2. Add the dependency
implementation 'com.github.mreram:showcaseview:1.2.0'

Change type face

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

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

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

new GuideView.Builder(this)
    .setTitle("Guide Title Text")
    .setTargetView(view)
    .setContentSpan((Spannable) Html.fromHtml("<font color='red'>testing spannable</p>"))
    .setDismissType(DismissType.outSide) //optional - default dismissible by TargetView
    .build()
    .show();

Set Listener

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)

Contribution 💥

Pull requests are welcome! 👏

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.
   
   
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].