BRV RecyclerView Framework

Net is a third-party network request framework designed to work seamlessly with BRV to provide automated features, including:

• Automatic Pull-to-Refresh: Automates the refresh logic.
• Automatic Pagination: Automates loading more data as the user scrolls.
• Automatic Empty/Error States: Automatically handles the display of default/empty pages.

To add horizontal dividers, create a drawable resource to define the divider's appearance (specifically its height) and use the linear().divider() method.

Warning: The divider implementation uses addItemDecoration. Calling the divider setup multiple times will stack multiple dividers.

<!-- Example drawable: divider_horizontal.xml -->
<shape xmlns:android="http://schemas.android.com/apk/res/android">
    <solid android:color="@color/dividerDecoration" />
    <size android:height="5dp" />
</shape>

rv.linear().divider(R.drawable.divider_horizontal).setup {
    addType<DividerModel>(R.layout.item_divider)
}.models = getData()

For a simpler syntax where one specific ID maps to one specific callback, you can call the listener methods directly on the ID within the setup block.

rv.linear().setup {
    addType<SimpleModel>(R.layout.item_simple)

    R.id.tv_simple.onClick {
        toast("点击Text")
    }
    R.id.item.onLongClick {
        toast("点击Item")
    }
}.models = getData()

To prevent conflicts between list scrolling and drag-and-drop gestures, it is recommended to trigger the drag via a specific view (like a button) within the item. Use itemTouchHelper?.startDrag(this) inside an OnTouchListener when the MotionEvent.ACTION_DOWN event occurs.

rv.linear().setup {
    addType<DragModel>(R.layout.item_drag)
    onCreate {
        findView<View>(R.id.btnDrag).setOnTouchListener { _, event ->
            if (event.action == MotionEvent.ACTION_DOWN) { // Start dragging when finger is pressed
                itemTouchHelper?.startDrag(this)
            }
            true
        }
    }
}.models = getData()

Since PageRefreshLayout extends SmartRefreshLayout, you should initialize the default refresh header and footer creators in your Application class to ensure consistent behavior across the app.

SmartRefreshLayout.setDefaultRefreshHeaderCreator { context, layout -> MaterialHeader(this) }
SmartRefreshLayout.setDefaultRefreshFooterCreator { context, layout -> ClassicsFooter(this) }

To wrap the list items with dividers on all four sides, the recommended approach is to use a GridLayoutManager with a spanCount of 1 and set the orientation to DividerOrientation.GRID with includeVisible = true.

rv.grid().divider {
    setDrawable(R.drawable.divider_horizontal)
    orientation = DividerOrientation.GRID
    includeVisible = true
}.setup {
    addType<DividerModel>(R.layout.item_divider_vertical)
}.models = getData()

To quickly build a RecyclerView list, use the setup method on a layout manager (e.g., linear()) and register your data models with their corresponding layout resources using addType<T>(layoutId). Finally, assign your data to the models property.

rv.linear().setup {
    addType<SimpleModel>(R.layout.item_simple)
}.models = getData()

To use BRV in your Android project, you must first add the JitPack repository to your settings.gradle file, and then add the BRV dependency to your module's build.gradle file.

// settings.gradle
dependencyResolutionManagement {
    repositories {
        // ...
        maven { url 'https://jitpack.io' }
    }
}

// build.gradle (Module level)
dependencies {
    implementation 'com.github.liangjingkanji:BRV:1.6.1'
}

There are two primary ways to refresh a specific item's data:

1. Manual Notification: Use the notifyXX() methods on the bindingAdapter (e.g., notifyItemChanged(position)).
2. DataBinding: If using DataBinding with two-way binding, changes to the data object will automatically update the view without manual index management. This is the most efficient method as it minimizes the update scope.

To map different data models to different item layouts (Many-to-Many), call addType<T>(layoutId) multiple times within the setup block. Each unique class type T will be associated with its specific layout.

rv.linear().setup {
    addType<Model>(R.layout.item_1)
    addType<Store>(R.layout.item_2)
}.models = data