easy-rating-dialog


Source link: https://github.com/fernandodev/easy-rating-dialog

Easy Rating Dialog

This lib provides a simple way to display an alert dialog for rating app.

Default conditions to show:

  1. User opened the app more than 5 times
  2. User opened the app after 7 days of first opening.
  • Please Note: The lastest version uses AppCompat. Your application Theme has to be inherited from Theme.AppCompat

Installation

It's very simple with gradle ;)

Add mavenCentral as repository source:

repositories {

mavenCentral() 
}

And finally add this line inside dependencies { } section:

compile 'com.github.fernandodev.easyratingdialog:easyratingdialog:+'
  • The + symbol indicates to gradle to get the latest version.
  • Current version: 1.1.2

ATTENTION

If you are using afollestad:material-dialogs you must esclude this module from EasyRatingDialog lib to avoid lib conflicting:

  compile('com.github.fernandodev.easyratingdialog:easyratingdialog:1.1.2') {

  exclude module: 'material-dialogs'

}
  • See the sample if there are any doubts.

Using

The main flow usage is:

Create dialog in your main activity or your start activity:

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

easyRatingDialog = new EasyRatingDialog(this);
 
}

after you need to start dialog at:

@Override protected void onStart() {

super.onStart();

easyRatingDialog.onStart();
 
}

this line inc. counters and initialize first app access date if necessary

And to show when needed just call in onResume:

@Override protected void onResume() {

super.onResume();

easyRatingDialog.showIfNeeded();
 
}
  • all exceptions are catched when dialog tries to show because I assume the app running is more important than to show the dialog.

Tips

Condition triggers

If you want to change the default lib behavior you can create a custom Condition Trigger:

EasyRatingDialog.ConditionTrigger conditionTrigger = new EasyRatingDialog.ConditionTrigger() {

@Override
public boolean shouldShow() {

  //Your custom condition here
  return false;

}
 
}
;  easyRatingDialog.setConditionTrigger(conditionTrigger);

Useful public methods

If you need to create for user an action rate and link it with dialog conditions, don't be afraid, just create the easy rating dialog instance and call rate now as below:

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

easyRatingDialog = new EasyRatingDialog(this);
 
}
public void onClickRateNow() {

super.onResume();

easyRatingDialog.rateNow();
 
}

You can do it for neverRemider() and remindMeLater() actions too.

To check stored values just call didNeverReminder(), didRate().

Internationalization

Do you liked the lib but you need to change default strings in en-US, you can do it easily as section below.

Just override default values in your strings.xml:

<resources>
<string name="erd_title">Rate this app</string>
<string name="erd_message">Hi, take a minute to rate this app and help support to improve more new features. ;)</string>
<string name="erd_no_thanks">No, thanks.</string>
<string name="erd_remind_me_later">Remind me later.</string>
<string name="erd_rate_now">Rate now.</string> </resources>

Constants

Do you want to change hit times or days after condition? It's simple!

You need to override default values the lib, for that, just create in res/values folder, or alter, a file named constants.xml.

And override the values:

<?xml version="1.0" encoding="utf-8"?> <resources>
<integer name="erd_launch_times">10</integer>
<integer name="erd_max_days_after">14</integer> </resources>

Theme

You can customize the alert dialog using style settings:

<?xml version="1.0" encoding="utf-8"?> <resources>
  <style name="AppTheme" parent="Theme.AppCompat">

<item name="alertDialogTheme">@style/AlertDialogTheme</item>
  </style>

<!--You can customize dialog theme as below-->

<style name="AlertDialogTheme" parent="Theme.AppCompat.Light.Dialog.Alert">

<item name="buttonBarNegativeButtonStyle">@style/NegativeButtonStyle</item>

<item name="buttonBarPositiveButtonStyle">@style/PositiveButtonStyle</item>
  </style>

<style name="NegativeButtonStyle" parent="Widget.AppCompat.Button.ButtonBar.AlertDialog">

<item name="android:textColor">#f00</item>
  </style>

<style name="PositiveButtonStyle" parent="Widget.AppCompat.Button.ButtonBar.AlertDialog">

<item name="android:textColor">#00f</item>
  </style> </resources>

Dagger Issues

If you are using dagger pay attention to some items.

One, you must provide an Activity Context to EasyRatingDialog to show the dialog. So you can do this as below:

@Provides EasyRatingDialog provideRatingDialog(@ForActivity Context context) {

return new EasyRatingDialog(context);
 
}

where @ForActivity is an interface that overrides other contexts provided by other modules.

@Qualifier @Retention(RUNTIME)
public @interface ForActivity {
 
}

Otherwise if you provide other context and try to show an execption can be occur because dialogs only can be attached to Activity's context.

The code below prevents you to get a BadTokenException exception E/EasyRatingDialog? Unable to add window -- token android.os.BinderProxy@536c3920 is not valid; is your activity running?

@Provides @ForActivity Context provideActivityContext() {

return activity; 
}

If you use `@Singleton annotation to provide the Activity's context a BadTokenException can be occur after restoring from background.

Remember, all exceptions are catched when dialog tries to show because I assume the app running is more important than to show the dialog.

Samples Usage

There are two samples, the first is just a simple acitivity that shows the dialog and the second uses dagger injection.

To run samples you can follow steps below

$ git clone [email protected]:fernandodev/easy-rating-dialog.git $ cd easyratingdialog $ ./gradlew installSampleDebug installSampleWithDaggerDebug --daemon

Testing

There are a simple test for the rating dialog. If you want to contribute check the tests too.

$ git clone [email protected]:fernandodev/easy-rating-dialog.git $ cd easyratingdialog $ ./gradlew assembleSampleDebugTest connectedAndroidTestSampleDebug --daemon

You must open an emulator before.

Showcase

Have you used my library in your project? Tell me and I'll sponsor your app here ;)

Change Logs

See Change Logs file.

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.

Resources

A tiny Android library that makes a very simple horizontal ProgressBar with animation.

Android custom button with centered drawable.

AndroidRPInterpolator is the interpolator library using Rovert Penner's Easing Functions.

Android CheckBox and RadioButton with additional 3rd 'indeterminate' state.

Context free and basic utils to build Android project conveniently.

This library offers some barebone code for android common to most applications. It provides simple classes and pre-written functions for:

  • Internet Access
  • SharedPreferences storage and retrieval
  • ImagePicker and Bitmap operations
  • File read and write
  • Recycler View
  • Image Downloading
  • Database support
  • Json Parsing

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes