Fogger - a library to create blurred background under Android's UI elements
Java
Latest commit d9ce565 Nov 8, 2015 @pawelByszewski pawelByszewski Merge pull request #6 from allegro/feature/downgrade_minsdk
downgrade min sdk version to 14

README.md

Fogger

Build Status

Lib to create blurred background under:

  • dialogs
  • drawer
  • context menu

Features

You can blur view behind drawer, dialog window and context menu.

Fogger Demo on Google Play

example

How to get it

Grab via Maven:

<dependency>
  <groupId>pl.allegro.android</groupId>
  <artifactId>fogger</artifactId>
  <version>0.9.0</version>
  <type>aar</type>
</dependency>

or Gradle:

compile 'pl.allegro.android:fogger:0.9.0'

Motivation

All over the internet there are pieces of code that show how to make blur effect on Android. But there is not any library that helps you to blur background under all mostly used UI items. I want to make it as easy to use as possible so you do not have to change architecture of you app.

Examples

Drawer

To make drawer with fluent, blurred you have to provide only two changes to standard Android drawer. At the first the root view must be pl.allegro.fogger.ui.drawer.DrawerLayoutWithBlurredBackground instead of DrawerLayout

The second modification is to add tag value

 android:tag="fragmentPlaceholder"

to main content layout. You could also use string resource id provided with aar

  android:tag="@string/view_with_drawer_tag"

The full example:

   <?xml version="1.0" encoding="utf-8"?>

   <pl.allegro.fogger.ui.drawer.DrawerLayoutWithBlurredBackground
           xmlns:android="http://schemas.android.com/apk/res/android"
           android:id="@+id/drawer_layout"
           android:layout_width="match_parent"
           android:layout_height="match_parent">

       <FrameLayout
           android:id="@+id/fragmentPlaceholder"
           android:layout_width="match_parent"
           android:layout_height="match_parent"
           android:tag="@string/view_with_drawer_tag"/>

       <FrameLayout
               android:id="@+id/drawer_container"
               android:tag="@string/drawer_content_view_tag"
               android:layout_width="240dp"
               android:layout_height="match_parent"
               android:layout_gravity="start">
               <include layout="@layout/settings"/>
       </FrameLayout>

   </pl.allegro.fogger.ui.drawer.DrawerLayoutWithBlurredBackground>

Working example of drawer with dynamically blurred background you could find in the example app

Dialog

Showing dialog with blurred background is as simply as showing traditional Dialog window. All you have to do is use special dialog launcher.

public class MyActivity extends Activity {

 ...

     public void showDialog() {
         DialogWithBlurredBackgroundLauncher dialogWithBlurredBackgroundLauncher
                     = new SimpleDialogWithBlurredBackgroundLauncher(this);
             Dialog dialog = new Dialog(this);
             dialog.setTitle(R.string.example_dialog_title);
             dialogWithBlurredBackgroundLauncher.showDialog(dialog);
     }
 }

As you can see, it is just one more line of code compare to dialog window with standard background.

Working example of dialog window with blurred background you could find in the example app

Context Menu

To create context window with blurred background you must prepare Activity that extends

public abstract class ActivityWithContextMenu extends Activity {

then you must implements one required abstract method

    protected abstract int getContextMenuResId(View view);

The method must provide resource id form context menu to show eg.

    @Override
    protected int getContextMenuResId(View view) {
        return R.menu.context_menu;
    }

The rest of context menu flow is unchanged, so you have to register context menu on some View and listen click event with Androids method

public boolean onContextItemSelected(MenuItem item) {

Road Map

  • Substitute SafeAsyncTask (from Roboguice) with RxJava

If you have any idea please let me know.

License

Copyright 2014 original author or authors

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.