react-native-swipe-list-view侧滑删除组件使用

react-native-swipe-list-view 是一个具有侧滑功能的react-native的listview组件

此组件由两个子组件组成:
<SwipeListView> 是基于listview封装的具有侧滑打开、关闭功能的listview组件,具有一些原生功能行为;例如:当某一行侧滑打开后,在listview滚动或侧滑打开其他行时,会自动关闭此行。

如果你只是想拥有具有侧滑功能的row,那么你可以使用提供的<SwipeRow>这个组件,它同样具有侧滑功能。

例子:

ios
ios
android
android

安装

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

运行示例

源代码地址

在项目的 ./SwipeListExample目录下是以上示例运行效果,运行操作如下:

  • git clone https://github.com/jemise111/react-native-swipe-list-view.git
  • cd react-native-swipe-list-view
  • cd SwipeListExample
  • npm install
  • react-native run-ios | react-native run-android

用法

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

render() {
    const ds = new ListView.DataSource({rowHasChanged: (r1, r2) => r1 !== r2});
    return (
        <SwipeListView
            dataSource={ds.cloneWithRows(dataSource)}
            renderRow={ data => (
                <View style={styles.rowFront}>
                    <Text>I am {data} in a SwipeListView</Text>
                </View>
            )}
            renderHiddenRow={ data => (
                <View style={styles.rowBack}>
                    <Text>Left</Text>
                    <Text>Right</Text>
                </View>
            )}
            leftOpenValue={75}
            rightOpenValue={-75}
        />
    )
}

参考 example.js 去学习全部的使用的方法(包括 <SwipeRow> 的用法)

注意

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

建议:

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

不建议:

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

手动关闭rows

在使用的时候如果需要 关闭row,可以使用以下方法调用closeRow()方法关闭row:

<SwipeList
    renderHiddenRow={ (data, secdId, rowId, rowMap) => {
        <TouchableOpacity onPress={ _ => rowMap[`${secId}${rowId}`].closeRow() }>
            <Text>I close the row</Text>
        </TouchableOpacity>
    }}
/>

rowMap是一个object,结构如下:

{
    row_hash_1: ref_to_row_1,
    row_hash_2: ref_to_row_2
}

每一个row_hash是一个<section_id><row_id>结构的字符串

如果你使用的是一个单独的<SwipeRow>,你一个通过定义ref去调用closeRow()关闭row

Per row behavior

perRowBehavior.gif

如果你需要以上的效果,某些row可以侧滑,而某些不可以滑动,可以在renderRow方法返回<SwipeRow>,请参阅下面的示例和API文档,了解如何实现自定义<SwipeRow>。在example.js中还有一个完整的例子。

以下参数可以作为<SwipeRow>的属性被调用:

  • leftOpenValue
  • rightOpenValue
  • stopLeftSwipe
  • stopRightSwipe
  • closeOnRowPress
  • disableLeftSwipe
  • disableRightSwipe
  • recalculateHiddenLayout
import { SwipeListView, SwipeRow } from 'react-native-swipe-list-view';

<SwipeListView
    dataSource={dataSource.cloneWithRows(data)}
    renderRow={ (data, secId, rowId) => (
        <SwipeRow
            disableRightSwipe={parseInt(rowId) % 2 !== 0}
            disableLeftSwipe={parseInt(rowId) % 2 === 0}
            leftOpenValue={20 + parseInt(rowId) * 5}
            rightOpenValue={-150}
        >
            <View style={styles.rowBack}>
                <Text>Left Hidden</Text>
                <Text>Right Hidden</Text>
            </View>
            <View style={styles.rowFront}>
                <Text>Row front | {data}</Text>
            </View>
        </SwipeRow>
    )}
/>

API

SwipeListView(component)

Props Default Type Description
closeOnRowPress true bool 当按下一行时,关闭打开的行
closeOnScroll true bool 当滚动listview时,关闭打开的行
closeOnRowBeginSwipe false bool 当行开始滑动打开时,关闭打开的行
leftOpenValue 0 number 左侧侧滑X的偏移量(正数)
rightOpenValue 0 number 右侧侧滑X的偏移量(负数)
renderRow(必须) -- 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(component)

当使用<SwipeRow>时,你必须给<SwipeRow>传递两个元素,第一个将在第二个后面渲染,e.g:

<SwipeRow>
      <View style={hiddenRowStyle} />
      <View style={visibleRowStyle} />
  </SwipeRow>
Props Default Type Description
closeOnRowPress true bool 当按下一行时,关闭打开的行
friction -- 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

以上内容是参考github官方文档翻译的(谷歌翻译水准,,,),如有不对之处,请指正,我会及时更新

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容