MaterialIntroView


Source link: https://github.com/iammert/MaterialIntroView

MaterialIntroView [Beta]

Material Intro View is a showcase android library.

We saw this kind of showcase on Fabulous App and we love it. Then decided to create showcase just like it.

Screen

Usage

new MaterialIntroView.Builder(this)

  .enableDotAnimation(true)
  .enableIcon(false)

  .setFocusGravity(FocusGravity.CENTER)

  .setFocusType(Focus.MINIMUM)

  .setDelayMillis(500)

  .enableFadeAnimation(true)

  .performClick(true)

  .setInfoText("Hi There! Click this card and see what happens.")

  .setShapeType(ShapeType.CIRCLE)

  .setTarget(view)

  .setUsageId("intro_card") //THIS SHOULD BE UNIQUE ID

  .show();

Import

Project build.gradle

repositories {

  maven {

url "https://jitpack.io"
  
}
 
}

Module build.gradle

dependencies {

compile 'com.github.iammert:MaterialIntroView:1.6.0' 
}

Builder Methods

.setMaskColor(Color.Blue) 
.setDelayMillis(3000) //starts after 3 seconds passed
.enableFadeAnimation(true) //View will appear/disappear with fade in/out animation
//ie. If your button's width has MATCH_PARENT. //Focus.ALL is not a good option. You can use //Focus.MINIMUM or Focus.NORMAL. See demos below. .setFocusType(Focus.MINIMUM) .setFocusType(Focus.NORMAL) .setFocusType(Focus.ALL)
//ie. You can focus on left of RecyclerView list item. .setFocusGravity(FocusGravity.LEFT) .setFocusType(FocusGravity.CENTER) .setFocusType(FocusGravity.RIGHT)
.setTarget(myButton) //Focus on myButton
.setTargetPadding(30) //add 30px padding to focus circle
.setInfoText("This is info text!") //Setting text will enable info dialog
.setTextColor(Color.Black) //Info dialog's text color is set to black
.setInfoTextSize(30) //Change text size
.setShapeType(ShapeType.CIRCLE) //Change shape of focus area .setShapeType(ShapeType.RECTANGLE) //Change shape of focus area
.setCustomShape(Shape shape) //Use custom shape
// Allow this showcase overlay to only show up once. Prevents multiple screens from showing at the same time. // Useful if you wish to show a tour step in a code that gets called multiple times .setIdempotent(true)
.setUsageId("intro_fab_button") //Store intro view status whether it is learnt or not
.enableDotAnimation(true) //Shows dot animation center of focus area
.enableIcon(false) //Turn off helper icon, default is true
.performClick(true) //Trigger click operation when user click focused area.
//If you don't want to perform click automatically //You can disable perform clik and handle it yourself .setListener(new MaterialIntroListener() {

@Override

public void onUserClicked(String materialIntroViewId) {

 
}

  
}
)

  

Configuration Method

//Create global config instance to not write same config to builder //again and again. MaterialIntroConfiguration config = new MaterialIntroConfiguration();
 config.setDelayMillis(1000);
 config.setFadeAnimationEnabled(true);
 ... .setConfiguration(config) //

Use Custom Shapes

You can use your own highlight shapes if Circle and Rectangle do not work for you. See source for Circle and Rect for implementation example.

public class MyShape extends Shape {

  // ... your implementation 
}
  //... in your app code  .setCustomShape(MyShape shape) 

Demos

TODO

  • Sample app will be more detailed about using library.
  • Sequence for MaterialIntroViews

Authors

Mert SIMSEK

Murat Can BUR

Docs

Chinese Doc

License

Copyright 2015 Mert ?im?ek.  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. 

Resources

A helper library for keeping and maintaining the state of Chronometers.

Fast and easy to use NoSQL data storage.

An Android/Java Library to create short URL's using Google's URL Shortener.

An Android TagView library. You can customize awesome TagView by using this library.

InkPageIndicator created by Nick Butcher for Plaid and back-ported for API 16+.

This plugin helps you to easily handle variant specific settings with yaml format.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes