rubensousa / dpadrecyclerview Goto Github PK

View Code? Open in Web Editor NEW

106.0 4.0 15.0 8.68 MB

A RecyclerView built for Android TV with Compose in mind and as a replacement for Leanback's BaseGridView.

Home Page: https://rubensousa.github.io/DpadRecyclerView/

License: Apache License 2.0

Kotlin 99.72% Shell 0.28%

android android-tv leanback recyclerview

dpadrecyclerview's Introduction

DpadRecyclerView

A RecyclerView built for Android TV as a replacement for Leanback's BaseGridView.

See the project website for more information: https://rubensousa.github.io/DpadRecyclerView

Why should you use this library?

Leanback hasn't received any significant update for years
Compose support for TV is still in its early stages
RecyclerView is stable and works well with Compose
You need to maintain an existing TV app and wish to introduce Compose in an incremental way
Contains useful Espresso testing helpers for your TV UI tests
More feature complete:

Feature	DpadRecyclerView	Leanback	Compose TV
Custom scrolling speeds	✅	✅	❌
Edge alignment preference	✅	✅	❌
Sub position selections	✅	✅	❌
Fading edges	✅	✅	❌
Alignment listener	✅	✅	❌
Grids with uneven span sizes	✅	❌	✅
Extra layout space	✅	❌	✅
Prefetching upcoming items	✅	❌	✅
Reverse layout	✅	❌	✅
Testing library	✅	❌	✅
Scrollbars	✅	❌	❌
Drag and Drop	✅	❌	❌
Infinite layout with loop	✅	❌	❌
Smooth alignment changes	✅	❌	❌
Child focus observer	✅	❌	❌
Circular and continuous focus	✅	❌	❌
Throttling scroll events	✅	❌	❌
Scrolling without animation	✅	❌	❌
Scrolling in secondary directory	❌	✅	❌

Background story for this library is available in my blog in case you're interested.

Check the sample app for a complete example of integration of this library

Getting started

Add the following dependency to your app's build.gradle:

implementation "com.rubensousa.dpadrecyclerview:dpadrecyclerview:$latestVersion"

// Recommended: To use Compose together with DpadRecyclerView
implementation "com.rubensousa.dpadrecyclerview:dpadrecyclerview-compose:$latestVersion"

// Optional: Espresso test helpers for your instrumented tests:
androidTestImplementation "com.rubensousa.dpadrecyclerview:dpadrecyclerview-testing:$latestVersion"

Check the official website for more information and recipes: https://rubensousa.github.io/DpadRecyclerView

Easier Compose Integration

Documentation: https://rubensousa.github.io/DpadRecyclerView/compose/

class ComposeItemAdapter(
    private val onItemClick: (Int) -> Unit
) : ListAdapter<Int, DpadComposeFocusViewHolder<Int>>(Item.DIFF_CALLBACK) {

    override fun onCreateViewHolder(
        parent: ViewGroup,
        viewType: Int
    ): DpadComposeFocusViewHolder<Int> {
        return DpadComposeFocusViewHolder(parent) { item ->
            ItemComposable(
                item = item,
                onClick = {
                    onItemClick(item)
                }
            )
        }
    }

    override fun onBindViewHolder(
        holder: DpadComposeFocusViewHolder<Int>, 
        position: Int
    ) {
        holder.setItemState(getItem(position))
    }
    
}

Sample app

Nested lists:

focus_overlay.webm

Grid with different span sizes:

License

Copyright 2024 Rúben Sousa

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.

dpadrecyclerview's People

Contributors

Stargazers

Watchers

Forkers

advado rahulranjan-tpl ilhamshih nicky-li jamariya harsimarnst newtoncesarroncari giovanninibarbosa ryggs mohamedriadhzrig flyfire akshayxunison lxiin quanbeta fankloano

dpadrecyclerview's Issues

Add support for scrollbars

See: https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView#computeVerticalScrollRange()

Add support for infinite items

Expected behavior:

RecyclerView allows infinite scrolling in the end direction if MAX loop is configured
RecyclerView allows infinite scrolling in both directions if MIN_MAP loop is configured

Looping is only supported if there's enough items in the viewport

Add setLayoutEnabled

Add more UI tests for grid layout

Add Compose interop sample

Add alignment recipes to docs

https://rubensousa.github.io/DpadRecyclerView/recipes/alignment/

Add support for recycling children on detach

Can support both remote control and touchscreen?

I have a device that supports both remote control and touchscreen

but onTouchEvent return false and can not be override

    final override fun onTouchEvent(e: MotionEvent?): Boolean {
        return false
    }

Add support for custom view alignment insets

Instead of treating a view's left, top, right, bottom as the source of truth, we might want to align to a different coordinate

Add compose helper module

Fix accessibility scroll actions

Add state saving/restoring helper

Useful to persist scrolling positions of nested lists
Gives parity to the already existing leanback API that this library does not have

Allow disabling max pending moves

Add support for findFirstVisibleItemPosition and findLastVisibleItemPosition

Add support for fading edges

See: https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:leanback/leanback-grid/src/main/java/androidx/leanback/widget/HorizontalGridView.java;l=322?q=HorizontalGridView

Add setScrollEnabled

Fix alignment issue when first item has start decoration

Compose focus is triggering a new layout pass during scroll changes sometimes

Add Layout recipes to docs

https://rubensousa.github.io/DpadRecyclerView/recipes/layout/

Add simple item decorations for spacing

Pending alignments in opposite direction aren't ignored

Alignment is not restored correctly for small lists

Before:

After coming back to the screen:

Investigate alignment configuration with paddings set

Add support for disabling focus changes during RecyclerView animations

Fast scrolling a Compose grid sometimes changes the span focus

Allow overriding alignment strategy when there are few items

Rename ParentAlignment and ChildAlignment properties

offsetRatio to fraction

Remove DpadRecyclerViewDelegate

Trigger selection changes automatically on scrolling from touch events

Use the SnapHelper API to observe flings and just select the target view closest to the keyline

Support scrolling to unknown pivot in grid with different span sizes

https://github.com/rubensousa/DpadRecyclerView/blob/master/dpadrecyclerview/src/main/java/com/rubensousa/dpadrecyclerview/layoutmanager/scroll/SearchPivotSmoothScroller.kt#L160

Fix alignment issue when Edge.MIN is used and list is small

Unnecessary animations when item changes are outside of bounds

To reproduce:

Scroll the list in the sample until item 19
While the loading indicator is shown, scroll up
Observe

Actual: Grid will relayout and play an animation

Expected: Grid doesn't play animation

Add support for reverse layout

Add touch intercept listener

Focus is lost when fast scrolling a grid and triggering layout passes at the same time

Disable automatic alignment changes on touch scrolling

Reported here: #84 (comment)

Support grids in PivotLayoutManager

Currently this new LayoutManager only supports rows/columns

Add focus recipes to docs

https://rubensousa.github.io/DpadRecyclerView/recipes/focus/

Support setSelectedSubPosition with ViewHolderTask

Create custom LayoutManager that extends directly from RecyclerView.LayoutManager

Pros:

We don't inherit anything unnecessary from GridLayoutManager & LinearLayoutManager
Get rid of ugly workarounds to align edges correctly
Potential performance gain (needs to benchmarked to confirm it's actually better)

Cons: