##SlidingTutorial 
Hey guys, hope you haven’t started developing a tutorial for your Android app yet, as we have already completed a part of your job. Don’t worry, we act from good motives only. Our aim is to help you create a sliding tutorial in a fast and simple manner. So we’ve done some work and voila!. A simple Android Sliding Tutorial library is at your service.
Also you can watch the animation of the Sliding Tutorial for Android on YouTube in HD quality.
The invention is going to ease the problem of structural design but not to limit a stretch of your imagination at the same time. We took care of the suitability aspect. So, your app is not going to look alien among other Android elements.
Read our Case Study: Sliding tutorial for Android by Cleveroad to make sure that you don’t miss a detail:
Applied parallax effects will make your product presentation look like Google apps tutorial.
All you need to do is:
1. Create background designs for each screen of your tutorial (assistance with mobile design)
2. Create icons for each screen of your tutorial
3. Follow the instructions below
First, add gradle dependency into your build.gradle:
dependencies{compile 'com.cleveroad:slidingtutorial:1.0.0' }There are two common variants of using library: via TutorialPageProvider and via TutorialPageOptionsProvider.
You have to create page fragments where each fragment must extend from PageFragment, override PageFragment#getLayoutResId() and PageFragment#getTransformItems(). Also you have to create your layout xml file with images.
publicclassFirstCustomPageFragmentextendsPageFragment{@OverrideprotectedintgetLayoutResId(){returnR.layout.fragment_page_first} @OverrideprotectedTransformItem[] provideTransformItems(){returnnewTransformItem[]{// TransformItem.create(view for transform, moving direction, shift coefficient)TransformItem.create(R.id.ivFirstImage, Direction.LEFT_TO_RIGHT, 0.2f), TransformItem.create(R.id.ivSecondImage, Direction.RIGHT_TO_LEFT, 0.06f), TransformItem.create(R.id.ivThirdImage, Direction.LEFT_TO_RIGHT, 0.08f), TransformItem.create(R.id.ivFourthImage, Direction.RIGHT_TO_LEFT, 0.1f), TransformItem.create(R.id.ivFifthImage, Direction.RIGHT_TO_LEFT, 0.03f), TransformItem.create(R.id.ivSixthImage, Direction.RIGHT_TO_LEFT, 0.09f), TransformItem.create(R.id.ivSeventhImage, Direction.RIGHT_TO_LEFT, 0.14f), TransformItem.create(R.id.ivEighthImage, Direction.RIGHT_TO_LEFT, 0.07f) }} }Pass TutorialPageProvider instance to TutorialOptions.Builder#setTutorialPageProvider(TutorialPageProvider).
publicclassCustomTutorialFragmentextendsTutorialFragment{privatestaticfinalintTOTAL_PAGES = 3; privatefinalTutorialPageProvider<Fragment> mTutorialPageProvider = newTutorialPageProvider<Fragment>(){@NonNull@OverridepublicFragmentprovidePage(intposition){switch (position){case0: returnnewFirstCustomPageFragment(); case1: returnnewSecondCustomPageFragment(); case2: returnnewThirdCustomPageFragment(); default: thrownewIllegalArgumentException("Unknown position: " + position)} } }; @OverrideprotectedTutorialOptionsprovideTutorialOptions(){returnnewTutorialOptionsBuilder(getContext()) .setPagesCount(TOTAL_PAGES) .setTutorialPageProvider(mTutorialPageProvider) .build()} }Or you can create TutorialPageOptionsProvider and pass it to TutorialOptions.Builder#setTutorialPageProvider(TutorialPageOptionsProvider). It will automatically provide PageFragment instance with specified PageOptions configuration.
publicclassCustomTutorialFragmentextendsTutorialFragment{privatestaticfinalintTOTAL_PAGES = 3; privatefinalTutorialPageOptionsProvidermTutorialPageOptionsProvider = newTutorialPageOptionsProvider(){@NonNull@OverridepublicPageOptionsprovide(intposition){@LayoutResintpageLayoutResId; TransformItem[] tutorialItems; switch (position){case0:{pageLayoutResId = R.layout.fragment_page_first; tutorialItems = newTransformItem[]{TransformItem.create(R.id.ivFirstImage, Direction.LEFT_TO_RIGHT, 0.2f), TransformItem.create(R.id.ivSecondImage, Direction.RIGHT_TO_LEFT, 0.06f), TransformItem.create(R.id.ivThirdImage, Direction.LEFT_TO_RIGHT, 0.08f), TransformItem.create(R.id.ivFourthImage, Direction.RIGHT_TO_LEFT, 0.1f), TransformItem.create(R.id.ivFifthImage, Direction.RIGHT_TO_LEFT, 0.03f), TransformItem.create(R.id.ivSixthImage, Direction.RIGHT_TO_LEFT, 0.09f), TransformItem.create(R.id.ivSeventhImage, Direction.RIGHT_TO_LEFT, 0.14f), TransformItem.create(R.id.ivEighthImage, Direction.RIGHT_TO_LEFT, 0.07f) }; break} case1:{pageLayoutResId = R.layout.fragment_page_second; tutorialItems = newTransformItem[]{TransformItem.create(R.id.ivFirstImage, Direction.RIGHT_TO_LEFT, 0.2f), TransformItem.create(R.id.ivSecondImage, Direction.LEFT_TO_RIGHT, 0.06f), TransformItem.create(R.id.ivThirdImage, Direction.RIGHT_TO_LEFT, 0.08f), TransformItem.create(R.id.ivFourthImage, Direction.LEFT_TO_RIGHT, 0.1f), TransformItem.create(R.id.ivFifthImage, Direction.LEFT_TO_RIGHT, 0.03f), TransformItem.create(R.id.ivSixthImage, Direction.LEFT_TO_RIGHT, 0.09f), TransformItem.create(R.id.ivSeventhImage, Direction.LEFT_TO_RIGHT, 0.14f), TransformItem.create(R.id.ivEighthImage, Direction.LEFT_TO_RIGHT, 0.07f) }; break} case2:{pageLayoutResId = R.layout.fragment_page_third; tutorialItems = newTransformItem[]{TransformItem.create(R.id.ivFirstImage, Direction.RIGHT_TO_LEFT, 0.2f), TransformItem.create(R.id.ivSecondImage, Direction.LEFT_TO_RIGHT, 0.06f), TransformItem.create(R.id.ivThirdImage, Direction.RIGHT_TO_LEFT, 0.08f), TransformItem.create(R.id.ivFourthImage, Direction.LEFT_TO_RIGHT, 0.1f), TransformItem.create(R.id.ivFifthImage, Direction.LEFT_TO_RIGHT, 0.03f), TransformItem.create(R.id.ivSixthImage, Direction.LEFT_TO_RIGHT, 0.09f), TransformItem.create(R.id.ivSeventhImage, Direction.LEFT_TO_RIGHT, 0.14f) }; break} default:{thrownewIllegalArgumentException("Unknown position: " + position)} } returnPageOptions.create(pageLayoutResId, position, tutorialItems)} }; @OverrideprotectedTutorialOptionsprovideTutorialOptions(){returnnewTutorialOptionsBuilder(getContext()) .setPagesCount(TOTAL_PAGES) .setTutorialPageProvider(mTutorialPageOptionsProvider) .build()} }Here's the list of changes in code to use SlidingTutorial library with AppCompat library:
- Your fragment pages must extend PageSupportFragment.
- Your tutorial fragment must extend TutorialSupportFragment.
- TutorialPageProvider must provide android.support.v4.app.Fragment intances. That's all.
You have to implement View.OnClickListener interface and provide it to TutorialOptions.Builder#setOnSkipClickListener(OnClickListener). Example:
publicclassCustomTutorialFragmentextendsTutorialFragment{@OverrideprotectedTutorialOptionsprovideTutorialOptions(){returnnewTutorialOptionsBuilder(getContext()) .setOnSkipClickListener(newView.OnClickListener(){@OverridepublicvoidonClick(Viewv){Toast.makeText(getContext(), "Skip button clicked", Toast.LENGTH_SHORT).show()} }) // setup other configuration ... .build()} }Just provide array of color values to TutorialOptions.Builder#setPagesColors(int array). The array with colors must have length equal to pages count.
publicclassCustomTutorialFragmentextendsTutorialFragment{privatestaticfinalintTOTAL_PAGES = 3; privateint[] pagesColors = newint[]{Color.RED, Color.BLUE, Color.DKGRAY }; @OverrideprotectedTutorialOptionsprovideTutorialOptions(){returnnewTutorialOptionsBuilder(getContext()) .setPagesCount(TOTAL_PAGES) .setPagesColors(pagesColors) // setup other configuration ... .build()} }To loop tutorial pages you have set TutorialOptions.Builder#setUseInfiniteScroll(boolean) to true.
If you want to provide smooth transition from last tutorial page to content - just setup TutorialOptions.Builder#setUseAutoRemoveTutorialFragment(boolean) to true.
There is IndicatorOptions class for configuration indicator view. Here's example:
publicclassCustomTutorialFragmentextendsTutorialFragment{@OverrideprotectedTutorialOptionsprovideTutorialOptions(){returnnewTutorialOptionsBuilder(getContext()) .setIndicatorOptions(IndicatorOptions.newBuilder(getContext()) .setElementSizeRes(R.dimen.indicator_size) .setElementSpacingRes(R.dimen.indicator_spacing) .setElementColorRes(android.R.color.darker_gray) .setSelectedElementColor(android.R.color.white) .setRenderer(Drawable.create(getContext())) .build()) // setup other configuration ... .build()} }As you can see, you can specify element size, element spacing (aka padding), element color, selected element color, and implementation of Renderer interface. There are 2 default implementation inside Renderer.Factory:
- Renderer.Factory#newCircleRenderer() - draw indicators with circle shape
- Renderer.Factory#newSquareRenderer() - draw indicators with square shape
Also in sample module there are two implementaions:
- DrawableRenderer - draw indicators with drawable background
- RhombusRenderer - draw indicators with rhombus shape
You can listen change page events - just implement OnTutorialPageChangeListener and add listener via TutorialFragment#addOnTutorialPageChangeListener(OnTutorialPageChangeListener). To remove listener use TutorialFragment#removeOnTutorialPageChangeListener(OnTutorialPageChangeListener). In OnTutorialPageChangeListener#onPageChanged(int) method you will receive a page index every time page changes. If you enabled TutorialOptions.Builder#setUseAutoRemoveTutorialFragment(boolean) to true, you will receive TutorialFragment.EMPTY_FRAGMENT_POSITION (or TutorialSupportFragment.EMPTY_FRAGMENT_POSITION if you are using support library) as page index.
publicclassCustomTutorialFragmentextendsTutorialFragmentimplementsOnTutorialPageChangeListener{privatestaticfinalStringTAG = "CustomTutorialFragment"; @OverridepublicvoidonCreate(BundlesavedInstanceState){super.onCreate(savedInstanceState); addOnTutorialPageChangeListener(this)} @OverridepublicvoidonPageChanged(intposition){Log.i(TAG, "onPageChanged: position = " + position); if (position == TutorialFragment.EMPTY_FRAGMENT_POSITION){Log.i(TAG, "onPageChanged: Empty fragment is visible")} } }See all migration manuals.
See changelog history.
If you have any questions regarding the use of this tutorial, please contact us for support at [email protected] (email subject: «Sliding android app tutorial. Support request.»)
or
Use our contacts:
Cleveroad.com
Facebook account
Twitter account
Google+ account
The MIT License (MIT) Copyright (c) 2015-2016 Cleveroad 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.