|
| 1 | +## SlidingTutorial [](https://github.com/sindresorhus/awesome) <img src="https://www.cleveroad.com/public/comercial/label-android.svg" height="20"> <a href="https://www.cleveroad.com/?utm_source=github&utm_medium=label&utm_campaign=contacts"><img src="https://www.cleveroad.com/public/comercial/label-cleveroad.svg" height="20"></a> |
| 2 | + |
| 3 | + |
| 4 | +## Migrations from v.0.9.5 to v.1.0.0 |
| 5 | +1. You must change creation TransformItem from `new TransformItem(R.id.ivFirstImage, true, 20)` to `TransformItem.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*. |
| 6 | +2. Your fragment with tutorial must extend **TutorialFragment** instead of **PresentationPagerFragment**. |
| 7 | +3. In your **TutorialFragment** successor fragment must implement #*provideTutorialOptions()* method that returns TutorialOptions instance. |
| 8 | +4. In **TutorialOptions**.**Builder**#setTutorialPageProvider(**TutorialPageProvider**)* you must specify **TutorialPageProvider** instance. For example: |
| 9 | +```java |
| 10 | +private final TutorialPageProvider mTutorialPageProvider = new TutorialPageProvider() { |
| 11 | + @NonNull |
| 12 | + @Override |
| 13 | + public PageFragment providePage(int position) { |
| 14 | + position %= ACTUAL_PAGES_COUNT; |
| 15 | + switch (position) { |
| 16 | + case 0: |
| 17 | + return new FirstCustomPageFragment(); |
| 18 | + case 1: |
| 19 | + return new SecondCustomPageFragment(); |
| 20 | + case 2: |
| 21 | + return new ThirdCustomPageFragment(); |
| 22 | + default: |
| 23 | + throw new IllegalArgumentException("Unknown position: " + position); |
| 24 | + } |
| 25 | + } |
| 26 | + }; |
| 27 | +``` |
| 28 | + |
| 29 | +## Migrations from v.0.9.3 to v.0.9.4 |
| 30 | +* All resources marked as private. Make sure you're not using any resource (strings, dimens, etc) from this library. |
| 31 | +* All attributes were renamed, prefix `st_` added. Add this prefix to any custom XML attribute you used. Example: |
| 32 | +```XML |
| 33 | + <com.cleveroad.slidingtutorial.CirclePageIndicator |
| 34 | + android:id="@+id/indicator" |
| 35 | + android:layout_width="match_parent" |
| 36 | + android:layout_height="wrap_content" |
| 37 | + android:layout_gravity="center" |
| 38 | + app:st_fillColor="@android:color/white" |
| 39 | + app:st_pageColor="@android:color/secondary_text_light_nodisable" |
| 40 | + app:st_radius="4dp" |
| 41 | + app:st_strokeColor="#00000000" |
| 42 | + app:st_strokeWidth="0dp"/> |
| 43 | +``` |
| 44 | + |
| 45 | +## Migrations from v.0.9 to v.0.9.1 |
| 46 | +#### CirclePageIndicator |
| 47 | +This class is final now. Make sure you're not extending from it. |
| 48 | + |
| 49 | +#### LayersHolder |
| 50 | +This class is package-local now. Make sure you're not using it. |
| 51 | + |
| 52 | +#### PageFragment |
| 53 | +**getRootResId()** and **getBackgroundColorResId()** methods are deprecated. You can remove them now. To specify page's color use **PresentationPagerFragment.getPageColor(int)** method. |
| 54 | + |
| 55 | +#### PresentationPagerFragment |
| 56 | +**getPageFragments()** method is deprecated. You can remove it now. Use **getPagesCount()** and **getPage(int)** methods instead. |
| 57 | + |
| 58 | +Added **isInfinityScrollEnabled()** method. Override it and return `true` to enable this feature. |
| 59 | + |
| 60 | +**NOTE:** make sure you're returning new fragment instance when displaying tutorial with infinite scroll enabled. |
| 61 | + |
| 62 | +## Support |
| 63 | +If you have any questions regarding the use of this tutorial, please contact us for support |
| 64 | +at [email protected] (email subject: «Sliding android app tutorial. Support request.») |
| 65 | +<br>or |
| 66 | +<br>Use our contacts: |
| 67 | +<br><a href="https://www.cleveroad.com/?utm_source=github&utm_medium=link&utm_campaign=contacts">Cleveroad.com</a> |
| 68 | +<br><a href="https://www.facebook.com/cleveroadinc">Facebook account</a> |
| 69 | +<br><a href="https://twitter.com/CleveroadInc">Twitter account</a> |
| 70 | +<br><a href="https://plus.google.com/+CleveroadInc/">Google+ account</a> |
| 71 | + |
| 72 | +[PageFragment]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java |
| 73 | +[PageFragment#getLayoutResId()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java#L123 |
| 74 | +[PageFragment#getTransformItems()]: hhttps://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageFragment.java#L128 |
| 75 | +[Direction]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Direction.java |
| 76 | +[IndicatorOptions]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/IndicatorOptions.java |
| 77 | +[IndicatorOptions.Builder]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/IndicatorOptions.java#L92 |
| 78 | +[PageOptions]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/PageOptions.java |
| 79 | +[Renderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java |
| 80 | +[Renderer.Factory]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L46 |
| 81 | +[Renderer.Factory#newCircleRenderer()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L54 |
| 82 | +[Renderer.Factory#newSquareRenderer()]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/Renderer.java#L75 |
| 83 | +[DrawableRenderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/sample/src/main/java/com/cleveroad/slidingtutorial/sample/renderer/DrawableRenderer.java |
| 84 | +[RhombusRenderer]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/sample/src/main/java/com/cleveroad/slidingtutorial/sample/renderer/RhombusRenderer.java |
| 85 | +[TransformItem]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TransformItem.java |
| 86 | +[TransformItem#create(int,Direction,float)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TransformItem.java#L54 |
| 87 | +[TutorialFragment]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java |
| 88 | +[TutorialFragment.OnTutorialPageChangeListener]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L315 |
| 89 | +[TutorialFragment#addOnTutorialPageChangeListener(OnTutorialPageChangeListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L173 |
| 90 | +[TutorialFragment#removeOnTutorialPageChangeListener(OnTutorialPageChangeListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialFragment.java#L186 |
| 91 | +[TutorialOptions]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java |
| 92 | +[TutorialOptions.Builder]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L112 |
| 93 | +[TutorialOptions.Builder#setTutorialPageProvider(TutorialPageOptionsProvider)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L237 |
| 94 | +[TutorialOptions.Builder#setTutorialPageProvider(TutorialPageProvider)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L256 |
| 95 | +[TutorialOptions.Builder#setOnSkipClickListener(OnClickListener)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L207 |
| 96 | +[TutorialOptions.Builder#setPagesColors(int array)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L196 |
| 97 | +[TutorialOptions.Builder#setPagesCount(int)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L185 |
| 98 | +[TutorialOptions.Builder#setUseInfiniteScroll(boolean)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L174 |
| 99 | +[TutorialOptions.Builder#setUseAutoRemoveTutorialFragment(boolean)]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialOptions.java#L162 |
| 100 | +[TutorialPageIndicator]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialPageIndicator.java |
| 101 | +[TutorialPageOptionsProvider]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialPageOptionsProvider.java |
| 102 | +[TutorialPageProvider]: https://github.com/Cleveroad/SlidingTutorial-Android/blob/master/lib/src/main/java/com/cleveroad/slidingtutorial/TutorialPageProvider.java |
0 commit comments