mand-mobile/components/picker
Shawn Xu f2c2383f4d fix(picker):given a default itemIndex when both efaultIndex & defaultValue are undefined (#130) 2018-07-07 17:40:05 +08:00
..
demo site&example:add default title to examples & update docs 2018-06-21 11:34:49 +08:00
test Initial commit 2018-03-26 16:04:04 +08:00
README.en-US.md correct picker 2018-06-05 11:43:40 +08:00
README.md Feature issue 64/75/77 (#90) 2018-05-29 00:11:05 +08:00
cascade.js Initial commit 2018-03-26 16:04:04 +08:00
component.js Initial commit 2018-03-26 16:04:04 +08:00
index.vue Feature issue 64/75/77 (#90) 2018-05-29 00:11:05 +08:00
picker-column.vue fix(picker):given a default itemIndex when both efaultIndex & defaultValue are undefined (#130) 2018-07-07 17:40:05 +08:00

README.en-US.md

title preview
Picker https://didi.github.io/mand-mobile/examples/#/picker

Scrollable multi-column selector

Import

import { Picker } from 'mand-mobile'

Vue.component(Picker.name, Picker)

Code Examples

API

Picker Props

Props Description Type Default Note
v-model display picker or not Boolean false -
data data source Array<{value, lable, ...}>[] [] -
cols number of columns Number 1 -
default-index indexes of initially selected items in each column Array [] -
invalid-index indexes of disabled items in each column Array [] array of multiple disabled items, such as [[1,2], 2]
is-view inline display in page, otherwise it shows as Popup Boolean false -
is-cascade data in each column is cascaded or not Boolean false see #Appendix for the format of cascaded data
title title of picker String - -
ok-text confirmation text String confirm -
cancel-text cancellation text String cancel -

Picker Methods

refresh(callback, startColumnIndex)

Reinitialized picker, like updating data, default-index or invalid-index

Parameters Description Type
callback initialization completes callback Function
startColumnIndex the starting index of the column to reset, default value is 0 Function
getColumnValue(index): activeItemValue

Get the data of the currently selected item in a column, need to be called after the initialed event is invoked or asynchronously called

Parameters Description Type
index the index of each column Number

Returns

Props Description Type
activeItemValue value of selected item Object: {value, lable, ...}
getColumnValues(): columnsValue

Get values of all selected columns, need to be called after the initialed event is invoked or asynchronously called

Returns

Props Description Type
columnsValue values of all selected columns Array<{value, lable, ...}>
getColumnIndex(index): activeItemIndex

Get the index of the currently selected item in the column, need to be called after the initialed event is invoked or asynchronously called

Parameters Description Type
index the index of column Number

Returns

Props Description Type
activeItemIndex the index of selected item Number
getColumnIndexs(): columnsIndex

Get indexes of all selected columns, need to be called after the initialed event is invoked or asynchronously called

Returns

Props Description Type
columnsIndex indexes of all selected columns Array
setColumnValues(index, values, callback)

Set column data

Parameters Description Type
index the index of each column Number
values data of each column Array<{value, lable, ...}>
callback callback is completed after setting values Function

Picker Events

@initialed()

Initialize picker, callable functions are getColumnIndex, getColumnIndexs, getColumnValue, getColumnValues

@change(columnIndex, itemIndex, value)

Change pickers' selections

Parameters Description Type
columnIndex the index of changed column Number
itemIndex the index of changed item in the column Number
value the value of changed item in the column Object: {value, lable, ...}
@confirm(columnsValue)

Confirm picker's selection (only when is-view is false

Parameters Description Type
columnsValue values of all selected columns Array<{value, lable, ...}>
@cancel()

Cancel picker's selection (only when is-view is false

@show()

Show picker (only when is-view is false

@hide()

Hide picker (only when is-view is false

Appendix

  • The format of non-cascade data source
[
  [
    {
      // Option display text
      "text": "",
      // custom fields
      "value": ""
    },
    // ...
  ],
  // ...
]
  • The format of cascaded data source
[
  [
    {
      // ption display text
      "text": "",
      // data of second column
      "children": [
        {
          "text": "",
          // data of third column
          "children": [
            // ...
          ]
        },
        // ...
      ]
      // custom fields
      "value": ""
    },
    // ...
  ]
]