bici-react-native-wheel-picker

react-native 删除console答应

Usage no npm install needed!

<script type="module">
  import biciReactNativeWheelPicker from 'https://cdn.skypack.dev/bici-react-native-wheel-picker';
</script>

README

react-native-wheel-picker

npm version npm version

前言

该库最开始基于react-native-wheel-picker，修改和拓展了很多功能

通过调整样式支持居中选择时间， 增加 showFooter 决定是否显示底部按钮

android 端基于WheelPicker 1.1.2 版本(注意不要手动升级到 1.1.3)进行封装

ios 端基于 RN 自带的 PickerIOS 进行封装(从 0.3.0 已将 PickerIOS 的代码放在项目中)

在原库的基础上面，进行了下面的修改:

  • 修复几处严重 bug，支持 RN 新版本
  • 添加 typescript 定义文件
  • 封装多 Wheel 支持(支持普通和级联模式)
  • 封装常用的 DatePicker、RegionPicker、DateRangePicker 组件

由于两端均是原生组件，性能较好，所有的其他组件均是单个 wheel 在 js 端实现，后面 bug 修复可以直接修改 js，方便热更新。

集成

npm i @yz1311/react-native-wheel-picker  moment react-native-modal --save

自动集成

RN>=0.60

cd ios
pod install

RN<0.60

react-native link @yz1311/react-native-wheel-picker

手动集成

Add in settings.gradle

include ':react-native-wheel-picker'
project(':react-native-wheel-picker').projectDir = new File(settingsDir, '../node_modules/@yz1311/react-native-wheel-picker/android')

Add in app/build.gradle

compile project(':react-native-wheel-picker')

Modify MainApplication

    import com.zyu.ReactNativeWheelPickerPackage;
    ......

    protected List<ReactPackage> getPackages() {
        return Arrays.<ReactPackage>asList(
            new MainReactPackage(), new ReactNativeWheelPickerPackage()
        );
    }

介绍

该库(>=0.2.0)提供了多种 Picker，全部均是 view，相比直接提供 Modal+picker 的模式，单纯的 picker view 更加灵活,想怎么组合都行

import WheelPicker, {
  CommonPicker,
  DateRangePicker,
  DatePicker,
  RegionPicker,
} from '@yz1311/react-native-wheel-picker';

基础 Picker

  • WheelPicker: 单个的 wheel，是所有其他 picker 的基础控件，基于原生封装(iOS 是 RN 自带的 PickerIOS，android 封装自cn.aigestudio.wheelpicker:WheelPicker)

  • CommonPicker: 基于WheelPicker封装的多 Wheel picker 组件，支持parallel(wheel 间不关联)和cascade(wheel 间关联)两种模式,基本所有单、多 wheel 组件均可以直接使用该组件或者在该组件上封装

常用 Picker

  • DatePicker: 基于CommonPicker封装的日期选择组件，支持日期/时间/日期+时间 三种模式

  • DateRangePicker: 基于CommonPicker封装的日期段选择组件，可以选择一个时间段

  • RegionPicker: 基于CommonPicker封装的地址选择组件，支持选择省市区，封装了 2019/01 月的省市区数据，支持自定义数据源

各组件的属性，请查看index.d.ts

例子

引用

import WheelPicker ,{CommonPicker,DateRangePicker,DatePicker,RegionPicker} from "@yz1311/react-native-wheel-picker";

  • 单 wheel

<CommonPicker pickerData={['刘备', '张飞', '关羽', '赵云', '黄忠', '马超', '魏延', '诸葛亮']} selectedValue={['']} />

  • 多 wheel(parallel 模式)

<CommonPicker
  pickerData={[
    ['男', '女'],
    ['0~20岁', '21~40岁', '40~60岁', '60岁以上'],
  ]}
  selectedValue={['']}
/>

  • 多 wheel(cascade 模式)

<CommonPicker
  pickerData={{
    男: ['打游戏', '电子产品', '看球'],
    女: ['买衣服', '买鞋子', '美妆', '自拍'],
  }}
  selectedValue={['男', '电子产品']}
/>

  • 日期选择(默认 date 模式，支持 year/month/date/time/datetime)

    注意: 不管是哪种模式，回调返回的数据都是一个 date 对象，具体的数值需要自己去转换

year: 选择年份

month: 选择年月

date: 选择年月日

time: 选择时分

datetime: 选择年月日时分(minDate 和 maxDate 无法影响到时分，只能影响到日期,譬如:minDate 设置为 2010-01-01 08:00:00,依旧可以选择当天 00:00~23:59 的时间段)

<DatePicker
        mode={'date'}
        //date值可以不填，默认是当前时间
        date={new Date()}
        onPickerConfirm={(value)=>{
            //不管mode的值是哪一种, value均是一个Date对象, 需要转换为所需的值
            //譬如: 如果mode=='year', 则可以通过`moment(value).year()`
        }}
        />

  • 日期段选择

该库是仿照支付宝账单的时间段选择控件来的(支付宝: 我的-账单)

规则介绍(跟支付宝的并非完全一样):

  • 开始时间的选择范围: 当前时间的 前 30 年~后 10 年(跟 DatePicker 的范围一致)

  • 结束时间的范围范围: 选择的开始时间~当前时间的后 10 年，也就是必须先选择开始时间才能选择结束时间

  • 清空按钮，会设置开始时间为当前时间，结束时间为空

  • 如果已选择开始结束时间，再将开始时间选择为大于结束时间，则会清空结束时间

  • 通过 startDate 和 endDate 两个属性可以设置默认值(只能设置默认值，无法从外部更新值)

  • 默认只有同时选择了开始结束时间才会返回值，其中有任意一个没选择，返回的 startDate 和 endDate 都是 null

<DateRangePicker
        //错误信息(可选)
        errorMessage={this.state.errorMessage}
        onPickerConfirm={(startDate, endDate)=>{
            //注意: startDate和endDate是Date对象, 但是均可能为null
            //如果有需求，必须同时选择开始结束时间的，可以通过判断这两个值是否为空来控制后续操作(譬如不让用户关闭Modal)
        }
       />

  • 地址选择

项目的数据来自于Administrative-divisions-of-China 的 pca-code.json,

项目里面已经自带该数据源，也可以用data={require('pca-code.json')}的方式自定义数据源，但必须符合格式

如果需要四级、五级等其它联动模式，可以直接按照RegionPicker改写一下就行了(数据量过大，不宜内置进库)

<RegionPicker
  //模式，'p' | 'pc' | 'pca'三个值分别代表省、省市、省市区 三种模式,默认是pca
  mode="pca"
  onPickerConfirm={(names, codes) => {
    //names: ["上海市", "市辖区", "黄浦区"],根据mode的不同返回不同长度的数组
    //codes: ["31", "3101", "310101"],根据mode的不同返回不同长度的数组
  }}
  selectedValue={['']}
/>

* ### 结合 Modal 使用

大部分情况下 Picker 都不是只作为 view 使用，而是底部弹窗选择，下面是react-native-modal 为例的代码:

<Modal
  style={{ flex: 1, justifyContent: 'flex-end', margin: 0 }}
  isVisible={selectDateVisible}
  onBackdropPress={() => {
    setSelectDateVisible(false);
  }}
  onBackButtonPress={() => {
    setSelectDateVisible(false);
  }}>
  //所有的picker是默认显示header的
  <DatePicker
    pickerTitle="预约时间"
    date={ruleForm.appointmentTime}
    mode={'datetime'}
    onPickerCancel={() => {
      setSelectDateVisible(false);
    }}
    onPickerConfirm={(date) => {
      setRuleForm((prevState) => ({
        ...prevState,
        appointmentTime: date,
      }));
      setSelectDateVisible(false);
    }}
    //大部分情况下不用关注date改变时的数据，下面方法可以删除
    onDateChange={() => {}}
  />
</Modal>

在 0.2.6 版本开始，自带 Modal 模式

<DatePicker
  pickerTitle="预约时间"
  date={ruleForm.appointmentTime}
  mode={'datetime'}
  //开启modal模式
  isModal={true}
  //可以自定义modal的一些属性
  modalProps={{}}
  modalVisible={selectDateVisible}
  //modalVisible回调函数
  onModalVisibleChange={(visible) => {
    setSelectDateVisible(visible);
  }}
  onPickerCancel={() => {
    setSelectDateVisible(false);
  }}
  onPickerConfirm={(date) => {
    setRuleForm((prevState) => ({
      ...prevState,
      appointmentTime: date,
    }));
    setSelectDateVisible(false);
  }}
  //大部分情况下不用关注date改变时的数据，下面方法可以删除
  onDateChange={() => {}}
/>

开发计划

  • CommonPicker 支持传入对象数组而不是仅仅纯 string/number 数组
  • RegionPicker 添加省市选择模式
  • 所有的 Picker 增加自带 Modal 模式，减少代码量

截图(android/iOS)

datePicker

dateRangePicker

regionPicker