2 Star 8 Fork 0

mervin1024 / SVRefresh

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

SVRefresh

介绍

SVRefresh 是一款 OpenHarmony 环境下,基于 ArkUI 封装的下拉刷新、上拉加载组件。

支持主动触发刷新、开启/关闭刷新。上拉加载支持拖拽触发和完全展示自动触发

效果展示

RefreshRefresh

安装教程

ohpm install @mervin/svrefresh

使用说明

使用示例

import { FooterLoadMoreStatus, HeaderRefreshStatus, SVRefresh } from '@mervin/SVRefresh'

@Entry
@Component
struct Index {
  // 用来控制刷新状态
  @State private refreshStatus: HeaderRefreshStatus = HeaderRefreshStatus.inactive
  // 用来控制加载状态
  @State private loadMoreStatus: FooterLoadMoreStatus = FooterLoadMoreStatus.inactive

  build() {
    Column() {
      SVRefresh({
        /// 状态双向同步
        refreshStatus: this.refreshStatus,
        loadMoreStatus: this.loadMoreStatus,
        /// 参数 Scroller 必须绑定滚动组件
        childList: (scroller) => {
          this.listViewBuilder(scroller)
        },
        /// 可选:传入已经初始化的 Scroller | ListScroller。不传则由 SVRefresh 内部自行初始化 Scroller
        /// scroller: this.scroller,
        /// 可选配置
        refreshOptions: {
          /// 底部完全露出即加载更多,无需拖拽。不传默认为 true
          isAutoLoadMore: true,
        },
        /// 触发刷新的回调
        onRefreshing: () => {
          this.viewModel.onRefreshing(() => {
            this.refreshStatus = HeaderRefreshStatus.inactive
            if (this.loadMoreStatus == FooterLoadMoreStatus.noMoreData) {
              this.loadMoreStatus = FooterLoadMoreStatus.inactive
            }
          })
        },
        /// 触发加载的回调
        onLoadingMore: () => {
          this.viewModel.onLoadMore((hasMoreData) => {
            this.loadMoreStatus = hasMoreData ? FooterLoadMoreStatus.inactive : FooterLoadMoreStatus.noMoreData
          })
        },
        /// 自定义 header
        headerUI: (state) => {
          this.testHeaderBuilder(state)
        }
      })
    }
  }

  @Builder
  private listViewBuilder(scroller: Scroller) {
    List({ space: 20, scroller: scroller })
      .height("100%")
      .edgeEffect(EdgeEffect.Spring, { alwaysEnabled: true }) /*不要设置为 Fade,拖动至边缘会一直显示 Fade 效果,很难看*/
  }

  @Builder
  testHeaderBuilder($$: RefreshStateImp) {
    TestRefreshHeader({ state: $$.state })
  }
}

@Component
struct TestRefreshHeader {
  @Link state: RefreshState

  ///...
}

其中List组件的 edgeEffect 属性不要设置为(EdgeEffect.Fade),展示效果不好

属性(接口)说明

SVRefresh 组件属性

名称 参数类型 描述 必填
childList @BuilderParam($$: Scroller) => void 自定义主体布局,内部有列表或宫格组件,需绑定参数 scroller
refreshStatus HeaderRefreshStatus 头部刷新组件状态,双向绑定
loadMoreStatus FooterLoadMoreStatus 尾部刷新组件状态,双向绑定
onRefreshing () => void 下拉刷新回调
onLoadingMore () => void 上拉加载回调
scroller Scroller 由外部初始化与列表绑定的 Scroller。可以不传,SVRefresh 内部会自行初始化 Scroller
refreshOptions SVRefreshOptions 刷新组件相关配置:如 header、footer 的高度,是否开启弹性效果,是否自动触发底部加载
headerUI @BuilderParam($$: RefreshStateImp) => void 自定义下拉刷新组件,不传为默认样式
footerUI @BuilderParam($$: RefreshStateImp) => void 自定义上拉加载组件,不传为默认样式
componentOptions SVRefreshComponentOptions 默认刷新组件的 UI 配置,都是默认刷新控件的样式,使用自定义控件不需要赋值
onHeaderStateChange (state: RefreshState) => void header 刷新状态改变回调
onFooterStateChange (state: RefreshState) => void footer 刷新状态改变回调

HeaderRefreshStatus枚举说明

可同步触发刷新组件的状态改变

名称 枚举值 描述
hidden 0 隐藏状态,禁用下拉刷新
inactive 1 普通闲置状态,可触发刷新
refreshing 2 正在刷新中的状态,主动赋值列表会滚动到顶部并触发刷新

FooterLoadMoreStatus枚举说明

可同步触发加载组件的状态改变

名称 枚举值 描述
hidden 0 隐藏状态,禁用上拉加载
inactive 1 普通闲置状态,可触发加载
loading 2 正在加载中的状态,主动赋值可以触发加载回调,但不会触发列表滚动
noMoreData 3 无更多数据状态,展示但是不可触发刷新

SVRefreshOptions对象说明

刷新组件相关配置,均为可选值

参数名 类型 描述 默认值
headerHeight number 下拉刷新控件的展示高度,同时也是触发下拉事件的高度 64
footerHeight number 上拉加载控件的展示高度,同时也是触发上拉事件的高度 54
isAutoLoadMore boolean 可以控制上拉加载组件的触发方式,自动 or 拖拽 true
onlyAutoLoadMoreOnceOnSingleDrag boolean isAutoLoadMoretrue时,可以控制单次拖拽期间内只能触发一次 loading false
headerBounces boolean 下拉是否支持弹性效果 true
footerBounces boolean 上拉是否支持弹性效果 true

SVRefreshComponentOptions对象说明

都是默认刷新控件的样式,使用自定义控件不需要关心这个属性

参数名 类型 描述 默认值
headerFont Font 默认 header 的字体 { size: 16 }
footerFont Font 默认 footer 的字体 { size: 16 }
headerLoadingProgressSize length header 的默认 loading 组件尺寸 36
footerLoadingProgressSize length footer 的默认 loading 组件尺寸 36
headerText (state: RefreshState) => string 各刷新状态下 header 展示的文字 -
footerText (state: RefreshState) => string 各刷新状态下 footer 展示的文字 -

RefreshState枚举说明

刷新组件 UI 展示的的不同阶段

名称 枚举值 描述
hidden 0 隐藏禁用状态
inactive 1 普通闲置状态,可触发加载
drag 2 下拉中但未达到刷新距离
overDrag 3 松开就可以进行刷新的状态,footer 的 isAutoLoadMore 为 true 时不会走到这个状态
refreshing 4 正在刷新中的状态
noMoreData 5 所有数据加载完毕,没有更多的数据了。仅 footer 可以有这个状态

约束与限制

在下述版本验证通过:

  • DevEco Studio: 4.1 Canary(4.1.3.500), SDK: API11 (4.1.0.36)

TODO LIST

  1. 使用 List 嵌套模式实现刷新,可以做到 footer 自动贴在尾部数据之后,而不是一定要拖拽才能出现

  2. 下拉刷新组件支持二次深度刷新状态(短下拉和长下拉)

贡献代码

使用过程中发现任何问题都可以提 Issue 给我们,当然,我们也非常欢迎你给我们发 PR

开源协议

本项目基于 Apache License 2.0 ,请自由地享受和参与开源。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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.

简介

SVRefresh 是一款 OpenHarmony 环境下,基于 ArkUI 封装的下拉刷新、上拉加载组件。 展开 收起
TypeScript 等 3 种语言
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/mervin1024/SVRefresh.git
git@gitee.com:mervin1024/SVRefresh.git
mervin1024
SVRefresh
SVRefresh
master

搜索帮助