https://github.com/Popalay/Tutors

A simple way to show the user interface tutorials
https://github.com/Popalay/Tutors

kotlin-android showcase tutorials

Last synced: 1 day ago
JSON representation

A simple way to show the user interface tutorials

• Host: GitHub
• URL: https://github.com/Popalay/Tutors
• Owner: Popalay
• License: apache-2.0
• Created: 2017-01-11T17:49:22.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-28T16:01:23.000Z (almost 7 years ago)
• Last Synced: 2024-04-15T10:11:20.898Z (2 months ago)
• Topics: kotlin-android, showcase, tutorials
• Language: Java
• Homepage:
• Size: 9.27 MB
• Stars: 82
• Watchers: 8
• Forks: 19
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• my-awesome-starred - Popalay/Tutors - A simple way to show the user interface tutorials (Java)
• awesome-github-android-ui - Tutors - 种显示用户界面教程 (用户引导)
• awesome-github-android-ui - Tutors - 种显示用户界面教程 (用户引导)

README

        
[![Download](https://api.bintray.com/packages/popalay/maven/Tutors/images/download.svg) ](https://bintray.com/popalay/maven/Tutors/_latestVersion)

[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Tutors-orange.svg?style=flat)](https://android-arsenal.com/details/1/5075)

[![API](https://img.shields.io/badge/API-14%2B-blue.svg?style=flat)](https://android-arsenal.com/api?level=14)

[![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://github.com/Popalay/Tutors/blob/master/LICENSE)

# Tutors

A simple way to show the user interface tutorials.



## Getting Started

```groovy

compile 'com.github.popalay:tutors:latest-version'

compile 'com.github.popalay:tutors-kotlin:latest-version'

```

## Usage

### From Java

```java

Tutors tutors = new TutorsBuilder()

                .textColorRes(android.R.color.white)

                .shadowColorRes(R.color.shadow)

                .textSizeRes(R.dimen.textNormal)

                .completeIconRes(R.drawable.ic_cross_24_white)

                .nextButtonTextRes(R.string.action_next)

                .completeButtonTextRes(R.string.action_got_it)

                .spacingRes(R.dimen.spacingNormal)

                .lineWidthRes(R.dimen.lineWidth)

                .cancelable(false)

                .build();

tutors.show(getSupportFragmentManager(), toolbar, "It's a toolbar", !iterator.hasNext());

```

See [sample](sample/src/main/java/com/github/popalay/tutorssample/MainActivity.java).

### From Kotlin

```kotlin

val tutors = Tutors.create {

             textColorRes = android.R.color.white

             shadowColorRes = R.color.shadow

             textSizeRes = R.dimen.textNormal

             completeIconRes = R.drawable.ic_cross_24_white

             nextButtonTextRes = R.string.action_next

             completeButtonTextRes = R.string.action_got_it

             spacingRes = R.dimen.spacingNormal

             lineWidthRes = R.dimen.lineWidth

             cancelable = false

}

tutors.show(supportFragmentManager, view = toolbar, text = "It's a toolbar", isLast = true)

```

See [sample](sample/src/main/kotlin/com/github/popalay/tutorssample/MainKotlinActivity.kt).

License

-----

	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.