https://github.com/bradmartin/nativescript-wave-refresh

NativeScript plugin for a custom pull to refresh animation/layout
https://github.com/bradmartin/nativescript-wave-refresh

android nativescript nativescript-plugin pull-to-refresh

Last synced: 2 months ago
JSON representation

NativeScript plugin for a custom pull to refresh animation/layout

• Host: GitHub
• URL: https://github.com/bradmartin/nativescript-wave-refresh
• Owner: bradmartin
• License: other
• Created: 2016-07-07T23:53:32.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-07T19:08:43.000Z (almost 7 years ago)
• Last Synced: 2024-10-12T13:41:55.831Z (2 months ago)
• Topics: android, nativescript, nativescript-plugin, pull-to-refresh
• Language: TypeScript
• Homepage:
• Size: 2.66 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm](https://img.shields.io/npm/v/nativescript-wave-refresh.svg)](https://www.npmjs.com/package/nativescript-wave-refresh)

[![npm](https://img.shields.io/npm/dt/nativescript-wave-refresh.svg?label=npm%20downloads)](https://www.npmjs.com/package/nativescript-wave-refresh)

[![GitHub stars](https://img.shields.io/github/stars/bradmartin/nativescript-wave-refresh.svg)](https://github.com/bradmartin/nativescript-wave-refresh/stargazers)

[![PayPal Donate](https://img.shields.io/badge/Donate-PayPal-ff4081.svg)](https://www.paypal.me/bradwayne88)

# NativeScript-Wave-Refresh :recycle:

NativeScript plugin for a custom pull-to-refresh layout.

## Demo

![Demo](./screens/demo.gif)

## Native Library

[Wave Swipe Refresh Layout](https://github.com/recruit-lifestyle/WaveSwipeRefreshLayout)

## Installation

From your command prompt/termial go to your app's root folder and execute:

`tns plugin add nativescript-wave-refresh`

## Usage

## XML

```XML

  

  

    

      

        

          

        

      

    

  

```

## TS

```TS

import { WaveRefresh } from "nativescript-wave-refresh"

  public stopRefresh(args: any) {

    // Load more data here and then set 'refreshing = false' to end the refresh

    let waveRefresh: WaveRefresh = args.object;

    waveRefresh.refreshing = false;

  }

```

## Attributes

**refresh : function** *optional* - function executed when the WaveRefresh starts refreshing.

*backgroundColor* is supported to specify the background color of the wave refresh. This will help to blend it in with the ActionBar.

## API

### refreshing

Property. Notifies the widget that the refresh state has changed.