Description
Make amazing OnBoarding Screens easily for your app with different colorful animations, fonts, styles, and many more. Customize your onboarding as per your requirements.
WalkThroughAndroid alternatives and similar packages
Based on the "Kotlin" category.
Alternatively, view Walk-Through-Screen alternatives based on common mentions on social networks and blogs.
-
android-youtube-player
YouTube Player library for Android and Chromecast, stable and customizable. -
CalendarView
A highly customizable calendar view and compose library for Android. -
Balloon
:balloon: Modernized and sophisticated tooltips, fully customizable with an arrow and animations for Android. -
Kotterknife
Android view injection writen in Kotlin based on ButterKnife -
Shortbread
Android library that creates app shortcuts from annotations -
kotlin-android-template
Android + Kotlin + Github Actions + ktlint + Detekt + Gradle Kotlin DSL + buildSrc = โค๏ธ -
NotyKT ๐๏ธ
๐ NotyKT is a complete ๐Kotlin-stack (Backend + Android) ๐ฑ application built to demonstrate the use of Modern development tools with best practices implementation๐ฆธ. -
Material Chip View
Material Chip view. Can be used as tags for categories, contacts or creating text clouds -
DrawableToolbox
๐ ๏ธ The missing drawable toolbox for Android. Create drawables programmatically and get rid of the boring and always repeated drawable.xml files. -
Navigation Toolbar for Android
:octocat: Navigation toolbar is a slide-modeled UI navigation controller made by @Ramotion -
CodeView
Display code with syntax highlighting :sparkles: in native way. -
Carousel Recyclerview
Carousel Recyclerview let's you create carousel layout with the power of recyclerview by creating custom layout manager. -
Pluto Debug Framework
Pluto is a on-device debugging framework for Android applications, which helps in inspection of HTTP requests/responses, capture Crashes and ANRs and manipulating application data on-the-go. -
MaterialTimelineView
With MaterialTimelineView you can easily create a material looking timeline. -
Android Kotlin Samples
Some basic samples of Kotlin for Android -
MaterialDrawerKt
A Kotlin DSL wrapper around the mikepenz/MaterialDrawer library. -
sliding-panel
Android sliding panel that is part of the view hierarchy, not above it. -
CrunchyCalendar โ awesome calendar widget for android apps
A beautiful material calendar with endless scroll, range selection and a lot more! -
Pdf Viewer For Android
A Lightweight PDF Viewer Android library which only occupies around 125kb while most of the Pdf viewer occupies up to 16MB space. -
Transition X
{ } Declarative Kotlin DSL for choreographing Android transitions -
Capturable
๐Jetpack Compose utility library for capturing Composable content and transforming it into Bitmap Image๐ผ๏ธ -
Only
:bouquet: An easy way to persist and run code block only as many times as necessary on Android. -
Swagger Gradle Codegen
๐ซ A Gradle Plugin to generate your networking code from Swagger -
SSCustomBottomNavigation
Animated TabBar with native control and Jetpack Navigation support..โจ๐๐ -
SSComposeCookBook
A Collection of major Jetpack compose UI components which are commonly used.๐๐๐ -
EasyPermissions-ktx
๐ Kotlin version of the popular google/easypermissions wrapper library to simplify basic system permissions logic on Android M or higher. -
Awesome Jetpack compose
A collaborative list of awesome jetpack compose resources. -
DeviceInfo-Sample
[Android Library] Get easy access to device information super fast, real quick -
CameraViewEx
Easy Android camera integration, advanced features. -
Permission Flow for Android
Know about real-time state of a Android app Permissions with Kotlin Flow APIs. -
Aimybox voice assistant
Embeddable custom voice assistant for Android applications -
Events Calendar
Events Calendar is a user-friendly library that helps you achieve a cool Calendar UI with events mapping. You can customise every pixel of the calendar as per your wish and still achieve in implementing all the functionalities of the native android calendar in addition with adding dots to the calendar which represents the presence of an event on the respective dates. It can be done easily, you are just a few steps away from implementing your own badass looking Calendar for your very own project! -
Intro Showcase View
Highlight different features of the app using Jetpack Compose -
Nextflix-Composable
Includes jetpack compose, navigation, paging, hilt, retrofit, coil, coroutines, flow.. -
ZoomHelper
ZoomHelper will make any view to be zoomable just like Instagram pinch-to-zoom -
SSCustomEditTextOutLineBorder
Same as the Outlined text fields presented on the Material Design page but with some dynamic changes. ๐ ๐ -
Maildroid
Maildroid is a small robust android library for sending emails using SMTP server -
Vanilla Place Picker
Simple(vanilla) yet 'Do it all' place picker for your place picking needs in Android -
TimelineView
A customizable and easy-to-use Timeline View library for Android. Works as a RecyclerView decorator (ItemDecoration) -
Crowdin Android SDK
Crowdin Android SDK delivers all new translations from Crowdin project to the application immediately -
Turtle ๐ข
Run shell commands from a Kotlin script or application with ease -
EasyCrypt
Android cryptography library with SecureRandom patches.
Appwrite - The Open Source Firebase alternative introduces iOS support
Do you think we are missing an alternative of WalkThroughAndroid or a related project?
README
WalkThroughAndroid
Make amazing OnBoarding Screens easily for your app with different colorful animations, fonts, styles, and many more. Customize your onboarding as per your requirements.
Indicator Animation/Indicator Style
DEFAULT | CIRCLE | RECTANGLE | SQUARE | ROUNDED_RECTANGLE | VECTOR | BITMAP | |
---|---|---|---|---|---|---|---|
NONE | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
SCALE | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
SMOOTH_SCALE | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
LEFT_IN | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
RIGHT_IN | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
FLIP | ![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Content Animation Style
Animation Type | Preview |
---|---|
NONE | ![]() |
FADE | ![]() |
SLIDER | ![]() |
SCALE | ![]() |
TOP_IN | ![]() |
BOTTOM_IN | ![]() |
BOUNCE | ![]() |
Key features
- Simple implementation
- Set Title and Description
- Set Content Animation
- Set Pager Indicator Animation
- Customize Title and Description
- Set OnBoarding image with drawable and image url
- Support for both Activity and Fragment
Usage
Dependencies
Step 1. Add the JitPack repository to your build file
Add it in your root build.gradle at the end of repositories:
allprojects { repositories { ... maven { url 'https://jitpack.io' } } }
Step 2. Add the dependency
Add it in your app module build.gradle:
dependencies { ... implementation 'com.github.Mindinventory:Walk-Through-Screen:0.1.4' }
Implementation
Step 1. Prepare List for your OnBoarding screen
val walkThroughScreens = ArrayList<WalkThroughScreenModel>().apply { add( WalkThroughScreenModel( image = R.drawable.tasty_dish, title = R.string.choose_a_tasty_dish, description = R.string.order_anything ) ) add( WalkThroughScreenModel( image = R.drawable.order, title = R.string.order, description = R.string.place_order ) ) add( WalkThroughScreenModel( image = R.drawable.delivery, title = R.string.pick_up_or_delivery, description = R.string.we_make_food ) ) }
Step 2. Customize title, description, indicator, animation
val walkThroughIntent = walkThrough { with { [email protected] } // Pass Content walkThroughScreens { walkThroughScreens } // Pass Screens List titleColor { R.color.black } // Title Color descriptionColor { R.color.black } // Description Color titleFontFamily { R.font.robotobold } // Title FontFamily descriptionFontFamily { R.font.robotolight } // Description FontFamily titleFontSize { 8.0F } // Title Font Size descriptionFontSize { 4.0F } // Description Font Size skipButtonFontFamily { R.font.robotolight } // Skip Button FontFamily skipButtonColor { R.color.yellow } // Skip Button Color backgroundColor { R.color.white } // Background Color for screen activeIndicatorColor { R.color.yellow } // Active Indicator Color inactiveIndicatorColor { R.color.light_yellow } // Inactive Indicator Color indicatorStyle { IndicatorStyle.ROUNDED_RECTANGLE } // Indicator Style CIRCLE, RECTANGLE, SQUARE, ROUNDED_RECTANGLE, VECTOR, BITMAP activeVectorDrawableRes { Your Vector } // Active Indicator Vector Drawable Res , Set If Indicator Style = VECTOR inactiveVectorDrawableRes { Your Vector } // Inactive Indicator Vector Drawable Res , Set If Indicator Style = VECTOR activeBitmapDrawableRes { R.drawable.tasty_dish } // Active Indicator Bitmap Drawable Res , Set If Indicator Style = BITMAP inactiveBitmapDrawableRes { R.drawable.order } // Active Indicator Bitmap Drawable Res , Set If Indicator Style = BITMAP activeVectorDrawableSize { 50 } // Active Vector Drawable Size in PX inactiveVectorDrawableSize { 50 } // Inactive Vector Drawable Size in PX activeBitmapDrawableSize { 50 } // Inactive Bitmap Drawable Size in PX inactiveBitmapDrawableSize { 50 } // Inactive Bitmap Drawable Size in PX indicatorGap { R.dimen.dp_5 } // Gap Between Indicators indicatorAnimationType { IndicatorAnimationType.NONE } // Indicator Animation Type SCALE, SMOOTH_SCALE, LEFT_IN, RIGHT_IN, FLIP activeIndicatorWidth { R.dimen.dp_30 } // Active Indicator Width activeIndicatorHeight { R.dimen.dp_8 } // Active Indicator Height inactiveIndicatorWidth { R.dimen.dp_8 } // Inactive Indicator Width inactiveIndicatorHeight { R.dimen.dp_8 } // Inactive Indicator Height contentAnimationType { ContentAnimationType.FADE } // Content Animation Type FADE, SLIDER, SCALE, TOP_IN, BOTTOM_IN, BOUNCE buttonColor { R.color.yellow } // Next/Finish Button Color buttonTextColor { R.color.white } // Next/Finish Button Text color skipButtonFontSize { 4.0F } // Skip Button Font Size }
For Activity
Step 3. Add Launcher to start Next Activity After OnBoarding
var resultLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result -> if (result.resultCode == Activity.RESULT_OK) { startActivity(Intent(this, HomeActivity::class.java)) finish() } }
Step 4. Launch Launcher using intent
resultLauncher.launch(walkThroughIntent)
For Fragment
Step 3. Get Bundle from intent
val walkThroughBundle = walkThroughIntent.extras
Step 4. Add WalkThroughFragment in your navigation graph and provide your action from WalkThroughFragment to Your Fragment where you want to navigate user after OnBoarding Screens
<fragment android:id="@+id/walkThroughFragment" android:name="com.mi.walkthroughandroid.ui.fragment.WalkThroughFragment" android:label="WalkThroughFragment" tools:layout="@layout/fragment_walk_through"> <!--Provide Your Action to navigate --> </fragment>
Step 5. Add Navigation Action from your fragment to WalkThroughFragment
Step 6. Navigate from your fragment(i.e, Here we have used SampleFragment) to WalkThroughFragment
findNavController().navigate( R.id.action_sampleFragment_to_walkThroughFragment, walkThroughBundle )
Step 7. Implement WalkThroughFragment.WalkThroughFragmentListener in your FragmentHostingActivity
Step 8. Override onSkipOrFinish() method and Navigate to next fragment
override fun onSkipOrFinish(isFromOnSkip: Boolean) { findNavController(R.id.fragmentContainer).navigate(R.id.action_walkThroughFragment_to_homeFragment) }
How to contribute?
Contribution towards our repository is always welcome, we request contributors to create a pull request to the develop branch only.
How to report an issue/feature request?
It would be great for us if the reporter can share the below things to understand the root cause of the issue.
- Library version
- Code snippet
- Logs if applicable
- Device specification like (Manufacturer, OS version, etc)
- Screenshot/video with steps to reproduce the issue
Requirements
- minSdkVersion >= 23
- Androidx
Library used
Limitation
- Layout support up to 4.65 inch devices
Sample for implementation
LICENSE!
WalkThroughAndroid is MIT-licensed.
Let us know!
Weโd be really happy if you send us links to your projects where you use our component. Just send an email to [email protected] And do let us know if you have any questions or suggestion regarding our work.
*Note that all licence references and agreements mentioned in the WalkThroughAndroid README section above
are relevant to that project's source code only.