android-nest-scroll-ptr

KO | EN

gitlite — search

#javascript #react #typescript #llm #go #android #machine-learning #rust #linux #docker #java #awesome #vue #awesome-list

android-nest-scroll-ptr

(★ 12)

android pull-to-refresh layout work with nested-scroll

android-nest-scroll-ptr Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# android-nest-scroll-ptr

[中文介绍](https://github.com/s1rius/android-nest-scroll-ptr/blob/master/README_CN.md)

This library implements pull-to-refresh logic and work with nested-scroll. It is easy to use and extend.

It is driven by a [StateMachine](https://github.com/Tinder/StateMachine)

### Requirements

- minsdk 14/21(compose)
- kotlin | compose

### Features

- driven by a FSM
- work with nested-scroll
- Jetpack Compose implementation
- easy to customize the layout

### Demo

- Ins
- Wechat
- Wechat Moment
- NestedScroll Sample

<div>

### Use NSPtr in your application

- add the dependency

```
repositories {
    ...
    mavenCentral()
    ...
}

dependencies {
    ...
    // android view system implementation
    implementation "wtf.s1.ui:nsptr-view:x.x.x"
    // jetpack compose implementation
    implementation "wtf.s1.ui:nsptr-compose:x.x.x"
    ...
}
```

- use in Compose

```kotlin
val coroutine = rememberCoroutineScope()
val nsPtrState = remember {
    NSPtrState(
        coroutineScope = coroutine
    ) {
        // todo refresh block
        it.dispatchPtrEvent(Event.RefreshComplete)
    }
}
NSPtrLayout(
    nsPtrState = nsPtrState,
    modifier = Modifier.fillMaxSize(),
) {
    NSPtrEZHeader(
        modifier = Modifier
            .offset(0.dp, 12.dp),
        nsPtrState = nsPtrState
    )
    LazyColumn(Modifier.ptrContent()) {
        items(10) { index ->
            // todo
        }
    }
}
```

- add a layout to view hierarchy

```kotlin
addView(
    NSPtrEZLayout(context).apply {
        addView(
            RecyclerView(context).apply {
                // add data and adapter
            },
            NSPtrLayout.LayoutParams(
                LayoutParams.MATCH_PARENT, 
                LayoutParams.MATCH_PARENT
            )
        )

addPtrListener(object : NSPtrListener {
            override fun onRefreshing(ptrLayout: NSPtrLayout) {
                super.onRefreshing(ptrLayout)
                // do refresh logic
            }
        })
		// auto refresh
		isRefreshing = true
    },
    LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT)
)
```

- or use in XML layouts

```xml
<wtf.s1.ui.nsptr.view.NSPtrEZLayout
    android:layout_width="match_parent"
    android:layout_height="match_parent">

<androidx.recyclerview.widget.RecyclerView
        android:layout_width="match_parent"
        android:layout_height="match_parent"/>

</wtf.s1.ui.nsptr.view.NSPtrEZLayout>
```

android-nest-scroll-ptr

android-nest-scroll-ptr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

android-nest-scroll-ptr

android-nest-scroll-ptr Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README