### Upgrade Notes #### v5.x.y v5 brings some general API cleanup which should make the usage easier. Removed generic type to simplify code. - Usages of the `FastAdapter.with()` method have been simplified ```kotlin // old FastAdapter.with>(itemAdapter) // v5 FastAdapter.with(itemAdapter) ``` - Correct API specification for the bind method. (The payload for bindView should be immutable) ```kotlin // old override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int, payloads: MutableList) // v5 override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int, payloads: List) ``` #### v4.x.y v4 is a huge release changing most of the codebase to Kotlin. This comes with many refactorings, and as a result of that with many breaking API changes. We put a lot of focus on type safety with this release, as such this release is a lot more strict and tries to prevent as many potential bad type mix-ups as possible. * For compatibility, most existing static fields and functions remain static in Java. For newer functions, accessing from Java may require using the `Companion` class. For instance, `FastAdapter.example()` becomes `FastAdapter.Companion.example()` * The `IItem` interface now requires a type specification. E.g. `IItem` * The `SelectExtension` is no longer default enabled and wrapped in the `FastAdapter` use its API standalone. E.g.: `selectExtension.setSelectable(true)`, ... * Extensions can be retrieved via `getOrCreateExtension`. `SelectExtension selectExtension = (SelectExtension) mFastAdapter.getOrCreateExtension(SelectExtension.class)` * Most API methods which were possible to be chained in the previous releases are now standard properties. So use `set` / `get`. E.g.: `sampleItem.setSelectable(false)`, `sampleItem.setIdentifier(1)`, ... * `FastAdapterDiffUtil` no longer directly takes the `FastItemAdapter`, provide the `ItemAdapter` or `ModelAdapter` instead. * The `IItem` interface now only requires the `ViewHolder` type. * The `IExpandable` interface was changed and now extends `IParentItem` and `ISubItem`. * The `ISubItem` interface now only requires the `ViewHolder` type. * The `IParentItem` interface only requires the `ViewHolder` type. * `IIdentifyable` interface does not require any type anymore. The v4 release brings a new more modular setup. Allowing to be a lot more precise on what to take from the `FastAdapter`. Due to the new modules some packages of various classes might have changes. Check out here on GitHub for the new location of classes. The new modules are: - com.mikepenz:fastadapter-extensions-diff // diff util helpers - com.mikepenz:fastadapter-extensions-drag // drag support - com.mikepenz:fastadapter-extensions-scroll // scroll helpers - com.mikepenz:fastadapter-extensions-swipe // swipe support - com.mikepenz:fastadapter-extensions-ui // pre-defined ui components - com.mikepenz:fastadapter-extensions-utils // needs the `expandable`, `drag` and `scroll` extension. If you have any issues during the migration, or any questions come up please open a github issue so we can improve the migration guide or the documentation. #### v3.3.x * Upgraded the library to use `androidX` dependencies. This means your project will need to depend on `androidX` dependencies too. If you still use appcompat please consider using a version older than v3.3.x. * Further details about migrating to androidX and a overview can be found on the official docs. https://developer.android.com/topic/libraries/support-library/refactor #### v3.2.4 * Adjusted the `set(int position, Item item, int preItemCount)` to include the `preItemCount` to correctly notify the adapter about the changed element. #### v3.2.3 * The `ActionModeHelper` requires a `FastAdapter` with the `SelectExtension` applied. This is done in current versions via `withSelectable(true)`. Make sure this is called before creating the `ActionModeHelper`. #### v3.2.1 * `AdapterPredicate` was adjusted to include the `IAdapter lastParentAdapter`, `int lastParentPosition` to allow more advanced recursive operations on the items * removed `select(Item item, int position, boolean fireEvent, boolean considerSelectableFlag)` and replaced with `select(IAdapter adapter, Item item, int position, boolean fireEvent, boolean considerSelectableFlag)` * this was done to make the `Adapter` `NonNull` #### v3.0.5 * The `ItemFilter`s `itemsFiltered` callback method will no longer be called after `onReset` (FIX bug making it impossible to detect when filtering was done) #### v3.0.3 * Remove the `R.id.fastadapter_item` Tag from the `ViewHolder` in favour of `FastAdapter.getHolderAdapterItem()` as this will make sure we always get the newest reference to our item #### v3.0.0 v3 is a major new release of the `FastAdapter` library and comes with a big refactor. In most cases the upgrade should be still really straight-forward. A core part of the v3 refactor was to eliminate the `GenericItemAdapter`. It's functionality is now bundled inside the `ModelAdapter` and should be seen, as the default adapter. * `itemAdapter.wrap(...)` was removed in favor of `FastAdapter.with(IItemAdapter, ...)` * `GenericItemAdapter` -> `ModelAdapter` * `GenericAbstractItem` -> `ModelAbstractItem` * all `setModel`-methods of the `ModelAdapter` do not longer exist -> use the normal `set`-methods instead (The ModelAdapter will just keep the item list (not the original model list)) * `ItemAdapter extends ModelAdapter`: as mentioned above the `ModelAdapter` is now the default and the base * The `ModelAdapter` and `ItemAdapter` no longer extend `RecyclerView.Adapter` and are really lightweight now. * The `FooterAdapter` and `HeaderAdapter` were removed. Simply use multiple `ItemAdapter` (the order in which they are passed to the `FastAdapter` defines at which position their items show up) * The initial page of the `EndlessRecyclerOnScrollListener` is now starting also with `0` (like the `EndlessRecyclerOnTopScrollListener`) * The logic of the `Predicate.filter` method was reversed to follow the API of RxJava http://reactivex.io/documentation/operators/filter.html (`true` means the item stays, `false` it will be removed) * by default the `FastAdapter` no longer contains expandable functionality, please add the `expandable` module (as described) in the readme ```java expandableExtension = new ExpandableExtension<>(); fastAdapter.addExtension(expandableExtension); ``` * moved all previous internal `FastAdapter.*Listener` to their own interfaces **SOMETHING MISSING?** Please open a issue and let me know. Or open a PR and add missing migration notes #### v2.6.0 * the `ItemFilter` was moved to it's own class * the `ItemFilterListener` was moved to it's own class * in addition the interface was adjusted to provide more flexibility ```java public interface ItemFilterListener { void itemsFiltered(@Nullable CharSequence constraint, @Nullable List results); void onReset(); } ``` * the `withFilterPredicate` and `withItemFilterListener` are no longer available on the `ItemAdapter`. Use `getItemFilter()` on the adapter to get the `ItemFilter` and call the methods on this one * we no longer allow any filter extending `Filter`, you have to extend `ItemFilter` now to provide your custom implementation * `ItemFilter`, and `ItemFilterListener` and all related methods are now typed. * the `Item` itself is no longer set via the general `Tag` on the `viewHolder.itemView`, but instead you can now retrieve it via: ```java (IItem) viewHolder.itemView.getTag(R.id.fastadapter_item) ``` * in addition the `itemView` now gets a tag set which has the reference to the current `FastAdapter`, this is necessary for the `ClickListenerHelper` to correctly retrieve the item, even if we have a shared `RecyclerViewPool` * the `FastAdapter` now directly handles setting the `Tag` with the `Item` and with the `FastAdapter` references. This is no longer necessary inside the `AbstractItem`, or any custom implementation * the method `onEvent` inside the `CustomEventHook` was renamed to `attachEvent` as it seems a bit more meaningful * the `attachEvent` no longer passes the `FastAdapter` in, please use the provided method `getFastAdapter()` && `getItem()` to get the proper element in your event from the `ViewHolder` * the `ClickListenerHelper` was renamed to `EventHookUtil` and moved to the utils package. It is now a util as it no longer needs an instance and has just 3 public static methods. * `withItemEvent` is now deprecated in favor of the new naming `withEventHook` #### v2.5.3 * the `ItemTouchCallback` has a new method `itemTouchDropped` just implement it and keep it empty, if you do not need it. * If you implemented your own `Item` using the `IItem` interface instead the `AbstractItem` you will now also have to implement * `failedToRecycle` * removed the `RecyclerViewCacheUtil` as it would no longer work with the latest RecyclerView #### v2.5.0 **WARNING** * If you use the MaterialDrawer or the AboutLibraries you will need a compatible release of those for it to work * The FACTORY within the items is no longer required and replaced by a much simpler approach. Remove the old FACTORY and it's methods, and implement the `getViewHolder` method ``` @Override public ViewHolder getViewHolder(View v) { return new ViewHolder(v); } ``` * If you implemented your own `Item` using the `IItem` interface instead the `AbstractItem` you will now also have to implement * `attachToWindow` and * `detachFromWindow` * The reflection based `GenericItemAdapter` CTOR (with the 2 classes as overload) was removed. Please use the CTOR using a `Function` #### v2.1.0 * This release brings minor changes to the `IItem` interface. Please update MaterialDrawer and AboutLibraries too if you use them. * Starting with this version there is now the `core` and the `commons` dependency. Which make the `FastAdapter` even slimmer if you want to use the basics. **QUICK UPGRADE** * The ` List payloads` param in the `onBindViewHolder` method was changed to `List