react-native-swipe-list-view组件使用分析

一、前言

react-native-swipe-list-view 是一个具有侧滑功能的react-native的组件,下面的这篇文章是以翻译官方文档和结合自己的项目所写,不过主要内容是对官方文档的翻译。
git官方地址

二、此组件由两个子组件组成:

  • <SwipeListView>是基于listview封装的具有侧滑打开、关闭功能的listview组件,具有一些原生功能行为;例如:当某一行侧滑打开后,在listview滚动或侧滑打开其他行时,会自动关闭此行。目前<SwipeListView>支持 FlatList 和 SectionList ,具体的详情使用请查看demo中 example.js 文件
  • <SwipeRow>可以单独拿出来用,它不依赖于<SwipeListView>,如果你只是想拥有具有侧滑功能的row,那么你可以使用这个组件,它同样具有侧滑功能。

三、安装

npm install --save react-native-swipe-list-viewyarn add react-native-swipe-list-view

四、运行示例

在项目的 ./SwipeListExample目录下是下面gif示例运行效果,运行操作如下:
1、Git上下载项目
2、cd SwipeListExample
3、npm install 或 yarn
4、react-native run-ios | react-native run-android


iOS运行示例.gif

Android运行示例.gif

五、简单用法

import { SwipeListView } from 'react-native-swipe-list-view';

render() {
    return (
        <SwipeListView
            useFlatList
            data={this.state.listViewData}
            renderItem={ (data, rowMap) => (
                <View style={styles.rowFront}>
                    <Text>I am {data.item} in a SwipeListView</Text>
                </View>
            )}
            renderHiddenItem={ (data, rowMap) => (
                <View style={styles.rowBack}>
                    <Text>Left</Text>
                    <Text>Right</Text>
                </View>
            )}
            leftOpenValue={75}
            rightOpenValue={-75}
        />
    )
}

特别注意

如果你的row 是可点击的(如:TouchableOpacity, TouchableHightlight等等),建议把此类组件放在最外层;

建议做法

renderItem={ data => (
    <TouchableHighlight onPress={this.doSomething.bind(this)}>
        <View>
            <Text>I am {data.item} in a SwipeListView</Text>
        </View>
    </TouchableHighlight>
)}

不建议做法

renderItem={ data => (
    <View>
        <TouchableHighlight onPress={this.doSomething.bind(this)}>
            <Text>I am {data.item} in a SwipeListView</Text>
        </TouchableHighlight>
    </View>
)}

关闭row

renderHiddenRow={ (data, secId, rowId, rowMap) => (
                            <View style={styles.rowBack}>
                                <Text>Left</Text>
                                <TouchableOpacity style={[styles.backRightBtn, styles.backRightBtnLeft]} onPress={ _ => this.closeRow(rowMap, `${secId}${rowId}`) }>
                                    <Text style={styles.backTextWhite}>Close</Text>
                                </TouchableOpacity>
                                <TouchableOpacity style={[styles.backRightBtn, styles.backRightBtnRight]} onPress={ _ => this.deleteRow(rowMap, `${secId}${rowId}`) }>
                                    <Text style={styles.backTextWhite}>Delete</Text>
                                </TouchableOpacity>
                            </View>
                        )}

rowMap对象结构

{
    row_key_1: ref_to_row_1,
    row_key_2: ref_to_row_2
}

rowMap是一个对象,每一个row_key对应的是一个字符串,如果是section,则row_key的结构是<section_id>.<row_id>,
否则是<row_id>

六、使用<SwipeRow>特别注意点

1、如果你使用的是一个单独的<SwipeRow>,你一个通过定义ref去调用closeRow()关闭row
2、当使用<SwipeRow>时,你必须给<SwipeRow>传递两个元素,示例如下:

<SwipeRow>
    <View style={hiddenRowStyle} />
    <View style={visibleRowStyle} />
</SwipeRow>

七、<SwipeListView> API(部分)

Props Default Type Description
useFlatList false bool 使用React Native的FlatList组件
useSectionList false bool 使用React Native的SectionList组件
directionalDistanceChangeThreshold 2 number 更改行的灵敏度
swipeGestureBegan fun 开始滑动时调用
closeOnRowPress true bool 当按下一行时,关闭打开的行
closeOnScroll true bool 当滚动listview时,关闭打开的行
closeOnRowBeginSwipe false bool 当行开始滑动打开时,关闭打开的行
leftOpenValue 0 number 左侧侧滑X的偏移量(正数)
rightOpenValue 0 number 右侧侧滑X的偏移量(负数)
renderRow(required) func 渲染行
renderHiddenRow func 渲染隐藏的行
swipeToOpenPercent 50 number 滑动%触发行打开
disableLeftSwipe false bool 禁止向左滑动
disableRightSwipe false bool 禁止向右滑动
recalculateHiddenLayout false bool 启动隐藏行实时onLayout计算(默认情况下,出于性能原因,仅在第一次onLayout计算隐藏行大小)
onRowClose func 当滑动行的动画处于关闭状态时调用
onRowDidClose func 当滑动行的动画已经关闭时调用
onRowOpen func 当滑动行的动画处于开启状态时调用
onRowDidOpen func 当滑动行的动画已经开启时调用
swipeRowStyle object 滑动行样式风格
listViewRef func 在ListView设置ref时调用,并将ref传递给ListView. eg:listViewRef={ ref => this._swipeListViewRef = ref }
previewFirstRow false bool 第一行具有滑动预览效果
previewRowIndex number 指定某一行具有滑动预览效果
previewDuration number 预览持续时间
previewOpenValue number 打开侧滑动画快慢,Default: 0.5 * props.rightOpenValue
friction number 打开关闭动画的摩擦数
tension number 打开关闭动画的张力

八、<SwipeRow> API (部分)

Props Default Type Description
closeOnRowPress true bool 当按下一行时,关闭打开的行
directionalDistanceChangeThreshold 2 number 更改行的灵敏度
friction 7 number 打开关闭动画的摩擦数
tension number 打开关闭动画的张力
leftOpenValue 0 number 左侧侧滑X的偏移量(正数)
stopLeftSwipe number 左侧侧滑X的最大偏移量(正数)
rightOpenValue 0 number 右侧侧滑X的偏移量(负数)
stopRightSwipe number 右侧侧侧滑X的最大偏移量(负数)
onRowPress func 按下滑动行时调用
onRowOpen func 当滑动行的动画处于开启状态时调用
onRowClose func 当滑动行的动画处于关闭状态时调用
swipeToOpenPercent 50 number 滑动%触发行打开
setScrollEnabled func
disableLeftSwipe false bool 禁止向左滑动
disableRightSwipe false bool 禁止向右滑动
recalculateHiddenLayout false bool 启动隐藏行实时onLayout计算(默认情况下,出于性能原因,仅在第一次onLayout计算隐藏行大小)
style object 滑动行样式风格
preview false bool 具有滑动预览效果
previewDuration 300 number 预览持续时间
previewOpenValue number 打开侧滑动画快慢,Default: 0.5 * props.rightOpenValue
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345

推荐阅读更多精彩内容