@tarojs/components/types/PickerView.d.ts

import { ComponentType } from 'react'
import { StandardProps, CommonEventFunction } from './common'

interface PickerViewProps extends StandardProps {

  /** 数组中的数字依次表示 picker-view 内的 picker-view-column 选择的第几项（下标从 0 开始），数字大于 picker-view-column 可选项长度时，选择最后一项。
   * @supported weapp, swan, alipay, tt, rn
   */
  value?: number[]

  /** 设置选择器中间选中框的样式
   * @supported weapp, swan, alipay, tt, rn
   */
  indicatorStyle?: string

  /** 设置选择器中间选中框的类名
   * @supported weapp, swan, alipay
   */
  indicatorClass?: string

  /** 设置蒙层的样式
   * @supported weapp, swan, alipay, tt
   */
  maskStyle?: string

  /** 设置蒙层的类名
   * @supported weapp, swan, alipay
   */
  maskClass?: string

  /** 是否在手指松开时立即触发 change 事件。若不开启则会在滚动动画结束后触发 change 事件。
   * @supported weapp
   * @default false
   */
  immediateChange?: boolean

  /** 当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）
   * @supported weapp, swan, alipay, tt, rn
   */
  onChange?: CommonEventFunction<PickerViewProps.onChangeEventDetail>

  /** 当滚动选择开始时候触发事件
   * @supported weapp
   */
  onPickStart?: CommonEventFunction

  /** 当滚动选择结束时候触发事件
   * @supported weapp
   */
  onPickEnd?: CommonEventFunction
}

declare namespace PickerViewProps {
  interface onChangeEventDetail {
    value: number[]
  }
}

/** 嵌入页面的滚动选择器
 * 其中只可放置 picker-view-column 组件，其它节点不会显示
 * @classification forms
 * @supported weapp, swan, alipay, tt, h5, rn
 * @example_react
 * ```tsx
 * export default class Picks extends Component {
 *
 *   constructor () {
 *     super(...arguments)
 *     const date = new Date()
 *     const years = []
 *     const months = []
 *     const days = []
 *     for (let i = 1990; i <= date.getFullYear(); i++) {
 *       years.push(i)
 *     }
 *     for (let i = 1; i <= 12; i++) {
 *       months.push(i)
 *     }
 *     for (let i = 1; i <= 31; i++) {
 *       days.push(i)
 *     }
 *     this.state = {
 *       years: years,
 *       year: date.getFullYear(),
 *       months: months,
 *       month: 2,
 *       days: days,
 *       day: 2,
 *       value: [9999, 1, 1]
 *     }
 *   }
 *
 *   onChange = e => {
 *     const val = e.detail.value
 *     this.setState({
 *       year: this.state.years[val[0]],
 *       month: this.state.months[val[1]],
 *       day: this.state.days[val[2]],
 *       value: val
 *     })
 *   }
 *
 *   render() {
 *     return (
 *       <View>
 *         <View>{this.state.year}年{this.state.month}月{this.state.day}日</View>
 *         <PickerView indicatorStyle='height: 50px;' style='width: 100%; height: 300px;' value={this.state.value} onChange={this.onChange}>
 *           <PickerViewColumn>
 *             {this.state.years.map(item => {
 *               return (
 *                 <View>{item}年</View>
 *               );
 *             })}
 *           </PickerViewColumn>
 *           <PickerViewColumn>
 *             {this.state.months.map(item => {
 *               return (
 *                 <View>{item}月</View>
 *               )
 *             })}
 *           </PickerViewColumn>
 *           <PickerViewColumn>
 *             {this.state.days.map(item => {
 *               return (
 *                 <View>{item}日</View>
 *               )
 *             })}
 *           </PickerViewColumn>
 *         </PickerView>
 *       </View>
 *     )
 *   }
 * }
 * ```
 * @example_vue
 * ```html
 * <template>
 *   <view class="taro-example">
 *   <view>{{year}}年{{month}}月{{day}}日</view>
 *   <picker-view indicator-style="height: 30px;" style="width: 100%; height: 300px;" :value="value" `@change="onChange">
 *     <picker-view-column>
 *       <view v-for="(item, index) in years" :key="index">{{item}}年</view>
 *     </picker-view-column>
 *     <picker-view-column>
 *       <view v-for="(item, index) in months" :key="index">{{item}}月</view>
 *     </picker-view-column>
 *     <picker-view-column>
 *       <view v-for="(item, index) in days" :key="index">{{item}}日</view>
 *     </picker-view-column>
 *   </picker-view>
 * </view>
 * </template>
 *
 * <script>
 *   export default {
 *     name: "Index",
 *     data() {
 *       const date = new Date()
 *       const years = []
 *       const months = []
 *       const days = []
 *       for (let i = 1990; i <= date.getFullYear(); i++) {
 *         years.push(i)
 *       }
 *       for (let i = 1; i <= 12; i++) {
 *         months.push(i)
 *       }
 *       for (let i = 1; i <= 31; i++) {
 *         days.push(i)
 *       }
 *       return {
 *         years: years,
 *         year: date.getFullYear(),
 *         months: months,
 *         month: 2,
 *         days: days,
 *         day: 2,
 *         value: [3, 1, 1]
 *       }
 *     },
 *
 *     methods: {
 *       onChange: function(e) {
 *         const val = e.detail.value
 *         console.log(val)
 *         this.year = this.years[val[0]]
 *         this.month = this.months[val[1]]
 *         this.day = this.days[val[2]]
 *       }
 *     }
 *   }
 * </script>
 * ```
 * @see https://developers.weixin.qq.com/miniprogram/dev/component/picker-view.html
 */
declare const PickerView: ComponentType<PickerViewProps>

export { PickerView, PickerViewProps }