dudmy / TutorialPop

:herb: A library that makes tutorials easier to use

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TutorialPop

license download

It's easier to use tutorial popup that you only need to show once.

How to use

Add to dependencies

dependiencies {
    compile 'net.dudmy:tutorialpop:1.0.0'
}

Base with java

First, you need to prepare in the Application class. Pass the context and the class name list of the page where the tutorial should be shown as a parameter.

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        List<String> tutorList = new ArrayList<>();
        tutorList.add(FirstActivity.class.getSimpleName());
        tutorList.add(SecondActivity.class.getSimpleName());

        TutorialPopHelper.INSTANCE.prepareTutorial(getApplicationContext(), tutorList);
    }
}

and then determine the current page needed tutorial in the Base Activity class.

public class BaseActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        TutorialPopHelper.INSTANCE.showTutorialIfNeed(getClass().getSimpleName());
    }
}

Base with kotlin

First, you need to prepare in the Application class. Pass the context and the class name list of the page where the tutorial should be shown as a parameter.

class MyApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        TutorialPopHelper.prepareTutorial(applicationContext,
                listOf(FirstActivity::class.java.simpleName, SecondActivity::class.java.simpleName))
    }
}

and then determine the current page needed tutorial in the Base Activity class.

open class BaseActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        TutorialPopHelper.showTutorialIfNeed(javaClass.simpleName)
    }
}

Drawable name convention

The tutorial drawable resource name should look like tutorial_{ClassNameWithLowerCase}.
If the class name of the page to show is FirstActivity, the resource name is tutorial_firstactivity.

Used library version

  • Kotlin version: 1.1.2-3
  • Support library version: 25.3.1

License

Copyright 2017 Yujin Jung

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.

About

:herb: A library that makes tutorials easier to use


Languages

Language:Java 56.2%Language:Kotlin 43.8%