Waterfall Toolbar
Waterfall Toolbar is an Android version of Material Design's web component waterfall toolbar. Basically, what it does is dynamize an ordinary Toolbar, increasing and decreasing its shadow when an associated view is scrolled.
You can download the sample.apk to get a better notion of what's going on.
Setup
Gradle dependency
Waterfall Toolbar is available on Jitpack.
To add this library to your project, add the code below to your root (not module) build.gradle file:
allprojects {
repositories {
...
maven {
url 'https://jitpack.io'
}
}
}
And this one to your module build.gradle file:
dependencies {
...
compile 'com.github.hugocastelani:waterfall-toolbar:0.1.1'
}
Implementation
Implementing Waterfall Toolbar is quite simple. All you gotta do is add it to your layout via XML or Java and refer a RecyclerView or a ScrollView.
Your XML code:
<com.hugocastelani.waterfalltoolbar.library.WaterfallToolbar
android:id="@+id/waterfall_toolbar"
android:layout_width="match_parent"
android:layout_height="wrap_content">
<android.support.v7.widget.Toolbar
android:id="@+id/toolbar"
android:layout_width="match_parent"
android:layout_height="?actionBarSize"/>
</com.hugocastelani.waterfalltoolbar.library.WaterfallToolbar>Your Java code:
public class MainActivity extends AppCompatActivity {
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
...
WaterfallToolbar mWaterfallToolbar = (WaterfallToolbar) findViewById(R.id.waterfall_toolbar);
mWaterfallToolbar.addRecyclerView(mRecyclerView);
}
}
Congratulations, you're all set!
Note: you can do whatever you want with your inner Toolbar, Waterfall Toolbar won't interfere.
Customization
Well, there are people who follow standards and people who create their standards. These last ones can customize three aspects of Waterfall Toolbar.
Note: sample project provides a nice environment to test all these things. Maybe you should give it a try.
Initial elevation
The elevation with which the toolbar starts. Default value: 1 dp.
Your Java code:
mWaterfallToolbar.setInitialElevation(0);
Result:
As you can see, that initial tiny shadow no longer exists.
Note: Waterfall Toolbar extends CardView, and its elevation in taken seriously by Android. If you set elevation as 0 and there's another view below it, Waterfall Toolbar is going to be overlaid. Fortunately, if you set the views' limits properly, you won't have any related trouble.
Final elevation
The elevation the toolbar gets when it reaches final scroll elevation. Default value: 6 dp.
Your Java code:
mWaterfallToolbar.setFinalElevation(10);
Result:
As result, the final shadow gets much bigger.
Scroll final position
The percentage of the screen's height that is going to be scrolled to reach the final elevation. Default value: 6%.
Your Java code:
// first gif mWaterfallToolbar.setScrollFinalPosition(2);
// second gif mWaterfallToolbar.setScrollFinalPosition(20);
Result:
Now, the final shadow takes much less and much longer to completely appear, respectively.
Current project situation
Waterfall Toolbar can be used, but there's one inconvenient bugs yet. I'm going to try to fix it in my spare time.
Developer
Contact me
Support me
[email protected]
If you enjoy my work and have a lots of money left over, please support me via PayPal :)
License
MIT License
Copyright (c) 2017 Hugo Castelani
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.