1.2.0 • Published 5 years ago

mobileselect2 v1.2.0

Weekly downloads
3
License
ISC
Repository
github
Last release
5 years ago

A multi-function mobile phone scrolling selector, support single to multi-select, support multi-level cascade, provide custom callback function, provide update function redraw, relocation function, compatible pc drag and so on.

【查看中文文档】

Features

  • A mobile phone select component with native js, do not rely on any library
  • Can be passed to an ordinary array or json array
  • According to the length of the parameters passed, automatically render the corresponding number of columns, support for individual to multiple options
  • Automatic identification is cascading
  • After successful selection, provide a custom callback function callback ()
  • After each gesture sliding, it also provides a callback function transitionEnd ()
  • Provide update () function, pass the other parameters to render again
  • Provide relocation function

Preview

Use mobile phone scan code to preview:

Gif preview:

Image text

Installation

Method1 tag import:

<link rel="stylesheet" type="text/css" href="css/mobileSelect.css">
<script src="js/mobileSelect.js" type="text/javascript"></script>

Method2 npm install:

npm install mobile-select -D

Import in your js file:

import MobileSelect from 'mobile-select'

Getting Started

①Ordinary array format - Non-cascade

<div id="day"></div><!--Don't forget this trigger in your page-->

<script type="text/javascript">
var mobileSelect1 = new MobileSelect({
    trigger: '#day',
    title: '单项选择',
    wheels: [
                {data:['周日','周一','周二','周三','周四','周五','周六']}
            ],
    position:[2] //Initialize positioning
});
</script>

②Json format - Non-cascade

<div id="area"></div>

<script type="text/javascript">
var mobileSelect2 = new MobileSelect({
    trigger: '#area',
    title: '地区选择',
    wheels: [
                {data:[
                    {id:'1',value:'附近'},
                    {id:'2',value:'上城区'},
                    {id:'3',value:'下城区'},
                    {id:'4',value:'江干区'},
                    {id:'5',value:'拱墅区'},
                    {id:'6',value:'西湖区'}
                ]},
                {data:[
                    {id:'1',value:'1000米'},
                    {id:'2',value:'2000米'},
                    {id:'3',value:'3000米'},
                    {id:'4',value:'5000米'},
                    {id:'5',value:'10000米'}
                ]}
            ],
    callback:function(indexArr, data){
        console.log(data); //Returns the selected json data
    }
});
</script>
Example:

Image text

③Json format - Cascade

<div id="area2"></div>

<script type="text/javascript">
  var mobileSelect3 = new MobileSelect({
      trigger: '#area2',
      title: '地区选择-联动',
      wheels: [
                  {data:[
                      {
                          id:'1',
                          value:'附近',
                          childs:[
                              {id:'1',value:'1000米'},
                              {id:'2',value:'2000米'},
                              {id:'3',value:'3000米'},
                              {id:'4',value:'5000米'},
                              {id:'5',value:'10000米'}
                          ]
                      },
                      {id:'2',value:'上城区'},
                      {id:'3',value:'下城区'},
                      {id:'4',value:'江干区'},
                      {id:'5',value:'拱墅区'},
                      {id:'6',value:'西湖区'}
                  ]}
              ],
      position:[0,1],
      callback:function(indexArr, data){
          console.log(data); //Returns the selected json data
      }
  });
  </script>
Example:

Image text

④ajax asynchronous fill data

<!-- ************ Non-cascade Format ************ -->

<div id="trigger4"></div>

<script type="text/javascript">
    var mobileSelect4 = new MobileSelect({
        trigger: '#trigger4',
        title: 'ajax fill data - non-cascade',
        wheels: [
                    {data:[
                        {id:'1',value:'choose area'},
                    ]},
                    {data:[
                        {id:'1',value:'choose distance'},
                    ]}
                ],
        callback:function(indexArr, data){
            console.log(data);
        }
    });

    $.ajax({
        type: "POST",
        url: "xxxx",
        data: {},
        dataType: "json",
        success: function(res){
            //Assume that the obtained res.data.area is:
            // [
            //     {id:'1',value:'area1'},
            //     {id:'2',value:'area2'},
            //     {id:'3',value:'area3'},
            //     {id:'4',value:'area4'}
            // ]

            //Assume that the obtained res.data.distance is:
            // [
            //     {id:'1',value:'200 metres'},
            //     {id:'2',value:'300 metres'},
            //     {id:'3',value:'400 metres'}
            // ]

            mobileSelect4.updateWheel(0, res.data.area); //Update the 0th wheel
            mobileSelect4.updateWheel(1, res.data.distance); //Update the 1th wheel
        }
    });
</script>
</script>




<!-- ************ Cascade Format ************ -->

<div id="trigger4"></div>

<script type="text/javascript">
    var mobileSelect4 = new MobileSelect({
        trigger: '#trigger4',
        title: 'ajax fill data - cascade',
        wheels: [
                    {data:[
                        {
                            id:'1',
                            value:'',
                            childs:[
                                {id:'A1',value:''},
                            ]
                        }
                    ]}
                ],
        callback:function(indexArr, data){
            console.log(data);
        }
    });

    $.ajax({
        type: "POST",
        url: "xxxx",
        data: {},
        dataType: "json",
        success: function(res){
            //Assume that the obtained res.data is:
            // [{
            //     id:'1',
            //     value:'after update',
            //     childs:[
            //         {id:'A1',value:'apple'},
            //         {id:'A2',value:'banana'},
            //         {id:'A3',value:'orange'}
            //     ]
            // }]
            mobileSelect4.updateWheels(res.data);
        }
    });
</script>

⑤How to use in vue-cli

npm install mobile-select -D
<template>
    <div>
        <div id="trigger5">vue-cli-demo</div>
    </div>
</template>

<script>
    import MobileSelect from 'mobile-select'

    export default {
        mounted() {
            var mobileSelect5 = new MobileSelect({
                trigger: "#trigger5",
                title: "vue-cli-demo",
                wheels: [
                    {data: ["周日","周一","周二","周三","周四","周五","周六"]}
                ],
                callback:function(indexArr, data){
                    console.log(data);
                }
            });
        }
    }
</script>

⑥Json format - Data field mapping

<div id="trigger6"></div>

<script type="text/javascript">
    // If your data field is named id, title, children
    // does not match the id, value, childs field name of mobileSelect
    // You can use the keyMap property for field name mapping
    var mobileSelect6 = new MobileSelect({
        trigger: '#trigger6',
        title: 'keyMap',
        wheels: [
                    {data:[
                        {
                            id:'1',
                            title:'A',
                            children:[
                                {id:'A1',title:'A-a'},
                                {id:'A2',title:'A-b'},
                                {id:'A3',title:'A-c'}
                            ]
                        },
                        {
                            id:'1',
                            title:'B',
                            children:[
                                {id:'B1',title:'B-a'},
                                {id:'B2',title:'B-b'},
                                {id:'B3',title:'B-c'}
                            ]
                        },
                    ]}
                ],
        keyMap: {
            id:'id',
            value: 'title',
            childs :'children'
        },
        callback:function(indexArr, data){
            console.log(data);
        }
    });
</script>

Options

OptionDefaultTypeDescription
triggerRequired parameter. No default valueStringThe id/class/tag of the trigger object
wheelsRequired parameter. No default valueArrayThe data displayed on the wheel
callbackfunction(indexArr, data){}functionA callback function after successful selected, return parameter (indexArr, data)
transitionEndfunction(indexArr, data){}functionA callback function that after each gesture sliding, return parameter (indexArr, data)
cancelfunction(indexArr, data){}functionA callback function after cancel selected, return last successful selected parameter (indexArr, data)
onShowfunction(e){}functionA callback when the window is show, return object itself as parameter
onHidefunction(e){}functionA callback when the window is hidden, return object itself as parameter
title''StringComponent title
position0,0,0,…ArrayInitialize positioning
colWidth1,1,2,…Arraycol width setting
connector' 'StringWhen there are multiple wheels, set the connection to connect multiple values, the default value is a space
ensureBtnText'确认'StringThe text content of comfirm button
cancelBtnText'取消'StringThe text content of cancel button
ensureBtnColor'#1e83d3'StringThe text color of the comfirm button
cancelBtnColor'#666666'StringThe text color of the cancel button
titleColor'#000000'StringThe text color of the component title
titleBgColor'#ffffff'StringThe background color of the component title
textColor'#000000'StringThe text color of the wheels
bgColor'#ffffff'StringThe Wheels background color
maskOpacity0.7NumberMask opacity
keyMap{id:'id', value:'value', childs:'childs'}ObjectField name mapping, applies to field names that do not match id, value, childs
triggerDisplayDatatrueBooleanWhen the click is confirmed, the trigger's innerHtml becomes the selected data.( If there are other elements in the trigger, you can set it to false. If you need to display data elsewhere, you can use the data returned by callback to stitch yourself )

Tips: The meaning of the parameters returned in the callback function is as follows

Functions:

FunctionArgumentsDescription
show()no-argumentshow the compontent
hide()no-argumenthide the compontent
setTitle()stringSet the title of the component
locatePosition()sliderIndex, posIndexPass the position array parameter, relocate the position of the wheel
updateWheel()sliderIndex, dataRe-render the specified wheel
updateWheels()dataRe-render the all wheel(Only used in cascading data forma)
getValue()no-argumentGets the value selected by the component

Tips: The function parameters need to be passed as follows

  • SliderIndex represents the index of the wheel to be modified
  • PosIndex represents the location index

The second time how to reshow the selected position?

There is an indexArr parameter in the callback callback function, which is an array that records the currently selected location:
After converting this array into a string, you can save it in a hidden field or otherwise, and pass it to the background.
Next time you open the page,
When the MobileSelect is instantiated, it reads the string, turns it into an array, passes it to position, and completes the initialization position.

Demo of use the function :

<div id="day"></div>

var mySelect = new MobileSelect({
    trigger: '#day',
    wheels: [
                {data:['周日','周一','周二','周三','周四','周五','周六']},
                {data:['08:00','09:00','10:00','11:00','12:00','13:00','14:00']}
            ],
    position:[1,1] //Initialize the positioning of both wheels are selected in the index 1 option
    colWidth: [1, 2] // initialize the col width setting, The number represents the width ratio of each column
});

//----------------------------------------------
//After the basic instantiated, use the functions

mySelect.setTitle('啦啦啦(๑•̀ㅁ•́ฅ)');
// Set the title of the component

mySelect.updateWheel(0,['sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday']);
// Update the 0th wheel of the data,the data from the Chinese week to the English week

mySelect.locatePosition(1,0);
// Reposition the position of the first wheel and change the 0th data of the first wheel to the current selection.
// (The first wheel is the right wheel, the left side of the wheel is the first 0)

Base example → Function after operation

基础实例 功能函数操作后

Project demo:

Use the transitionEnd (), callback (), updateWheel (), locatePosition () functions to do the following:

  • choose the date of the day, not more than today has been too.
  • Select the time to take the car, the car must not exceed the time to take the car (including the date and time).

Image text

Logs

2017-04-20update

As the input tag in the iphone, the cursor will flashing. As well as the input tag open in the iphone6P / iphone7P chrome will appear offset phenomenon. So do not use the input tag, instead by the ordinary div trigger. The value selected will be written in the div trigger‘s innerHTML. It is recommended to use the callback (indexArr, data) function to get the selected value.

2017-07-27bug fixed

Repair the issues raised by li362692680: Cascade selection can not initially locate the secondary selection box. At the same time repair the init function of the entry array parameter length is less than the number of wheels can not move the problem.

2017-07-30bug fixed + update

Repair the issues raised by leohgbs: 1. The update does not take into account the problem that the data is json. 2. After the update, the cached data is not updated, resulting in a callback data source error.

Change the variable name: jsonData → cascadeJsonData Change method name: updateWheels() → reRenderWheels() The updateWheel() method does not change. Add new API: updateWheels(data) is used to update the entire data source in cascading data format.

2017-08-15update

Repair in cascade state, single click failed. Delete the comment after the brace in the js file(In the php environment there will be js code failure situation). Fix ios potential bug. Add API: show() Add API: getValue() Add option style options(Modify the connector / button text / button color / background color and so on): connector ensureBtnText ensureBtnColor cancelBtnText cancelBtnColor titleColor titleBgColor bgColor textColor Supports color formats such as #ff0000 rgba(0,255,255,0.5) orange.

2017-09-07update

Add keyMap function Update README

2017-10-17update

Add cancel callback

2017-12-12update

Remove cancel callback Thanks for ngdly: Add onshow callback Add onhide callback Add show function Add hide function

2018-01-28update

Thanks for aaalog: Modify the method for listening to click events. To fix the click event which will triggered twice the transitionEnd funtion: Remove addListenerLi(), singleClick() internal methods, Click judgment directly in the touchend event.

2018-01-29update

Add maskOpacity option

License

MIT LICENSE

Copyright (c) 2017-present, LIHONG OU(onlyhom)

1.2.0

5 years ago

1.1.0

5 years ago

1.0.0

5 years ago