@nativescript-community/ui-pulltorefresh 2.4.8 → 2.5.1

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.5.1](https://github.com/nativescript-community/ui-pulltorefresh/compare/v2.5.0...v2.5.1) (2022-05-09)
+
+**Note:** Version bump only for package @nativescript-community/ui-pulltorefresh
+
+
+
+
+
+# [2.5.0](https://github.com/nativescript-community/ui-pulltorefresh/compare/v2.4.9...v2.5.0) (2021-10-21)
+
+
+### Features
+
+* **android:** native-api-usage ([19397fd](https://github.com/nativescript-community/ui-pulltorefresh/commit/19397fdb8b11ac2f6b47a31c8958a8fa92bf97bf))
+
+
+
+
+
+## [2.4.9](https://github.com/nativescript-community/ui-pulltorefresh/compare/v2.4.8...v2.4.9) (2021-09-27)
+
+**Note:** Version bump only for package @nativescript-community/ui-pulltorefresh
+
+
+
+
+
 ## [2.4.8](https://github.com/nativescript-community/ui-pulltorefresh/compare/v2.4.7...v2.4.8) (2021-07-08)
 
 **Note:** Version bump only for package @nativescript-community/ui-pulltorefresh

package/README.md

@@ -12,27 +12,13 @@ NativeScript plugin to use Pull to Refresh on any view.
     <a href="https://www.npmjs.com/package/@nativescript-community/ui-pulltorefresh">
         <img src="https://img.shields.io/npm/dt/@nativescript-community/ui-pulltorefresh.svg?label=npm%20downloads" alt="npm">
     </a>
-    <a href="https://github.com/nativescript-community/ui-pulltorefresh/stargazers">
-        <img src="https://img.shields.io/github/stars/nativescript-community/ui-pulltorefresh.svg" alt="stars">
-    </a>
-     <a href="https://github.com/nativescript-community/ui-pulltorefresh/network">
-        <img src="https://img.shields.io/github/forks/nativescript-community/ui-pulltorefresh.svg" alt="forks">
-    </a>
-    <a href="https://github.com/nativescript-community/ui-pulltorefresh/blob/master/LICENSE">
-        <img src="https://img.shields.io/github/license/nativescript-community/ui-pulltorefresh.svg" alt="license">
-    </a>
-    <a href="https://nstudio.io">
-      <img src="https://github.com/nstudio/media/blob/master/images/nstudio-banner.png?raw=true" alt="nStudio banner">
-    </a>
-    <h5 align="center">Do you need assistance on your project or plugin? Contact the nStudio team anytime at <a href="mailto:team@nstudio.io">team@nstudio.io</a> to get up to speed with the best practices in mobile and web app development.
-    </h5>
 </p>
 
 ---
 
 ## Installation
 
-`tns plugin add @nativescript-community/ui-pulltorefresh`
+`ns plugin add @nativescript-community/ui-pulltorefresh`
 
 #### [Android - _SwipeRefreshLayout_](http://developer.android.com/reference/android/support/v4/widget/SwipeRefreshLayout.html)
 
@@ -57,7 +43,7 @@ NativeScript plugin to use Pull to Refresh on any view.
     <PullRefresh:PullToRefresh refresh="refreshList">
         <list-view items="{{ users }}">
             <list-view.itemTemplate>
-                <label text="{{ name }}" row="0" col="1"textWrap="true" class="message" />
+                <label text="{{ name }}" row="0" col="1" textWrap="true" class="message" />
             </list-view.itemTemplate>
         </list-view>
     </PullRefresh:PullToRefresh>
@@ -90,8 +76,9 @@ exports.refreshList = refreshList;
 ### Angular NativeScript
 
 ```typescript
-import { registerElement } from "nativescript-angular/element-registry";
-registerElement("PullToRefresh", () => require("@nativescript-community/ui-pulltorefresh").PullToRefresh);
+import { registerElement } from '@nativescript/angular';
+import { PullToRefresh } from '@nativescript-community/ui-pulltorefresh';
+registerElement('PullToRefresh', () => PullToRefresh);
 
 refreshList(args) {
          const pullRefresh = args.object;
@@ -159,6 +146,8 @@ export default {
 - **refresh : function** _required_
 - **refreshing: boolean** - Notifies the widget that the refresh state has
   changed.
+- **indicatorColor: Color** - The color of the indicator icon.
+- **indicatorFillColor: Color** - The background color of the indicator.
 
 ## [Changelog](./CHANGELOG.md)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nativescript-community/ui-pulltorefresh",
-  "version": "2.4.8",
+  "version": "2.5.1",
   "description": "A NativeScript plugin to provide the Pull to Refresh control on any view.",
   "main": "pulltorefresh",
   "typings": "index.d.ts",
@@ -42,5 +42,5 @@
   "readmeFilename": "README.md",
   "bugs": "https://github.com/nativescript-community/ui-pulltorefresh/issues",
   "homepage": "https://github.com/nativescript-community/ui-pulltorefresh",
-  "gitHead": "724213523bd3702222b6a1c1c3c7d1853b5c601e"
+  "gitHead": "05bcd5d022fbd29e5fe0952fba50ed1a6138637f"
 }

package/platforms/android/native-api-usage.json

@@ -0,0 +1,7 @@
+{
+    "uses": [
+        "com.nativescript.swiperefreshlayout:CarouselFriendlySwipeRefreshLayout*",
+        "androidx.swiperefreshlayout.widget:SwipeRefreshLayout*",
+        "androidx.swiperefreshlayout.widget.SwipeRefreshLayout:OnRefreshListener*"
+    ]
+}

package/pulltorefresh-common.js

@@ -1,15 +1,16 @@
-import { ContentView, CSSType, Property, View } from '@nativescript/core';
+import { Color, ContentView, CssProperty, CSSType, Property, Style } from '@nativescript/core';
 let PullToRefreshBase = class PullToRefreshBase extends ContentView {
-    _addChildFromBuilder(name, value) {
-        // copy inheritable style property values
-        const originalColor = value.style.color || null;
-        const originaBackgroundColor = value.style.backgroundColor || null;
-        if (value instanceof View) {
-            this.content = value;
-        }
-        // reset inheritable style property values as we do not want those to be inherited
-        value.style.color = originalColor;
-        value.style.backgroundColor = originaBackgroundColor;
+    get indicatorColor() {
+        return this.style.indicatorColor;
+    }
+    set indicatorColor(value) {
+        this.style.indicatorColor = value;
+    }
+    get indicatorFillColor() {
+        return this.style.indicatorFillColor;
+    }
+    set indicatorFillColor(value) {
+        this.style.indicatorFillColor = value;
     }
 };
 PullToRefreshBase.refreshEvent = 'refresh';
@@ -22,4 +23,18 @@ export const refreshingProperty = new Property({
     defaultValue: false,
 });
 refreshingProperty.register(PullToRefreshBase);
+export const indicatorColorProperty = new CssProperty({
+    name: 'indicatorColor',
+    cssName: 'indicator-color',
+    equalityComparer: Color.equals,
+    valueConverter: (v) => new Color(v),
+});
+indicatorColorProperty.register(Style);
+export const indicatorFillColorProperty = new CssProperty({
+    name: 'indicatorFillColor',
+    cssName: 'indicator-fill-color',
+    equalityComparer: Color.equals,
+    valueConverter: (v) => new Color(v),
+});
+indicatorFillColorProperty.register(Style);
 //# sourceMappingURL=pulltorefresh-common.js.map

package/pulltorefresh.android.js

@@ -1,19 +1,12 @@
-import { backgroundColorProperty, colorProperty } from '@nativescript/core';
-import { Color } from '@nativescript/core/color';
-import { PullToRefreshBase, refreshingProperty } from './pulltorefresh-common';
+import { indicatorColorProperty, indicatorFillColorProperty, PullToRefreshBase, refreshingProperty } from './pulltorefresh-common';
 export * from './pulltorefresh-common';
 export class PullToRefresh extends PullToRefreshBase {
-    //@ts-ignore
-    get android() {
-        return this.nativeView;
-    }
     createNativeView() {
         const swipeRefreshLayout = new com.nativescript.swiperefreshlayout.CarouselFriendlySwipeRefreshLayout(this._context);
         return swipeRefreshLayout;
     }
     initNativeView() {
         super.initNativeView();
-        const nativeView = this.nativeView;
         const androidXListener = new androidx.swiperefreshlayout.widget.SwipeRefreshLayout.OnRefreshListener({
             onRefresh: () => {
                 this.refreshing = true;
@@ -23,27 +16,24 @@ export class PullToRefresh extends PullToRefreshBase {
                 });
             },
         });
-        nativeView.setOnRefreshListener(androidXListener);
-        nativeView.refreshListener = androidXListener;
+        this.nativeViewProtected.setOnRefreshListener(androidXListener);
+        this.nativeViewProtected.refreshListener = androidXListener;
     }
     disposeNativeView() {
-        const nativeView = this.nativeView;
-        nativeView.refreshListener = null;
+        this.nativeViewProtected.refreshListener = null;
         super.disposeNativeView();
     }
-    [refreshingProperty.getDefault]() {
-        return false;
-    }
     [refreshingProperty.setNative](value) {
-        this.nativeView.setRefreshing(value);
+        this.nativeViewProtected.setRefreshing(value);
     }
-    [colorProperty.setNative](value) {
-        const color = value instanceof Color ? value.android : value;
-        this.nativeView.setColorSchemeColors([color]);
+    [indicatorColorProperty.setNative](value) {
+        const colors = [];
+        value && colors.push(value.android);
+        this.nativeViewProtected.setColorSchemeColors(colors);
     }
-    [backgroundColorProperty.setNative](value) {
-        const color = value instanceof Color ? value.android : value;
-        this.nativeView.setProgressBackgroundColorSchemeColor(color);
+    [indicatorFillColorProperty.setNative](value) {
+        const color = value ? value.android : null;
+        this.nativeViewProtected.setProgressBackgroundColorSchemeColor(color);
     }
 }
 //# sourceMappingURL=pulltorefresh.android.js.map

package/pulltorefresh.ios.js

@@ -1,6 +1,5 @@
-import { Color } from '@nativescript/core/color';
-import { backgroundColorProperty, colorProperty, Utils, } from '@nativescript/core';
-import { PullToRefreshBase, refreshingProperty } from './pulltorefresh-common';
+import { Utils, } from '@nativescript/core';
+import { indicatorColorProperty, indicatorFillColorProperty, PullToRefreshBase, refreshingProperty } from './pulltorefresh-common';
 export * from './pulltorefresh-common';
 var PullToRefreshHandler = /** @class */ (function (_super) {
     __extends(PullToRefreshHandler, _super);
@@ -29,9 +28,9 @@ const SUPPORT_REFRESH_CONTROL = Utils.ios.MajorVersion >= 10;
 export class PullToRefresh extends PullToRefreshBase {
     constructor() {
         super();
-        this.refreshControl = UIRefreshControl.alloc().init();
-        this._handler = PullToRefreshHandler.initWithOnwer(new WeakRef(this));
-        this.refreshControl.addTargetActionForControlEvents(this._handler, 'handleRefresh', 4096 /* ValueChanged */);
+        this.mRefreshControl = UIRefreshControl.alloc().init();
+        this.mHandler = PullToRefreshHandler.initWithOnwer(new WeakRef(this));
+        this.mRefreshControl.addTargetActionForControlEvents(this.mHandler, 'handleRefresh', 4096 /* ValueChanged */);
     }
     onLoaded() {
         super.onLoaded();
@@ -41,76 +40,73 @@ export class PullToRefresh extends PullToRefreshBase {
         if (!newView || !newView.nativeViewProtected) {
             return;
         }
-        const nNewView = newView.nativeViewProtected;
-        if (nNewView instanceof UIScrollView) {
+        const owner = newView.nativeViewProtected;
+        if (owner instanceof UIScrollView) {
             if (SUPPORT_REFRESH_CONTROL) {
-                nNewView.refreshControl = this.refreshControl;
+                owner.refreshControl = this.mRefreshControl;
             }
             else {
                 // ensure that we can trigger the refresh, even if the content is not large enough
-                nNewView.alwaysBounceVertical = true;
-                nNewView.addSubview(this.refreshControl);
+                owner.alwaysBounceVertical = true;
+                owner.addSubview(this.mRefreshControl);
             }
         }
-        else if (nNewView instanceof WKWebView) {
+        else if (owner instanceof WKWebView) {
             if (SUPPORT_REFRESH_CONTROL) {
-                nNewView.scrollView.refreshControl = this.refreshControl;
+                owner.scrollView.refreshControl = this.mRefreshControl;
             }
             else {
                 // ensure that we can trigger the refresh, even if the content is not large enough
-                nNewView.scrollView.alwaysBounceVertical = true;
-                nNewView.scrollView.addSubview(this.refreshControl);
+                owner.scrollView.alwaysBounceVertical = true;
+                owner.scrollView.addSubview(this.mRefreshControl);
             }
         }
         else if (typeof TKListView !== 'undefined' &&
-            nNewView instanceof TKListView) {
+            owner instanceof TKListView) {
             if (SUPPORT_REFRESH_CONTROL) {
-                nNewView.collectionView.refreshControl = this.refreshControl;
+                owner.collectionView.refreshControl = this.mRefreshControl;
             }
             else {
                 // ensure that we can trigger the refresh, even if the content is not large enough
-                nNewView.collectionView.alwaysBounceVertical = true;
-                nNewView.collectionView.addSubview(this.refreshControl);
+                owner.collectionView.alwaysBounceVertical = true;
+                owner.collectionView.addSubview(this.mRefreshControl);
             }
         }
-        else if (nNewView instanceof WKWebView) {
+        else if (owner instanceof WKWebView) {
             if (SUPPORT_REFRESH_CONTROL) {
-                nNewView.scrollView.refreshControl = this.refreshControl;
+                owner.scrollView.refreshControl = this.mRefreshControl;
             }
             else {
                 // ensure that we can trigger the refresh, even if the content is not large enough
-                nNewView.scrollView.alwaysBounceVertical = true;
-                nNewView.scrollView.addSubview(this.refreshControl);
+                owner.scrollView.alwaysBounceVertical = true;
+                owner.scrollView.addSubview(this.mRefreshControl);
             }
         }
         else {
             throw new Error('Content must inherit from either UIScrollView or WKWebView!');
         }
     }
-    [refreshingProperty.getDefault]() {
-        return false;
-    }
     [refreshingProperty.setNative](value) {
         if (value) {
-            this.refreshControl.beginRefreshing();
+            this.mRefreshControl.beginRefreshing();
         }
         else {
-            this.refreshControl.endRefreshing();
+            this.mRefreshControl.endRefreshing();
         }
     }
-    [colorProperty.getDefault]() {
-        return this.refreshControl.tintColor;
+    [indicatorColorProperty.getDefault]() {
+        return this.mRefreshControl.tintColor;
     }
-    [colorProperty.setNative](value) {
-        const color = value instanceof Color ? value.ios : value;
-        this.refreshControl.tintColor = color;
+    [indicatorColorProperty.setNative](value) {
+        const color = value ? value.ios : null;
+        this.mRefreshControl.tintColor = color;
     }
-    [backgroundColorProperty.getDefault]() {
-        return this.refreshControl.backgroundColor;
+    [indicatorFillColorProperty.getDefault]() {
+        return this.mRefreshControl.backgroundColor;
     }
-    [backgroundColorProperty.setNative](value) {
-        const color = value instanceof Color ? value.ios : value;
-        this.refreshControl.backgroundColor = color;
+    [indicatorFillColorProperty.setNative](value) {
+        const color = value ? value.ios : null;
+        this.mRefreshControl.backgroundColor = color;
     }
 }
 //# sourceMappingURL=pulltorefresh.ios.js.map