What's included 🚀

Preview

Screenshots 🎉

Setup

Latest releases 🛠

Provide the gradle dependency

implementation"com.mikepenz:fastadapter:${latestFastAdapterRelease}"implementation"androidx.appcompat:appcompat:${androidX}"implementation"androidx.recyclerview:recyclerview:${androidX}"

implementation"com.mikepenz:fastadapter-extensions-expandable:${latestFastAdapterRelease}"

implementation"com.mikepenz:fastadapter-extensions-binding:${latestFastAdapterRelease}"// view binding helpersimplementation"com.mikepenz:fastadapter-extensions-diff:${latestFastAdapterRelease}"// diff util helpersimplementation"com.mikepenz:fastadapter-extensions-drag:${latestFastAdapterRelease}"// drag supportimplementation"com.mikepenz:fastadapter-extensions-paged:${latestFastAdapterRelease}"// paging supportimplementation"com.mikepenz:fastadapter-extensions-scroll:${latestFastAdapterRelease}"// scroll helpersimplementation"com.mikepenz:fastadapter-extensions-swipe:${latestFastAdapterRelease}"// swipe supportimplementation"com.mikepenz:fastadapter-extensions-ui:${latestFastAdapterRelease}"// pre-defined ui componentsimplementation"com.mikepenz:fastadapter-extensions-utils:${latestFastAdapterRelease}"// needs the `expandable`, `drag` and `scroll` extension.// required for the ui components and the utilsimplementation"com.google.android.material:material:${androidX}"

How to use

1. Implement your item

1a. Implement your item as usual (the easy way)

openclassSimpleItem :AbstractItem<SimpleItem.ViewHolder>() {var name:String?=nullvar description:String?=null/** defines the type defining this item. must be unique. preferably an id*/overrideval type:Int        get()=R.id.fastadapter_sample_item_id/** defines the layout which will be used for this item in the list*/overrideval layoutRes:Int        get()=R.layout.sample_itemoverridefungetViewHolder(v:View):ViewHolder {returnViewHolder(v)    }classViewHolder(view:View) : FastAdapter.ViewHolder<SimpleItem>(view) {var name:TextView= view.findViewById(R.id.material_drawer_name)var description:TextView= view.findViewById(R.id.material_drawer_description)overridefunbindView(item:SimpleItem,payloads:List<Any>) {            name.text= item.name            description.text= item.name        }overridefununbindView(item:SimpleItem) {            name.text=null            description.text=null        }    }}

1b. Implement item with ViewBinding (the easiest way)

classBindingIconItem :AbstractBindingItem<IconItemBinding>() {var name:String?=nulloverrideval type:Int        get()=R.id.fastadapter_icon_item_idoverridefunbindView(binding:IconItemBinding,payloads:List<Any>) {        binding.name.text= name    }overridefuncreateBinding(inflater:LayoutInflater,parent:ViewGroup?):IconItemBinding {returnIconItemBinding.inflate(inflater, parent,false)    }}

2. Set the Adapter to the RecyclerView

//create the ItemAdapter holding your Itemsval itemAdapter=ItemAdapter<SimpleItem>()//create the managing FastAdapter, by passing in the itemAdapterval fastAdapter=FastAdapter.with(itemAdapter)//set our adapters to the RecyclerViewrecyclerView.setAdapter(fastAdapter)//set the items to your ItemAdapteritemAdapter.add(ITEMS)

3. Extensions

3.1. SelectExtension

// Gets (or creates and attaches if not yet existing) the extension from the given `FastAdapter`val selectExtension= fastAdapter.getSelectExtension()// configure as neededselectExtension.isSelectable=trueselectExtension.multiSelect=trueselectExtension.selectOnLongClick=false// see the API of this class for more options.

3.2. ExpandableExtension

// Gets (or creates and attaches if not yet existing) the extension.val expandableExtension= fastAdapter.getExpandableExtension()// configure as neededexpandableExtension.isOnlyOneExpandedItem=true

3. Click listener

fastAdapter.onClickListener= { view, adapter, item, position->// Handle click herefalse}

4. Click listeners for views inside your item

// just add an `EventHook` to your `FastAdapter` by implementing either a `ClickEventHook`, `LongClickEventHook`, `TouchEventHook`, `CustomEventHook`fastAdapter.addEventHook(object:ClickEventHook<SimpleImageItem>() {overridefunonBind(viewHolder:RecyclerView.ViewHolder):View? {//return the views on which you want to bind this eventreturnif (viewHolderisSimpleImageItem.ViewHolder) {            viewHolder.viewWhichReactsOnClick        }else {null}    }overridefunonClick(v:View,position:Int,fastAdapter:FastAdapter<SimpleImageItem>,item:SimpleImageItem) {//react on the click event    }})

5. Filter

// Call this in onQueryTextSubmit() & onQueryTextChange() when using SearchViewitemAdapter.filter("yourSearchTerm")itemAdapter.itemFilter.filterPredicate= { item:SimpleItem, constraint:CharSequence?->    item.name?.text.toString().contains(constraint.toString(), ignoreCase=true)}

6. Drag and drop

val dragCallback=SimpleDragCallback()val touchHelper=ItemTouchHelper(dragCallback)touchHelper.attachToRecyclerView(recyclerView)

overridefunitemTouchOnMove(oldPosition:Int,newPosition:Int):Boolean {DragDropUtil.onMove(fastItemAdapter.itemAdapter, oldPosition, newPosition)// change positionreturntrue}

7. Using different ViewHolders (like HeaderView)

// Header is a model class for your headerval headerAdapter=ItemAdapter<Header>()

val itemAdapter=GenericItemAdapter()

val fastAdapter:GenericFastAdapter=FastAdapter.with(headerAdapter, itemAdapter)//the order defines in which order the items will show up// alternative the super type of both item adapters can be used. e.g.:recyclerView.setAdapter(fastAdapter)

8. Infinite (endless) scrolling

val footerAdapter=ItemAdapter<ProgressItem>()

recyclerView.addOnScrollListener(object:EndlessRecyclerOnScrollListener(footerAdapter) {overridefunonLoadMore(currentPage:Int) {         footerAdapter.clear()         footerAdapter.add(ProgressItem())// Load your items here and add it to FastAdapter         itemAdapter.add(NEWITEMS)    }})

Advanced Usage

Proguard

ExpandableItems

val expandableExtension= fastAdapter.getExpandableExtension()

openclassSimpleSubExpandableItem :AbstractExpandableItem<SimpleSubExpandableItem.ViewHolder>() {/**     * BASIC ITEM IMPLEMENTATION*/}

Articles

Used by

Developed By

Contributors

Special mentions

License

Copyright 2021 Mike PenzLicensed 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.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.