material-intro: Material Design 风格的引导页
jopen
9年前
material-intro
Material Design 风格的引导页。A simple material design app intro with cool animations and a simple API.
Very inspired by Google's app intros.
Demo video on 油Tube: https://youtu.be/eKnCHw0UTrk
Demo
A demo app is available on Google Play:
Screenshots
Simple slide | Custom slide | Fade effect | Fullscreen |
---|---|---|---|
SimpleSlide.java | FragmentSlide.java | IntroActivity.java | IntroActivity.java |
Dependency
material-intro is available on jitpack.io
Gradle dependency:
allprojects { repositories { ... maven { url 'https://jitpack.io' } } }
dependencies { compile 'com.heinrichreimersoftware:material-intro:1.0' }
How-To-Use
Step 1: Your Activity
must extend IntroActivity
and be in your AndroidManifest.java:
public class MainIntroActivity extends IntroActivity{ @Override protected void onCreate(Bundle savedInstanceState){ super.onCreate(savedInstanceState); } }
<manifest ...> <application ...> <activity android:name=".MainIntroActivity" android:theme="@style/Theme.Intro"/> </application> </manifest>
Step 2: Add Slides:
public class MainIntroActivity extends IntroActivity{ @Override protected void onCreate(Bundle savedInstanceState){ super.onCreate(savedInstanceState); /** * Standard slide (like Google's intros) */ addSlide(new SimpleSlide.Builder() .title(R.string.title_1) .description(R.string.description_1) .image(R.drawable.image_1) .background(R.color.background_1) .backgroundDark(R.color.background_dark_1) .build()); /** * Custom fragment slide */ addSlide(new FragmentSlide.Builder() .background(R.color.background_2) .backgroundDark(R.color.background_dark_2) .fragment(R.layout.fragment_2, R.style.FragmentTheme) .build()); } }
Slide types:
SimpleSlide
: Standard slide featuring a title, short description and image like Google's intros.FragmentSlide
: Custom slide containing aFragment
or a layout resource.Slide
: Base slide. If you want to modify what's shown in your slide this is the way to go.- Feel free to submit an issue or pull request if you think any slide types are missing
Step 3: Enable features:
public class MainIntroActivity extends IntroActivity{ @Override protected void onCreate(Bundle savedInstanceState){ /* Enable/disable fullscreen */ setFullscreen(true); super.onCreate(savedInstanceState); /* Enable/disable skip button */ setSkipEnabled(true); /* Enable/disable finish button */ setFinishEnabled(true); /* Add your own page change listeners */ addOnPageChangeListener(new ViewPager.OnPageChangeListener(){ @Override public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) { } @Override public void onPageSelected(int position) { } @Override public void onPageScrollStateChanged(int state) { } }); } }
Changes
- Version 1.0:
- Initial release
Open source libraries
material-intro uses the following open source files:
- CheatSheet.java by @Roman Nurik (Apache License 2.0)
- AnimUtils.java by @Nick Butcher (Apache License 2.0)
- InkPageIndicator.java by @Nick Butcher (Apache License 2.0)
License
Copyright 2016 Heinrich Reimer 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.