# @wines/picker-view

> The picker-view @wines

Latest version **2.0.0** (published 2025-04-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wines/picker-view
pnpm add @wines/picker-view
yarn add @wines/picker-view
bun add @wines/picker-view
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2025-04-01 |
| First published | 2021-04-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=16.0.0 |
| Dependencies | 5 |
| Unpacked size | 46.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | tianyingchun |

## Links

- npm: https://www.npmjs.com/package/@wines/picker-view
- Repository: https://gitlab.itcjf.com/wines/picker-view
- npm.io page: https://npm.io/package/@wines/picker-view

## Dependencies (5)

- [@dimjs/lang](https://npm.io/package/@dimjs/lang.md) ^2.1.1
- [@wines/core](https://npm.io/package/@wines/core.md) 2.0.0
- [@wines/spin](https://npm.io/package/@wines/spin.md) 2.0.0
- [@wines/styles](https://npm.io/package/@wines/styles.md) 2.0.0
- [@wines/picker-helpers](https://npm.io/package/@wines/picker-helpers.md) 2.0.0

## Recent versions

- 2.0.0 (latest) — 2025-04-01
- 2.0.0-next.7 (next) — 2025-04-01
- 2.0.0-next.6 — 2025-03-06
- 2.0.0-next.5 — 2025-03-05
- 2.0.0-next.4 — 2025-03-05
- 2.0.0-next.3 — 2025-03-04
- 2.0.0-next.2 — 2025-02-28
- 2.0.0-next.1 — 2025-02-27
- 2.0.0-next.0 — 2025-02-27
- 1.5.1 — 2023-03-07
- 1.5.0 — 2022-11-22
- 1.4.0 — 2022-02-23
- 1.3.5 — 2021-12-03
- 1.3.4 — 2021-09-26
- 1.3.2 — 2021-09-24
- … 2 more at https://npm.io/package/@wines/picker-view/versions

## README

# `@wines/picker-view` PickerView 单列选择器

# PickerView 单列选择器

嵌入页面的滚动选择器。

## 使用指南

### 在 page.json 中引入组件

```json
{
  "navigationBarTitleText": "PickerView",
  "usingComponents": {
    "wux-picker-view": "@wines/picker-view"
  }
}
```

### 示例

```xml
<view class="page">
	<view class="page__hd">
		<view class="page__title">PickerView</view>
		<view class="page__desc">单列选择器</view>
	</view>
	<view class="page__bd">
		<view class="sub-title">Default</view>
		<wux-picker-view options="{{ options[0] }}" />
		<view class="sub-title">Loading</view>
		<wux-picker-view options="{{ options[0] }}" loading />
		<view class="sub-title">Controlled</view>
		<wux-picker-view
		 value="{{ value }}"
		 controlled
		 options="{{ options[1] }}"
		 bind:valueChange="onValueChange"
		/>
	</view>
</view>

```

```ts
import { PickerViewGetValue } from '@wines/picker-view';
import './index.less';

const seasons = [
  ['王', '马', '蔡'],
  // 云效不支持特殊emojj
  ['撕葱', '粑粑', 'X'],
];

Page({
  data: {
    value: '粑粑',
    options: seasons,
  },
  onValueChange(e) {
    const detail = e.detail as PickerViewGetValue;
    this.setData({ value: detail.value });
    console.log('onValueChange', detail);
  },
});
```

## API

### PickerView props

| 参数               | 类型            | 描述                                            | 默认值                                                   |
| ------------------ | --------------- | ----------------------------------------------- | -------------------------------------------------------- |
| prefixCls          | `string`        | 自定义类名前缀                                  | wux-picker-col                                           |
| defaultValue       | `string`        | 默认值，当 `controlled` 为 `false` 时才生效     | -                                                        |
| value              | `string`        | 当前值，当 `controlled` 为 `true` 时才生效      | -                                                        |
| controlled         | `boolean`       | 是否受控 [说明文档](controlled.md)              | false                                                    |
| itemHeight         | `number`        | 每列子元素的高度                                | 34                                                       |
| itemStyle          | `string,object` | 每列子元素的样式                                | -                                                        |
| indicatorStyle     | `string,object` | 设置选择器中间选中框的样式                      | -                                                        |
| indicatorClass     | `string`        | 设置选择器中间选中框的类名                      | -                                                        |
| maskStyle          | `string,object` | 设置蒙层的样式                                  | -                                                        |
| maskClass          | `string`        | 设置蒙层的类名                                  | -                                                        |
| labelAlign         | `string`        | 设置文本对齐方式，可选值为 right、center、left  | center                                                   |
| loading            | `boolean`       | 是否显示 loading 状态                           | false                                                    |
| defaultFieldNames  | `object`        | 自定义 options 中的 value、label、children 字段 | { label: 'label', value: 'value', children: 'children' } |
| options            | `array`         | 可选项数据源                                    | []                                                       |
| options[].value    | `string`        | 属性值                                          | -                                                        |
| options[].label    | `string`        | 描述                                            | -                                                        |
| options[].children | `array`         | 子选项                                          | []                                                       |
| options[].disabled | `boolean`       | 是否禁用                                        | false                                                    |
| bind:beforeChange  | `function`      | 当滚动选择开始时的回调函数                      | -                                                        |
| bind:valueChange   | `function`      | 每列数据选择变化后的回调函数                    | -                                                        |
| bind:scrollChange  | `function`      | 滚动数据选择变化后的回调函数                    | -                                                        |

### PickerView externalClasses

| 名称                | 描述                   |
| ------------------- | ---------------------- |
| wux-class           | 根节点样式类           |
| wux-mask-class      | 蒙层的类名             |
| wux-indicator-class | 选择器中间选中框的类名 |
| wux-content-class   | 选择器主体内容的类名   |

---
_Source: https://npm.io/package/@wines/picker-view · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
