You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,7 @@ This is a simple, easy-to-implement, and highly customizable framework for makin
8
8
9
9
The goal of this library isn't to confine you to certain UI styles or guidelines that I have made. The goal here is to provide you with a framework that you can build off of yourself. The content of these tutorial pages can be anything you want. That said, I have provided a few examples here, of UIs that have worked well for me and that I think provide a pretty great experience.
10
10
11
-
*Note: the library itself is in [Kotlin](https://kotlinlang.org/), which is now [native to Android](https://blog.jetbrains.com/kotlin/2017/05/kotlin-on-android-now-official/). I have created sample applications in both***Kotlin***and***Java**. *So, as you go through and figure out how to implement this library, you can use either sample as a reference. They are functionally equivalent.*
12
-
13
-
*If you would like to see the usage section of this README in***Java***please head to the [Java-flavored README](README-JAVA.md).*
11
+
> *Note: the library itself is in [Kotlin](https://kotlinlang.org/), which is now [native to Android](https://blog.jetbrains.com/kotlin/2017/05/kotlin-on-android-now-official/). I have created sample applications in both***Kotlin***and***Java**. *The samples are functionally equivalent. If you would like to see the usage section of this README in***Java***please head to the [Java-flavored README](README_JAVA.md).*
Any other customization you want can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
72
+
Any other customization can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
If you would rather animate the `View` every time the page is shown, you could override the `TutorialPage#onShown(firstTimeShown: Boolean)` method, instead. If you override that, be sure to call the super class method.
99
97
100
-
### Providing results from the individual pages, or the entire tutorial
98
+
### Providing `TutorialPage` and `Activity` Results
101
99
102
100
<palign="center">
103
101
<imgsrc="artwork/result_data.gif">
104
102
</p>
105
103
106
-
Sometimes, you may need to have some state in your tutorial. If you are using the tutorial to log in a user, for example, you will probably need the calling `Activity` to know if the login was successful or not.
104
+
Sometimes, you may need store and provide some kind of state within the tutorial. For example: if you are using the tutorial to log in a user, you will probably need the calling `Activity` to know if the login was successful or not.
107
105
108
-
For an example of how to provide an `Activity` result from your `TutorialPage`, please see the [SelectionDialogExample](sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.kt).
106
+
Please see the [SelectionDialogExample](sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.kt) as an example of providing the calling `Activity` the result of your `FloatingTutorialActivity`.
109
107
110
108
Other times, you may need to know the result of the previous page, to display the UI for the next page. In the [RateItExample](sample-kotlin/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.kt), the first page asks the user to give a thumbs up or thumbs down.
111
109
@@ -130,7 +128,7 @@ Please fork this repository and contribute back using [pull requests](https://gi
130
128
131
129
## Changelog
132
130
133
-
The full changelog for the library can be found [here](https://github.com/klinker24/Android-FloatingTutorialActivity/blob/master/CHANGELOG.md).
131
+
The full changelog for the library can be found [here](CHANGELOG.md).
Copy file name to clipboardExpand all lines: README_JAVA.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
# Android Floating Tutorial Activity
6
6
7
-
This README discusses the usage of the tutorial in **Java** rather than **Kotlin**, which is demonstrated in the [README.md](README.md).
7
+
This README discusses the usage of the tutorial in **Java** rather than **Kotlin**. **Kotlin** usage is shown in the [README.md](README.md). The **Java** and **Kotlin** sample apps are functionally equivalent.
8
8
9
9
## Usage
10
10
@@ -63,7 +63,7 @@ new TutorialPage(context) {
63
63
})
64
64
```
65
65
66
-
Any other customization you want can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
66
+
Any other customization can come directly from your layout file. My examples show the primary color for the background of the top text. You could do that inside of your layout, if you like that look.
67
67
68
68
### Animating the layouts
69
69
@@ -90,15 +90,15 @@ new TutorialPage(context) {
90
90
91
91
If you would rather animate the `View` every time the page is shown, you could override the `TutorialPage#onShown(firstTimeShown: Boolean)` method, instead. If you override that, be sure to call the super class method.
92
92
93
-
### Providing results from the individual pages, or the entire tutorial
93
+
### Providing `TutorialPage` and `Activity` Results
94
94
95
95
<palign="center">
96
96
<imgsrc="artwork/result_data.gif">
97
97
</p>
98
98
99
-
Sometimes, you may need to have some state in your tutorial. If you are using the tutorial to log in a user, for example, you will probably need the calling `Activity` to know if the login was successful or not.
99
+
Sometimes, you may need store and provide some kind of state within the tutorial. For example: if you are using the tutorial to log in a user, you will probably need the calling `Activity` to know if the login was successful or not.
100
100
101
-
For an example of how to provide an `Activity` result from your `TutorialPage`, please see the [SelectionDialogExample](sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.java).
101
+
Please see the [SelectionDialogExample](sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/SelectionDialogExample.java) as an example of providing the calling `Activity` the result of your `FloatingTutorialActivity`.
102
102
103
103
Other times, you may need to know the result of the previous page, to display the UI for the next page. In the [RateItExample](sample-java/src/main/java/xyz/klinker/floating_tutorial/examples/RateItExample.java), the first page asks the user to give a thumbs up or thumbs down.
0 commit comments