Простое введение в приложение Material Design с классной анимацией и гибким API.
Очень вдохновлен вступлениями к приложениям Google.
Демо-приложение доступно в Google Play:
Простой слайд | Пользовательский слайд | Эффект затухания | Запрос разрешения |
---|---|---|---|
SimpleSlide.java | FragmentSlide.java | IntroActivity.java | SimpleSlide.java |
Material-intro доступен на jitpack.io .
Добавьте это в свой корневой файл build.gradle
( а не в файл build.gradle
вашего модуля):
allprojects {
repositories {
maven { url ' https://jitpack.io ' }
}
}
Добавьте это в файл build.gradle
вашего модуля:
dependencies {
implementation ' com.heinrichreimersoftware:material-intro:x.y.z '
}
Активность должна расширять IntroActivity
и иметь тему, расширяющую @style/Theme.Intro
:
public class MainIntroActivity extends IntroActivity {
@ Override
protected void onCreate ( Bundle savedInstanceState ) {
super . onCreate ( savedInstanceState );
// Add slides, edit configuration...
}
}
< manifest ...>
< application ...>
< activity
android : name = " .MainIntroActivity "
android : theme = " @style/Theme.Intro " />
</ application >
</ manifest >
(Если не указано иное, все следующие вызовы методов должны выполняться в onCreate()
действия.)
Material-intro имеет свободные конструкторы стилей как для простых слайдов с текстом и изображением, как показано в приложениях Google, так и для слайдов с пользовательским Fragment
или ресурсом макета.
Не стесняйтесь отправить сообщение о проблеме или запрос на включение, если вы считаете, что какие-либо типы слайдов отсутствуют.
SimpleSlide
):Стандартный слайд с заголовком, кратким описанием и изображением, как у Google.
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 )
. scrollable ( false )
. permission ( Manifest . permission . CAMERA )
. build ());
FragmentSlide
): Пользовательский слайд, содержащий Fragment
или ресурс макета.
addSlide ( new FragmentSlide . Builder ()
. background ( R . color . background_2 )
. backgroundDark ( R . color . background_dark_2 )
. fragment ( R . layout . fragment_2 , R . style . FragmentTheme )
. build ());
(При использовании FragmentSlide
с Fragment
вам следует расширить SlideFragment
для проксирования вызовов навигации во вступительном действии.)
Slide
):Базовый слайд. Если вы хотите изменить то, что показано на слайде, это лучший вариант.
Управляйте поведением левой кнопки или скройте/покажите ее.
/* Show/hide button */
setButtonBackVisible ( true );
/* Use skip button behavior */
setButtonBackFunction ( BUTTON_BACK_FUNCTION_SKIP );
/* Use back button behavior */
setButtonBackFunction ( BUTTON_BACK_FUNCTION_BACK );
Управляйте поведением правой кнопки или скройте/покажите его.
/* Show/hide button */
setButtonNextVisible ( true );
/* Use next and finish button behavior */
setButtonNextFunction ( BUTTON_NEXT_FUNCTION_NEXT_FINISH );
/* Use next button behavior */
setButtonNextFunction ( BUTTON_NEXT_FUNCTION_NEXT );
Измените внешний вид кнопки «Призыв к действию»:
/* Show/hide button */
setButtonCtaVisible ( getStartedEnabled );
/* Tint button text */
setButtonCtaTintMode ( BUTTON_CTA_TINT_MODE_TEXT );
/* Tint button background */
setButtonCtaTintMode ( BUTTON_CTA_TINT_MODE_BACKGROUND );
/* Set custom CTA label */
setButtonCtaLabel ( R . string . start )
/**/
setButtonCtaClickListener ( new View . OnClickListener () {
});
Отобразите вводное действие в полноэкранном режиме. Это скроет строку состояния.
public class MainIntroActivity extends IntroActivity {
@ Override protected void onCreate ( Bundle savedInstanceState ){
setFullscreen ( true );
super . onCreate ( savedInstanceState );
...
}
}
Обязательно вызовите setFullscreen()
перед вызовом super.onCreate()
Настройте продолжительность прокрутки одного слайда.
setPageScrollDuration ( 500 );
(Длительность прокрутки страницы динамически адаптируется при прокрутке более чем на одну позицию, чтобы отразить динамическую длительность из документации по дизайну материалов. Точная формула для расчета продолжительности прокрутки — это duration * (distance + sqrt(distance)) / 2
.)
Есть три способа заблокировать навигацию по слайду:
SlideFragment
(с использованием FragmentSlide
) путем переопределения методов canGoForward()
/ canGoBackward()
.SimpleSlide
установите SimpleSlide.Builder#canGoForward(boolean)
/ SimpleSlide.Builder#canGoBackward(boolean)
. (Если хотя бы одно разрешение установлено для SimpleSlide
, навигация автоматически блокируется до тех пор, пока не будет предоставлено каждое разрешение.)IntroActivity
, установив NavigationPolicy
: setNavigationPolicy ( new NavigationPolicy () {
@ Override public boolean canGoForward ( int position ) {
return true ;
}
@ Override public boolean canGoBackward ( int position ) {
return false ;
}
});
Перейдите по вступлению вручную, используя один из следующих методов, например, с помощью обратного вызова прослушивателей. Каждый из них будет соблюдать заблокированные настройки навигации.
/* Scroll to any position */
goToSlide ( 5 );
/* Scroll to the next slide in the intro */
nextSlide ();
/* Scroll to the previous slide in the intro */
previousSlide ();
/* Scroll to the last slide of the intro */
goToLastSlide ();
/* Scroll to the first slide of the intro */
goToFirstSlide ();
Автоматически прокручивать вступление, пока пользователь не начнет взаимодействовать с вступлением.
/* Start an auto slideshow with 2500ms delay between scrolls and infinite repeats */
autoplay ( 2500 , INFINITE );
/* Start an auto slideshow with default configuration */
autoplay ();
/* Cancel the slideshow */
cancelAutoplay ()
Если что-либо из вышеперечисленного возвращает false
когда пользователь пытается перейти к слайду, запускается обратный вызов OnNavigationBlockedListener
, который можно использовать для отображения сообщения. Кроме того, вы можете добавить старые ViewPager.OnPageChangeListener
для прослушивания прокрутки страниц:
addOnNavigationBlockedListener ( new OnNavigationBlockedListener () {
@ Override public void onNavigationBlocked ( int position , int direction ) { ... }
});
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 ) { ... }
});
Вы можете проверить, отменил ли пользователь вступление (нажав «Назад») или завершил его, включая все слайды. Просто вызовите действие, используя startActivityForResult(intent, REQUEST_CODE_INTRO);
а затем послушайте результат:
@ Override
protected void onActivityResult ( int requestCode , int resultCode , Intent data ) {
super . onActivityResult ( requestCode , resultCode , data );
if ( requestCode == REQUEST_CODE_INTRO ) {
if ( resultCode == RESULT_OK ) {
// Finished the intro
} else {
// Cancelled the intro. You can then e.g. finish this activity too.
finish ();
}
}
}
Вы можете легко добиться красивого эффекта параллакса для любого слайда, используя ParallaxFrameLayout.java
, ParallaxLinearLayout.java
или ParallaxRelativeLayout.java
и определив layout_parallaxFactor
для его прямых дочерних элементов. Более высокий коэффициент означает более сильный эффект параллакса, 0
означает отсутствие эффекта параллакса вообще.
< com .heinrichreimersoftware.materialintro.view.parallax.ParallaxLinearLayout
android : layout_width = " match_parent "
android : layout_height = " match_parent "
... >
< TextView
android : layout_width = " match_parent "
android : layout_height = " wrap_content "
app : layout_parallaxFactor = " 0 "
... />
< ImageView
android : layout_width = " match_parent "
android : layout_height = " wrap_content "
app : layout_parallaxFactor = " 1.25 "
... />
</ com .heinrichreimersoftware.materialintro.view.parallax.ParallaxLinearLayout>
Пример макета см. в демо-версии «Столовой».
Если вы хотите, чтобы вступление отображалось только при первом запуске приложения, вы можете использовать onActivityResult()
для сохранения общих настроек, когда пользователь завершил вступление.
См. демонстрационное приложение для примера реализации экрана-заставки:
Список изменений смотрите в разделе релизов.
Material-intro использует следующие файлы с открытым исходным кодом:
MIT License
Copyright (c) 2017 Jan Heinrich Reimer
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.