material-intro


Source link: https://github.com/HeinrichReimer/material-intro

material-intro

A simple material design app intro with cool animations and a fluent API.

Very inspired by Google's app intros.

Demo:

A demo app is available on Google Play:

Screenshots:

Simple slide Custom slide Fade effect Permission request
SimpleSlide.java FragmentSlide.java IntroActivity.java SimpleSlide.java

Features:

  • Material design ( check the docs)
  • Easy customization
  • Predefined slide layouts
  • Custom slides
  • Autoplay
  • Parallax slides
  • Fluent API

Table of Contents

  1. Setup
    1. Gradle Dependency
    2. Requirements
  2. Slides
    1. Standard slide
    2. Fragment slide
    3. Custom slide
  3. Customization
    1. Back button
    2. Next button
    3. CTA button
    4. Fullscreen
    5. Scroll duration
  4. Navigation
    1. Block navigation
    2. Navigate to slides
    3. Autoplay
    4. Callbacks
  5. Tips & Tricks
    1. Activity result
    2. Parallax slides
    3. Splash screens
  6. Apps using this library
  7. Changes
  8. Open-source libraries
  9. License

Setup:

Gradle Dependency:

material-intro is available on jitpack.io.

Add this in your root build.gradle file ( not your module build.gradle file):

allprojects {

  repositories {

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

  
}
 
}

Add this in your module build.gradle file:

android {

  ...
  dataBinding {

enabled = true
  
}
 
}
 dependencies {

  compile 'com.heinrichreimersoftware:material-intro:1.6.2' 
}

Requirements:

The activity must extend IntroActivity and have a theme extending @style/Theme.Intro:

public class MainIntroActivity extends IntroActivity{

  @Override protected void onCreate(Bundle savedInstanceState){

super.onCreate(savedInstanceState);
  // Add slides, edit configuration...
  
}
 
}
<manifest ...>
  <application ...>

<activity android:name=".MainIntroActivity"

 android:theme="@style/Theme.Intro"/>
  </application> </manifest>

(Unless mentioned otherwise all of the following method calls should go in the activity's onCreate().)

Slides:

material-intro has fluent style builders for both a simple text/image slide, as seen in Google's apps, and for slides featuring a custom Fragment or layout resource.

Feel free to submit an issue or pull request if you think any slide types are missing.

Standard slide ( SimpleSlide):

Standard slide featuring a title, short description and image like Google's intros.

addSlide(new SimpleSlide.Builder()

.title(R.string.title_1)

.description(R.string.description_1)

.image(R.drawable.image_1)

.background(R.color.background_1)

.backgroundDark(R.color.background_dark_1)

.scrollable(false)

.permission(Manifest.permission.CAMERA)

.build());

Fragment slide ( FragmentSlide):

Custom slide containing a Fragment or a layout resource.

addSlide(new FragmentSlide.Builder()

.background(R.color.background_2)

.backgroundDark(R.color.background_dark_2)

.fragment(R.layout.fragment_2, R.style.FragmentTheme)

.build());

(When using FragmentSlide with a Fragment, you should extend SlideFragment to proxy navigation calls to the intro activity.)

Custom slide ( Slide):

Base slide. If you want to modify what's shown in your slide this is the way to go.

Customization:

Left ("back") button:

Control left button behavior or hide/show it.

/* Show/hide button */ setButtonBackVisible(true);
 /* Use skip button behavior */ setButtonBackFunction(BUTTON_BACK_FUNCTION_SKIP);
 /* Use back button behavior */ setButtonBackFunction(BUTTON_BACK_FUNCTION_BACK);

Right ("next") button:

Control right button behavior or hide/show it.

/* Show/hide button */ setButtonNextVisible(true);
 /* Use next and finish button behavior */ setButtonNextFunction(BUTTON_NEXT_FUNCTION_NEXT_FINISH);
 /* Use next button behavior */ setButtonNextFunction(BUTTON_NEXT_FUNCTION_NEXT);

CTA button:

Change the appearance of the "call to action" button:

/* Show/hide button */ setButtonCtaVisible(getStartedEnabled);
 /* Tint button text */ setButtonCtaTintMode(BUTTON_CTA_TINT_MODE_TEXT);
 /* Tint button background */ setButtonCtaTintMode(BUTTON_CTA_TINT_MODE_BACKGROUND);
 /* Set custom CTA label */ setButtonCtaLabel(R.string.start) /**/ setButtonCtaClickListener(new View.OnClickListener() {

 
}
);

Fullscreen:

Display the intro activity at fullscreen. This hides the status bar.

public class MainIntroActivity extends IntroActivity{

  @Override protected void onCreate(Bundle savedInstanceState){

setFullscreen(true);

super.onCreate(savedInstanceState);
  ...
  
}
 
}

Make sure to call setFullscreen() before calling super.onCreate()

Scroll duration:

Adjust how long a single slide scroll takes.

setPageScrollDuration(500);

(The page scroll duration is dynamically adapted when scrolling more than one position to reflect dynamic durations from the Material design docs.
The exact formula for calculating the scroll duration is duration * (distance + sqrt(distance)) / 2.)

Navigation:

Block navigation:

There are three ways to block navigation for a slide:

  1. In a SlideFragment (using a FragmentSlide) by overriding canGoForward()/ canGoBackward() methods.
  2. For a SimpleSlide by setting SimpleSlide.Builder#canGoForward(boolean)/ SimpleSlide.Builder#canGoBackward(boolean).
    (If at least one permission is set to the SimpleSlide, navigation is automatically blocked until every permission is granted.)
  3. From your IntroActivity by setting a NavigationPolicy:
    setNavigationPolicy(new NavigationPolicy() {
    
      @Override public boolean canGoForward(int position) {
    
    return true;
      
    }
    
    @Override public boolean canGoBackward(int position) {
    
    return false;
      
    }
     
    }
    );
    

Navigate to slides

Navigate through the intro manually using one of the following methods e.g. from a listeners callback. Each of them will respect blocked navigation settings.

/* Scroll to any position */ goToSlide(5);
  /* Scroll to the next slide in the intro */ nextSlide();
  /* Scroll to the previous slide in the intro */ previousSlide();
  /* Scroll to the last slide of the intro */ goToLastSlide();
  /* Scroll to the first slide of the intro */ goToFirstSlide();

Autoplay

Automatically scroll through the intro until user interacts with the intro.

/* Start an auto slideshow with 2500ms delay between scrolls and infinite repeats */ autoplay(2500, INFINITE);
 /* Start an auto slideshow with default configuration  */ autoplay();
 /* Cancel the slideshow */ cancelAutoplay()

Callbacks

If any of the above returns false when a user tries to navigate to a slide, a OnNavigationBlockedListener callback is fired that you can use to display a message. Additionally you can add plain-old ViewPager.OnPageChangeListeners to listen for page scrolls:

addOnNavigationBlockedListener(new OnNavigationBlockedListener() {

  @Override public void onNavigationBlocked(int position, int direction) {
 ... 
}
 
}
);
  addOnPageChangeListener(new ViewPager.OnPageChangeListener(){

  @Override public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {
 ... 
}

  @Override public void onPageSelected(int position) {
 ... 
}

  @Override public void onPageScrollStateChanged(int state) {
 ... 
}
 
}
);

Tips & Tricks:

Activity result:

You can check if the user canceled the intro (by pressing back) or finished it including all slides. Just call up the activity using startActivityForResult(intent, REQUEST_CODE_INTRO); and then listen for the result:

@Override protected void onActivityResult(int requestCode, int resultCode, Intent data) {

  super.onActivityResult(requestCode, resultCode, data);

  if (requestCode == REQUEST_CODE_INTRO) {

if (resultCode == RESULT_OK) {

 // Finished the intro

}
 else {

 // Cancelled the intro. You can then e.g. finish this activity too.

 finish();
  
}

  
}
 
}

Parallax slides:

You can easily acheive a nice looking parallax effect for any slide by using either ParallaxFrameLayout.java, ParallaxLinearLayout.java or ParallaxRelativeLayout.java and defining layout_parallaxFactor for its direct childrens.
A higher factor means a stronger parallax effect, 0 means no parallax effect at all.

<com.heinrichreimersoftware.materialintro.view.parallax.ParallaxLinearLayout
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  ... >

<TextView

android:layout_width="match_parent"

android:layout_height="wrap_content"

app:layout_parallaxFactor="0"

... />

<ImageView

android:layout_width="match_parent"

android:layout_height="wrap_content"

app:layout_parallaxFactor="1.25"

... />  </com.heinrichreimersoftware.materialintro.view.parallax.ParallaxLinearLayout>

Check the "Canteen"-demo for a layout example.

Splash screens:

If you want to show the intro only at the first app start you can use onActivityResult() to store a shared preference when the user finished the intro.

See the demo app for a sample splash screen implementation:

Apps using this library:

Changes:

See the releases section for changelogs.

Open-source libraries:

material-intro uses the following open-source files:

License:

MIT License  Copyright (c) 2017 Jan Heinrich Reimer  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 

Resources

Android Swipe Layout is the brother of AndroidViewHover.

A script to generate android assets from a SVG file. Requires inkscape to resize and convert.

android-widget-keyboardless-edittext - as a native Android EditText, except that no keyboard will appear when user interacts with it. All other edit operations still work.

fb-adb is a tool for interacting with Android systems. It does much of what adb does, but with better remote shell support and, hopefully, fewer bugs. Differences between adb and fb-adb are that fb-adb:

  • is binary clean (no LF -> CRLF mangling)
  • transmits and updates window size
  • distinguishes standard output and standard error
  • properly muxes streams with independent flow control
  • allows for ssh-like pty allocation control
  • propagates program exit status instead of always exiting with status 0
  • properly escapes program arguments
  • kills remote program
  • provides a generic facility to elevate to root without re-escaping

AXT

Android eXTentions is a lib for common Android-Code.

The aim of this project is to provide code that is used in a lot of Android-Apps over and over again this way:

  • reduce code in the apps ( -> more readable )
  • deduplicate code and tests ( -> save space & time )

A fast dependency injector for Android and Java.

This project represents Google's fork of Square's Dagger. Google's Dagger fork is intended to vary from Square's project only where features are needed to deviate from Square's feature-set. Google's Dagger should be a drop-in compatible alternative to Square's Dagger, and many features in this fork will, if successful, be merged into the upstream project.

Efforts are made to also keep Google's fork as close in structure to Square's as possible, to facilitate merging and compatibility. Google/dagger will release shortly after Square's releases.

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