README.md

AppIntro

Um simples pacote para adicionar telas de introdução no seu aplicativo. Desenvolvido com a linguagem Kotlin.

Contribuição

Você pode contribuir para este projeto, fazendo o Fork, e o pull request. Ajude a manter o projeto, contribuindo.

Contactos

Fale comigo pelo Facebook, Twitter.

Visite também o meu Canal no youtube.

Requisitos

• Android API level 16 ou posterior;
• Sua IDE favorita.

Inicializando

Gradle:

Passo 1. Adicionar o jitpack.io Adiciona isto no seu build.gradle do diretorio principal:

allprojects {
    repositories {
	        ...
	        maven { url 'https://jitpack.io' }
    }
}

Passo 2. Adicionar a dependência

dependencies {
	        compile 'com.github.pedromassango:appIntro:v1.0-beta'
	}

Maven:

Passo 1. registar o jitpack.io

<repositories>
	<repository>
	    <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
	</repository>
</repositories>

Passo 2. Adicionar a dependência

<dependency>
    <groupId>com.github.pedromassango</groupId>
    <artifactId>appIntro</artifactId>
    <version>v1.0-beta</version>
</dependency>

Uso básico

Para adicionar um slide você deve usar a classe IntroSlide, como descrita abaixo:

    IntroSlide(
            // Slide title (String)
            ,
            // Slide description (String)
            ,
            // Slide background color (Int)
            ,
            // Slide icon (resource icon -> Int)
            )

Crie uma classe que extenda de IntroActivity e sobrescreva os seguintes métodos:

setupIntro() - Inicie/Adicione os slides neste método.

onBack(slide: IntroSlide) - Será executado quando o botão BACK for clicado

onNext(slide: IntroSlide) - Será executado quando o botão NEXT for clicado

onFinish(slide: IntroSlide) - Será executado quando o último slide for alcançado, e não haver mais slides.

Código de exemplo:

class TestIntroActivity : IntroActivity() {
    
    // Do not override onCreate()
    
    override fun setupIntro() {
        
        // Adding slides to show
        
        addSlide(IntroSlide(
                getString(R.string.app_name).toUpperCase(),
                getString(R.string.descp),
                backgroundColor = Color.MAGENTA,
                mIcon = R.mipmap.ic_launcher))
                
        // Add more slides here
    }
    
    override fun onBack(slide: IntroSlide) {
        // Back pressed
    }
    
    override fun onNext(slide: IntroSlide) {
        // Next pressed
    }
    
    override fun onFinish(slide: IntroSlide) {
        // All slides was shown.
    }
}

Note que não sobrescrevi o onCreate() isso por que, não precisamos dele aqui, apenas devemos iniciar os trabalhos no método setupIntro().