Skip to content

Commit

Permalink
Updated doc for 1.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielemariotti committed Jun 10, 2014
1 parent b8a2a6e commit a4d65c4
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 10 deletions.
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Change Log
Version 1.7.0 *(2014-XX-XX)*
----------------------------

* LIB: Added a new feature to display a list of items inside a Card [(doc)](/doc/CARDWITHLIST.md)
* LIB: Added a feature to customize dynamically the undoBar message [(doc)](/doc/CARDLIST.md#swipe-and-undo-with-a-custom-undobar)

It contains a **BREAKING CHANGE** with UndoBar and UndoBarUIElements feature. Read the above link to migrate your code.
* LIB-EXTRA: Updated Etsy-Grid dependency to 1.0.5
* DEMO-Extras: Improved staggered grid examples.
* DEMO-Extras: updated all libraries.
* DEMO: Added a new example for Card with List
* DEMO-Extra: Added a new example for Card with List integrated with WeatherLib
* DEMO-Extra: Improved staggered grid examples.
* DEMO-Extra: updated all libraries.


Version 1.6.0 *(2014-05-06)*
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The Guide provides a extensive doc, with all tips and full examples. Don't miss
Card Library is pushed to Maven Central as an AAR, so you just need to add the following dependency to your `build.gradle`.

dependencies {
compile 'com.github.gabrielemariotti.cards:library:1.6.0'
compile 'com.github.gabrielemariotti.cards:library:1.7.0'
}


Expand All @@ -69,6 +69,7 @@ Acknowledgements
* Thanks to [Niek Haarman][4] for some ideas and code taken from his [ListViewAnimations][5].
* Thanks to [Chris Banes][6] for [ForegroundLinearLayout][7] class (See this [post][8] for more info).
* Thanks to [Taylor Ling][9] for drag and drop icon.
* Thanks to [Frankie Sardo][10] for some ideas and code taken from his [LinearListView][11]


Credits
Expand Down Expand Up @@ -120,4 +121,6 @@ Google and the Google Maps logo are registered trademarks of Google Inc., used w
[6]: https://plus.google.com/+ChrisBanes
[7]: https://gist.github.com/chrisbanes/9091754
[8]: https://plus.google.com/+AndroidDevelopers/posts/aHPVDtr6mcp
[9]: https://plus.google.com/+TaylorLing
[9]: https://plus.google.com/+TaylorLing
[10]: https://plus.google.com/+FrankieSardo
[11]: https://github.com/frankiesardo/LinearListViews
4 changes: 4 additions & 0 deletions demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ There are two sample applications:
6. [Crouton][12]
7. [StickyListHeaders][14]
8. [AndroidStaggeredGrid][16]
9. [WeatherLib][21]

[(See this page for more info about integration)](/doc/OTHERLIBRARIES.md)

Expand Down Expand Up @@ -42,6 +43,7 @@ Extras demo uses these open source libraries:
* [Crouton][12] by [Benjamin Weiss][13]
* [StickyListHeaders][14] by [Emil Sjölander][15]
* [AndroidStaggeredGrid][16] by [Etsy][17]
* [WeatherLib][21] by [Francesco Azzola][22]

* Thanks to [JakeWharton][18] for some ideas and code taken from his [u2020][19].
* Thanks to [Taylor Ling][20] for drag and drop icon.
Expand Down Expand Up @@ -105,4 +107,6 @@ License
[18]: http://jakewharton.com/
[19]: https://github.com/JakeWharton/u2020
[20]: https://plus.google.com/+TaylorLing
[21]: https://github.com/survivingwithandroid/WeatherLib
[22]: https://plus.google.com/+FrancescoAzzola

8 changes: 5 additions & 3 deletions doc/BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Card Library is pushed to Maven Central as a AAR, so you just need to add the fo

dependencies {
//Core card library
compile 'com.github.gabrielemariotti.cards:library:1.6.0'
compile 'com.github.gabrielemariotti.cards:library:1.7.0'

//Extra card library, it is required only if you want to use integrations with other libraries
compile 'com.github.gabrielemariotti.cards:library-extra:1.6.0'
compile 'com.github.gabrielemariotti.cards:library-extra:1.7.0'
}

The library-extra is optional. It contains code to use integrations with other libraries, as StaggeredGridView and CardListDragDropView.
Expand Down Expand Up @@ -114,6 +114,7 @@ If you would like to use this **library** in Eclipse you have to do these steps:
- mark java(*) folder as source (click on folder -> Build-Path -> use as source folder). You can also remove the src folder, from the project.
- mark cardslib as Android Library (Properties -> Android -> Is library)
- The library targets SDK 19 and works with minSdk=14. In any cases you need to use API>=16 to compile library (Properties -> Android)
- Clean and build

If you would like to use this **library-extra** in Eclipse you have to do these steps:
(this part is optional,it contains code to use integrations with other libraries, as StaggeredGridView and CardListDragDropView)
Expand All @@ -125,7 +126,7 @@ If you would like to use this **library-extra** in Eclipse you have to do these
- add [Etsy-StaggeredGrid](https://github.com/etsy/AndroidStaggeredGrid) as dependency ( click -> Properties -> Android -> Add library) as dependency. Check the AndroidStaggeredGrid-library readme for instruction.
- add [ListViewAnimation](https://github.com/nhaarman/ListViewAnimations) as dependency ( click -> Properties -> Android -> Add library) as dependency. Check the ListViewAnimations-library readme for instruction.
- The library targets SDK 19 and works with minSdk=14. In any cases you need to use API>=16 to compile library (Properties -> Android)

- Clean and build

If you would like to build the **demo-stock** you have to do these additional steps:

Expand All @@ -135,6 +136,7 @@ If you would like to build the **demo-stock** you have to do these additional st
- add support library v4 rel.19 ( click -> Android Tools -> Add support library , or just copy android-support-v4.jar in libs folder)
- add cardslib as dependency ( click -> Properties -> Android -> Add library)
- The demo-stock targets SDK 19 and works with minSdk=14. In any cases you need to use API>=16 to compile it
- Clean and build


(*) Eclipse uses src and res as source folders.
Expand Down
22 changes: 21 additions & 1 deletion doc/CARDWITHLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,14 +160,33 @@ In particular you can :
```java
item.setOnItemSwipeListener(new OnItemSwipeListener() {
@Override
public void onItemSwipe(ListObject object) {
public void onItemSwipe(ListObject object,boolean dismissRight) {
Toast.makeText(getContext(), "Swipe on " + object.getObjectId(), Toast.LENGTH_SHORT).show();
}
});
```

![Screen](/demo/images/card/cwl_swipeitem.png)

You can customize the background behind the items cloning this color in your project:

``` xml
<!-- Used by card with list -->
<color name="card_base_cardwithlist_background_list_color">#10000000</color>
```

Otherwise you can customize this style in your project:

``` xml
<!-- Style for card with list -->
<style name="cardwithlist">
<item name="android:background">@color/card_base_cardwithlist_background_list_color</item>
</style>
```

and finally you can provide your [custom inner layout](#using-a-custom-inner-layout)


## Define the layout used by items

You have to specify the layout used by each item.
Expand Down Expand Up @@ -229,6 +248,7 @@ Finally you can clone this style in your project:
<item name="android:showDividers">middle</item>
<item name="android:layout_width">match_parent</item>
<item name="android:layout_height">match_parent</item>
<item name="android:background">@color/card_base_cardwithlist_background_list_color</item>
</style>
```

Expand Down
1 change: 1 addition & 0 deletions doc/CUSTOMIZATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ Here you can find some pages to customize these tags.
* [CardGrid:](CARDGRID.md) How to work with the `CardGridView`
* [StaggeredGrid:](STAGGEREDGRID.md) How to work with the `CardGridStaggeredView`
* [CardList with Drag and Drop:](DRAGDROPLIST.md) How to work with the `CardListDragDropView`
* [Card with a List inside](CARDWITHLIST.md) How to build a card with a List Inside.
* [Integration with other libraries:](OTHERLIBRARIES.md) How to work with other main libraries
4 changes: 2 additions & 2 deletions doc/GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Card Library is pushed to Maven Central as an AAR, so you just need to add the f

dependencies {
//Core card library
compile 'com.github.gabrielemariotti.cards:library:1.6.0'
compile 'com.github.gabrielemariotti.cards:library:1.7.0'

//Extra card library, it is required only if you want to use integrations with other libraries
compile 'com.github.gabrielemariotti.cards:library-extra:1.6.0'
compile 'com.github.gabrielemariotti.cards:library-extra:1.7.0'
}

The library-extra is optional. It contains code to use integrations with other libraries, as StaggeredGridView and CardListDragDropView.
Expand Down

0 comments on commit a4d65c4

Please sign in to comment.