Home

Awesome

Needs

License API Build Status Android Arsenal Android Weekly Javadoc<br> An easy way to implement modern permission instructions popup. <br> Needs can be fully customized and showing with animations. <br>

img0 img1

Download

Maven Central JitPack

Gradle

Add below codes to your root build.gradle file (not your module build.gradle file).

allprojects {
    repositories {
        mavenCentral()
    }
}

And add a dependency code to your module's build.gradle file.

dependencies {
    implementation "com.github.skydoves:needs:1.1.2"
}

Usage

Basic example

This is a basic example on a screenshot. Here is how to create Needs using Needs.Builder.

Needs needs = new Needs.Builder(context)
      .setTitle("Permission instructions for using this Android app.")
      .addNeedsItem(new NeedsItem(null, "· SD Card", "(Required)", "Access photos, media, and files on device."))
      .addNeedsItem(new NeedsItem(null, "· Location", "(Required)", "Access this device's location."))
      .addNeedsItem(new NeedsItem(null, "· Camera", "(Optional)", "Take pictures and record video."))
      .addNeedsItem(new NeedsItem(null, "· Contact", "(Optional)", "Access this device's contacts."))
      .addNeedsItem(new NeedsItem(null, "· SMS", "(Optional)", "Send and view SMS messages."))
      .setDescription("The above accesses are used to better serve you.")
      .setConfirm("Confirm")
      .setBackgroundAlpha(0.6f)
      .setLifecycleOwner(lifecycleOwner)
      .build();

Create using kotlin dsl

This is how to create Needs's instance using kotlin dsl.

val needs = createNeeds(baseContext) {
      titleIcon = iconDrawable
      title = "Permission instructions \nfor using this Android app."
      titleTextForm = titleForm
      addNeedsItem(NeedsItem(drawable_sd, "SD Card", "(Required)", "Access photos, media, and files on device."))
      addNeedsItem(NeedsItem(drawable_location, "Location", "(Required)", "Access this device's location."))
      addNeedsItem(NeedsItem(drawable_camera, "Camera", "(Optional)", "Take pictures and record video."))
      addNeedsItem(NeedsItem(drawable_contact, "Contact", "(Optional)", "Access this device's contacts."))
      addNeedsItem(NeedsItem(drawable_sms, "SMS", "(Optional)", "Send and view SMS messages."))
      description = "The above accesses are used to better serve you."
      confirm = "Confirm"
      backgroundAlpha = 0.6f
      lifecycleOwner = lifecycle
      needsTheme = theme
      needsItemTheme = itemTheme
      needsAnimation = NeedsAnimation.CIRCULAR
    }

OnConfirmListener

We can listen to the confirm button is clicked using OnConfirmListener.

needs.setOnConfirmListener(new OnConfirmListener() {
  @Override
  public void onConfirm() {
      // confirmed
  }
});

Show and dismiss

Here is how to show needs popup and dismiss easily.

needs.show(layout); // shows the popup menu to the center. 
needs.dismiss(); // dismiss the popup menu.

TextForm

TextFrom is an attribute class that has some attributes about TextView for customizing popup texts.

TextForm textForm = new TextForm.Builder()
          .setTextColor(R.color.colorPrimary)
          .setTextSize(14)
          .setTextStyle(Typeface.BOLD)
          .build();

builder.setTitleTextForm(titleTextForm);
builder.setDescriptionTextForm(descriptionTextForm);
builder.setConfirmTextForm(confirmTextForm);

Here is how to create TextForm using kotlin dsl.

val titleForm = textForm {
  textSize = 18
  textStyle = Typeface.BOLD
  textColor = ContextCompat.getColor(baseContext, R.color.black)
}

NeedsTheme

NeedsTheme is an attribute class for changing Needs popup theme easily.

NeedsTheme needsTheme = new NeedsTheme.Builder(context)
           .setBackgroundColor(ContextCompat.getColor(context, R.color.background))
           .setTitleTextForm(titleTextForm)
           .setDescriptionTextForm(descriptionTextForm)
           .setConfirmTextForm(confirmTextForm)
           .build();

builder.setNeedsTheme(needsTheme);

Here is how to create NeedsTheme using kotlin dsl.

val theme = needsTheme(baseContext) {
      backgroundColor = ContextCompat.getColor(baseContext, R.color.background)
      titleTextForm = textForm(baseContext) {
        textSize = 18
        textColor = ContextCompat.getColor(baseContext, R.color.white)
      }
      descriptionTextForm = textForm(baseContext) {
        textSize = 12
        textColor = ContextCompat.getColor(baseContext, R.color.description)
      }
    }

NeedsItemTheme

NeedsTheme is an attribute class for changing Needs popup RecyclerView's item theme easily.

NeedsItemTheme needsItemTheme = new NeedsItemTheme.Builder(context)
               .setBackgroundColor(ContextCompat.getColor(context, R.color.background))
               .setTitleTextForm(titleTextForm)
               .setRequireTextForm(requireTextForm)
               .setBulletForm(bulletForm)
               .build();

builder.setNeedsItemTheme(needsItemTheme);

Here is how to create NeedsItemTheme using kotlin dsl.

val itemTheme = needsItemTheme(baseContext) {
      backgroundColor = ContextCompat.getColor(baseContext, R.color.background)
      titleTextForm = textForm(baseContext) {
        textColor = ContextCompat.getColor(baseContext, R.color.colorPrimaryDark)
        textSize = 16
      }
      descriptionTextForm = textForm(baseContext) {
        textColor = ContextCompat.getColor(baseContext, R.color.description)
      }
    }
<img src="https://user-images.githubusercontent.com/24237865/83263157-1cc7b480-a1f9-11ea-8208-f3843b51bb62.png" align="right" width="32%"/>

BulletForm

We can make bullet points in front of every title and they can be fully customized.

BulletForm bulletForm = new BulletForm.Builder(context)
                    .setBulletColorResource(R.color.colorPrimary)
                    .setBulletSize(12)
                    .setBulletPadding(9)
                    .build();

Here is how to create BulletForm using kotlin dsl.

val bulletForm = bulletForm(context) {
      setBulletColorResource(R.color.colorPrimary)
      setBulletSize(12)
}

NeedsAnimation

NeedsAnimation implements showing and dismissing popup with animations.

ELASTICCIRCULAR
elasticcircluar
NONEFADE
nonefade
builder.setNeedsAnimation(NeedsAnimation.FADE)
builder.setNeedsAnimation(NeedsAnimation.NONE)
builder.setNeedsAnimation(NeedsAnimation.ELASTIC)
builder.setNeedsAnimation(NeedsAnimation.CIRCULAR)

Kotlin Extensions

We can show and initialize Needs property more polish using extensions.

showNeeds

Shows the popup menu to the center. <br> It observes the target view's inflating and after inflate finished, it show up on the target view.

targetView.showNeeds(needs)

Lazy initialization

We can initialize the needs property lazily using needs keyword and Needs.Factory abstract class.<br> The needs extension keyword can be used on Activity and Fragment.

class MainActivity : AppCompatActivity() {
  private val myNeeds by needs<DarkNeedsFactory>()
  
  // ..
}

We should create a class which extends Needs.Factory.<br> An implementation class of the factory must have a default(non-argument) constructor.

class DarkNeedsFactory : Needs.Factory() {

  override fun create(context: Context, lifecycle: LifecycleOwner): Needs {
    return Needs.Builder(context)
      .setTitle("Permission instructions \nfor using this Android app.")
      .setDescription("The above accesses are used to better serve you. This application is available even if you do not agree to allow it.")
      .setConfirm("Confirm")
      .setBackgroundAlpha(0.6f)
      .setLifecycleOwner(lifecycle)
      .setNeedsAnimation(NeedsAnimation.FADE)
      .addNeedsItem(NeedsItem(null, "· SD Card", "(Required)", "   Access photos, media, and files on device."))
      .addNeedsItem(NeedsItem(null, "· Location", "(Required)", "   Access this device's location."))
      .addNeedsItem(NeedsItem(null, "· Camera", "(Optional)", "   Take pictures and record video."))
      .addNeedsItem(NeedsItem(null, "· Contact", "(Optional)", "   Access this device's contacts."))
      .addNeedsItem(NeedsItem(null, "· SMS", "(Optional)", "   Send and view SMS messages."))
      .build()
  }
}

Preference

If you want to show-up the Popup only once or a specific number of times, here is how to implement it simply.

.setPreferenceName("MyNeeds") // sets preference name of the Needs.
.setShowTime(3) // show-up three of times the popup. the default value is 1 If the preference name is set.

Avoid Memory leak

Dialog, PopupWindow and etc.. have memory leak issue if not dismissed before activity or fragment are destroyed.<br> But Lifecycles are now integrated with the Support Library since Architecture Components 1.0 Stable released.<br> So we can solve the memory leak issue so easily.<br>

Just use setLifecycleOwner method. Then dismiss method will be called automatically before activity or fragment would be destroyed.

.setLifecycleOwner(lifecycleOwner)

Needs builder methods

.setTitleIcon(@DrawableRes drawable: Drawable)
.setTitle(value: String)
.setTitleTextForm(value: TextForm)
.setDescription(value: String)
.setDescriptionTextForm(value: TextForm)
.setConfirmBackgroundColor(@ColorInt value: Int)
.setConfirm(value: String)
.setConfirmTextForm(value: TextForm)
.setConfirmVisible(value: Boolean)
.setListAdapter(value: RecyclerView.Adapter<*>)
.setListHeight(value: Int)
.setPadding(value: Int)
.addNeedsItem(value: NeedsItem)
.addNeedsItemList(value: List<NeedsItem>)
.setBackground(@DrawableRes value: Drawable)
.setBackgroundColor(@ColorInt value: Int)
.setBackgroundAlpha(value: Float)
.setDividerColor(@ColorInt value: Int)
.setDividerVisible(value: Boolean)
.setDividerHeight(value: Float)
.setOnConfirmListener(value: OnConfirmListener)
.setLifecycleOwner(value: LifecycleOwner)
.setNeedsTheme(value: NeedsTheme)
.setNeedsItemTheme(value: NeedsItemTheme)
.setNeedsAnimation(value: NeedsAnimation)

Find this library useful? :heart:

Support it by joining stargazers for this repository. :star:

License

Copyright 2019 skydoves

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.