##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 with command:
dependencies {
compile 'com.cleveroad:slidingtutorial:1.0.0'
}After you have to create each fragment that must extend from PageFragment. Also you have to create your xml file with images.
public class FirstCustomPageFragment extends PageFragment {
@Override
protected int getLayoutResId() {
// layout id of fragment
return R.layout.fragment_page_first;
}
@Override
protected TransformItem[] provideTransformItems() {
// list of transformation items
return new TransformItem[]{
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)
};
}
}And specify TutorialPageProvider in main TutorialFragment fragment.
private final TutorialPageProvider mTutorialPageProvider = new TutorialPageProvider() {
@NonNull
@Override
public PageFragment providePage(int position) {
position %= ACTUAL_PAGES_COUNT;
switch (position) {
case 0:
return new FirstCustomPageFragment();
case 1:
return new SecondCustomPageFragment();
case 2:
return new ThirdCustomPageFragment();
}
}
};Or you can provide TutorialPageOptionsProvider instance in main TutorialFragment fragment that responds for creating PageFragment instances with provided PageOptions configuration.
private final TutorialPageOptionsProvider mTutorialPageOptionsProvider = new TutorialPageOptionsProvider() {
@NonNull
@Override
public PageOptions provide(int position) {
@LayoutRes int pageLayoutResId;
TransformItem[] tutorialItems;
position %= ACTUAL_PAGES_COUNT;
switch (position) {
case 0: {
pageLayoutResId = R.layout.fragment_page_first;
tutorialItems = new TransformItem[]{
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;
}
case 1: {
pageLayoutResId = R.layout.fragment_page_second;
tutorialItems = new TransformItem[]{
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;
}
case 2: {
pageLayoutResId = R.layout.fragment_page_third;
tutorialItems = new TransformItem[]{
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: {
throw new IllegalStateException("Invalid position");
}
}
return PageOptions.create(pageLayoutResId, position, tutorialItems);
}
};All the stuff then use while creating TutorialOptions instance using TutorialOptions.Builder inside TutorialFragment#provideTutorialOptions method implementation. For example with using TutorialPageProvider:
@Override
protected TutorialOptions provideTutorialOptions() {
return TutorialOptions.newBuilder(getContext())
.isAutoRemoveTutorialFragment(true)
.setPagesColors(pagesColors)
.setPagesCount(TOTAL_PAGES)
.setTutorialPageProvider(mTutorialPageProvider)
.onSkipClickListener(mOnSkipClickListener)
.build();
}Example with specifying TutorialPageOptionsProvider:
@Override
protected TutorialOptions provideTutorialOptions() {
return TutorialOptions.newBuilder(getContext())
.isAutoRemoveTutorialFragment(true)
.setPagesColors(pagesColors)
.setPagesCount(TOTAL_PAGES)
.onSkipClickListener(mOnSkipClickListener)
.build();
}Also you can configure TutorialPageIndicator view via IndicatorOptions. For example (inside TutorialFragment#provideTutorialOptions method implementation):
@Override
protected TutorialOptions provideTutorialOptions() {
return TutorialOptions.newBuilder(getContext())
.isAutoRemoveTutorialFragment(true)
.setPagesColors(pagesColors)
.setPagesCount(TOTAL_PAGES)
.setTutorialPageProvider(mTutorialPageOptionsProvider)
.setIndicatorOptions(IndicatorOptions.newBuilder(getContext())
.setElementSizeRes(R.dimen.indicator_size)
.setElementSpacing(2f)
.setElementColorRes(android.R.color.darker_gray)
.setSelectedElementColor(Color.LTGRAY)
.setRenderer(RhombusRenderer.create())
.build())
.onSkipClickListener(mOnSkipClickListener)
.build();
}| Version | Changes |
|---|---|
| v.1.0.0 | Library fully refactored. See full 1.0.0 Changelog |
| v.0.9.5 | Added getters for views. Possible fix for manifest merging issues |
| v.0.9.4 | Renamed all attributes; all resources marked as private |
| v.0.9.3 | Fixed issue with wrong page showed at startup if pages count not equals 3 |
| v.0.9.2 | Added onSkipButtonClicked method and SimplePagerFragment |
| v.0.9.1 | Added infinite scroll behavior |
| v.0.9 | First public release |
- Renamed PresentationPagerFragment to TutorialFragment.
- Maked PageFragment not abstract with default implementaion for *PageFragment#getLayoutResId() and PageFragment#getTransformItems().
- Removed capability to create new instance of TransformItem via
new. Added fabric static method TransformItem#create(PageOptions) and TransformItem#create(int,TransformItem[]). - Created OnTutorialPageChangeListener to listen change page events.
- Use TutorialFragment#addOnTutorialPageChangeListener() and TutorialFragment#addOnTutorialPageChangeListener() to add/remove listener.
- Created TutorialOptions to configure TutorialFragment.
- Created TutorialPageOptionsProvider and PageOptions to provide and configure PageFragment instances.
- Created TutorialPageProvider to provide PageFragment instances.
- Removed CirclePageIndicator.
- Created TutorialPageIndicator view.
- Created IndicatorOptions to configure TutorialPageIndicator view.
- Created Renderer interface that responds for drawing single indicator item. There are 2 default implementaion: Renderer.Factory#newCircleRenderer() and Renderer.Factory#newSquareRenderer().
- You must change creation TransformItem from
new TransformItem(R.id.ivFirstImage, true, 20)toTransformItem.create(R.id.ivFirstImage, Direction.LEFT_TO_RIGHT, 0.2f), where 2-nd parameter now is Direction of view translation and 3-rd parameter is shiftCoefficient. - Your fragment with tutorial must extend TutorialFragment instead of PresentationPagerFragment.
- In your TutorialFragment successor fragment must implement #provideTutorialOptions() method that returns TutorialOptions instance.
- In TutorialOptions.Builder#setTutorialPageProvider(TutorialPageProvider)* you must specify TutorialPageProvider instance. For example:
private final TutorialPageProvider mTutorialPageProvider = new TutorialPageProvider() {
@NonNull
@Override
public PageFragment providePage(int position) {
position %= ACTUAL_PAGES_COUNT;
switch (position) {
case 0:
return new FirstCustomPageFragment();
case 1:
return new SecondCustomPageFragment();
case 2:
return new ThirdCustomPageFragment();
default:
throw new IllegalArgumentException("Unknown position: " + position);
}
}
};- All resources marked as private. Make sure you're not using any resource (strings, dimens, etc) from this library.
- All attributes were renamed, prefix
st_added. Add this prefix to any custom XML attribute you used. Example:
<com.cleveroad.slidingtutorial.CirclePageIndicator
android:id="@+id/indicator"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:layout_gravity="center"
app:st_fillColor="@android:color/white"
app:st_pageColor="@android:color/secondary_text_light_nodisable"
app:st_radius="4dp"
app:st_strokeColor="#00000000"
app:st_strokeWidth="0dp"/>####CirclePageIndicator This class is final now. Make sure you're not extending from it.
####LayersHolder This class is package-local now. Make sure you're not using it.
####PageFragment getRootResId() and getBackgroundColorResId() methods are deprecated. You can remove them now. To specify page's color use PresentationPagerFragment.getPageColor(int) method.
####PresentationPagerFragment getPageFragments() method is deprecated. You can remove it now. Use getPagesCount() and getPage(int) methods instead.
Added isInfinityScrollEnabled() method. Override it and return true to enable this feature.
NOTE: make sure you're returning new fragment instance when displaying tutorial with infinite scroll enabled.
If you have any questions regarding the use of this tutorial, please contact us for support
at info@cleveroad.com (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.