Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edsilfer/android-user-onboarding
Provides an easy to set User OnBoarding based on Google's design
https://github.com/edsilfer/android-user-onboarding
Last synced: 16 days ago
JSON representation
Provides an easy to set User OnBoarding based on Google's design
- Host: GitHub
- URL: https://github.com/edsilfer/android-user-onboarding
- Owner: edsilfer
- License: apache-2.0
- Created: 2016-11-23T17:03:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-03-13T20:01:07.000Z (over 7 years ago)
- Last Synced: 2024-02-23T03:37:06.900Z (4 months ago)
- Language: Kotlin
- Homepage:
- Size: 5.01 MB
- Stars: 23
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-kotlin - Kotlin User Onboarding - A simple and customizable android onboarding library written in Kotlin matching Material Guidelines. (Libraries)
- awesome-kotlin - Kotlin User Onboarding - A simple and customizable android onboarding library written in Kotlin matching Material Guidelines. (Libraries)
README
# Android Search Interface
[  ](https://bintray.com/edsilfer/maven/user-onboarding/_latestVersion) - **MIN API VERSION: 16**
## Introduction
> User onboarding is the process of improving a person's success with a product or service. This term is often used in reference to software products, and it can be done in a manual or automated way.
*Source: https://en.wikipedia.org/wiki/User_onboarding*
Figure 01: Android User OnBoarding library on action
## How does it work?
Android List Manager was developed using [Kotlin language](https://kotlinlang.org/). Kotlin is free to use and owned by [Jet Brains](https://www.jetbrains.com/). It adds a lot of cool features, boosting your productiveness while keeping everythying **100% compatible with Java.**
_For details about technical implementation of this library please refer to the source code._
#### Step 01: import the module
```gradle
compile 'br.com.edsilfer.android:user-onboarding:1.0.0'
```
#### Step 02: Fill in a OnBoardingTheme Object:
```kotlin
class OnBoardingTheme : Serializable {
var bottomPanelColors = BottomPanelColors()
var pages = listOf()
}
data class Page(
var background: Int,
var header: Int,
var headerStyle: Text,
var image: Int,
var subHeader1: Int,
var subHeader1Style: Text,
var subHeader2: Int,
var subHeader2Style: Text,
var customLayoutResource: Int // Optional parameter. Do not forget to use same view ids if you set your own layout.
) : Serializable {}
class BottomPanelColors(
var indicatorActiveColor: Int = Color.parseColor("#FFFFFF"),
var indicatorInactiveColor: Int = Color.parseColor("#FFFFFF"),
var skipColor: Int = Color.parseColor("#FFFFFF"),
var nextColor: Int = Color.parseColor("#FFFFFF"),
var finishColor: Int = Color.parseColor("#FFFFFF"),
var dividerColor: Int = Color.parseColor("#FFFFFF")
) : Serializable {}
```
*Each page added on pages represents a Page to be place as part of the ViewPager*
*You can use different colors for bottom panel via BottomPanelColor class*
#### Step 03: Launch ActivityUserOnBoarding:
```kotlin
val pages = arrayListOf()
pages.add(getPage1())
pages.add(getPage2())
pages.add(getPage3())
pages.add(getPage4())
val theme = OnBoardingTheme()
theme.pages = pages
theme.panelColor = getBottomPanelColors()
theme.bottomPanelLayoutResource = R.layout.custom_bottom_panel // You can set your own layout for bottom panel
val intent = Intent(this, ActivityUserOnBoarding::class.java)
intent.putExtra(ActivityUserOnBoarding.ARG_ONBOARDING_THEME, theme)
startActivity(intent)
```
#### Step 04: Check sample app for more details!
## Special Thanks
- This library was built based on [this](http://blog.grafixartist.com/onboarding-android-viewpager-google-way/) nice tutorial posted by Suleiman on Grafix Artist.
- User [Josef Hruška](https://github.com/JosefHruska) for improving the versatility of the lib;
## License
Copyright 2016 Edgar da Silva Fernandes
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.