Skip to content
This repository has been archived by the owner on Jun 13, 2019. It is now read-only.

Latest commit

 

History

History
118 lines (83 loc) · 4.1 KB

README.md

File metadata and controls

118 lines (83 loc) · 4.1 KB
Raw

UndoBar

Build Status

This lib is deprecated in favor of Google's Design Support Library which includes a Snackbar and is no longer being developed.

Thanks for all your support!

Android Library that implements Snackbars (former known as Undobar) from Google's Material Design documentation.

UndoBar Sample UndoBar Sample UndoBar Sample UndoBar Sample UndoBar Sample

How to use this library

  • Download this library, import to your IDE (eclipse...) as a library project.

  • Using Gradle(from 0.5)

    compile 'com.cocosw:undobar:1.+@aar'

  • Using Maven

    <dependency>
    <groupId>com.cocosw</groupId>
    <artifactId>undobar</artifactId>
    <version>*</version>
    <type>apklib</type>
</dependency>

API

  • You can also use UndoBar with builder style.

    new UndoBar(getActivity()).message("Undo-bar title").listener(listener).show();

  • Or you can use UndoBar by just one line code (Deprecated from 1.4)

    UndoBarController.show(getActivity(), "Undo-bar title" , listener, undoToken);

  • UndoBar support customize style with background/icon/duration/animation attribution.

  • UndoBar will determine if tranlucent mode(4.4) is using and adjust its position.

Style

  • UndoBar provides 3 default styles. You can use them for different purposes like undo,refresh, or just use it as replacement of toasts. For example, you can use retry style in this way.

    new UndoBarController.UndoBar(this).message(loader.getException().getMessage()).style(UndoBarController.RETRYSTYLE).listener(this).show();

  • UndoBar will switch to KitKat L&F in API-19 target and Material design in API20+.

  • You can set theme in your appliation to change the look and feel. For example, you can use following lines in your style.xml to always use material style UndoBar.

    <style name="MaterialTheme" parent="android:Theme.Light">
    <item name="undoBarStyle">@style/UndoBarMaterialStyle</item>
</style>

  • You can change undobar style completely by define your own style

        <style name="UndoBarClassicStyle">
        <item name="containerStyle">@style/UndoBarClassic</item>
        <item name="messageStyle">@style/UndoBarMessageClassic</item>
        <item name="buttonStyle">@style/UndoBarButtonClassic</item>
        <item name="dividerStyle">@style/UndoBarDividerClassic</item>
        <item name="inAnimation">@anim/undobar_classic_in_anim</item>
        <item name="outAnimation">@anim/undobar_classic_out_anim</item>
    </style>

Advanced usage

  • Using UndoBarController.AdvancedUndoListener if you need to get notification when UndoBar was cleared or hidden.
  • UndoBar is designed to dynamically add to activity viewgroup, so you need to handle screen-rotation by your self. Check this example to see more.

Contribute

  • Feel free to fork it

License

Copyright 2011, 2015 Kai Liao

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.