Flutter 側滑欄及城市選擇UI的實現

北斗星_And發表於2019-07-19
FlutterUI

Flutter 側滑欄UI及城市選擇UI的實現

前言

  目前移動市場上很多業務都需要開發Android/IOS兩個端，開發成本比較高. Flutter 在跨端上憑藉著效能優勢關注量，使用度也持續上升.今天給大家分享在去年就寫的一個Flutter版本的側滑欄.

實現

先上一張實現效果圖

Flutter 側滑欄及城市選擇UI的實現

SliderBar 實現

  側邊是一個支援手勢滑動的SliderBar,一個自定義的StatefulWidget.可以觀察到，當手勢在側邊滑動時，中央顯示選中的標籤.

佈局

  一個橫向佈局，裡面放了一個元素。左邊標籤的容器儘量佔滿整個螢幕,右邊固定寬度的一個列表（裡面放需要展示的Label),程式碼如下:

new Row(
      mainAxisSize: MainAxisSize.min,
      crossAxisAlignment: CrossAxisAlignment.start,
      children: <Widget>[
        new Expanded(
            child: new Center(
                child: new Text(selectLabel,
                    style:
                        new TextStyle(color: Colors.orange, fontSize: 40.0)))),
        slide
      ],
    );
複製程式碼

手勢資料處理

   Flutter 提供 手勢處理類 GestureDetector,當手勢開始滑動是更新中央Label顯示，停止或者取消時，取消Label顯示並把對應的資料填充到Label上.

new GestureDetector(
      behavior: HitTestBehavior.translucent,
      child: slideWidget,
      onPanStart: (event) {
        updateLabel(context, event.globalPosition);
      },
      onPanDown: (event) {
        updateLabel(context, event.globalPosition);
      },
      onVerticalDragUpdate: (event) {
        updateLabel(context, event.globalPosition);
      },
      onPanCancel: () {
        setState(() {
          selectLabel = '';
        });
      },
      onVerticalDragEnd: (event) {
        setState(() {
          selectLabel = '';
        });
      },
    );
複製程式碼

遇到的問題以及解決方法：

  • GestureDetector 監聽的手勢很多，當註冊 onVerticalDragUpdate 後，onPanUpdate 不在回撥，解決方法：將onPanUpdate邏輯全部移入onVerticalDragUpdate，
  • onPanUp 未監聽到手勢抬起，解決方法：換用onPanCancel，onVerticalDragEnd方法監聽

updateLabel，獲取具體選中Label的index 公式為 index = dy / widgetHeight * labelList.length,其中dy 為 以控制元件起始點y的位置偏移量,widgetHeight為高度, labelList.length為Label的長度，重新整理資料邏輯如下：

void updateLabel(BuildContext context, Offset globalPosition) {
    var object = globalKey?.currentContext?.findRenderObject();
    var translation = object?.getTransformTo(null)?.getTranslation();

    int index = ((globalPosition.dy - translation.y - topMargin) /
            (globalKey.currentContext.size.height - topMargin) *
            widget.showList.length)
        .toInt();
    if (index < widget.showList.length && index >= 0) {
      setState(() {
        selectLabel = widget.showList[index];
        if (widget.onChangeSelect != null) {
          widget.onChangeSelect(selectLabel);
        }
      });
    }
  }
複製程式碼

其中,獲取控制元件距離螢幕的距離方法為：

  var object = globalKey?.currentContext?.findRenderObject();
  var translation = object?.getTransformTo(null)?.getTranslation();
複製程式碼

城市選擇主介面實現

主佈局

   採用了Flutter 的Stack佈局(非常類似Android FrameLayout),下層是城市選擇頁面資料，上層蓋了一層SliderBar

 new Scaffold(
        appBar: getAppBar(),
        body: new Stack(children: <Widget>[
          getShowContentView(),
          new SlideBar(
              cityListUtils.labelList, onChangeSelect)
        ]));
複製程式碼

UI的下層 使用 ListView.builder 根據item型別返回不同型別的Widget

Widget rightCity = new Container(
       color: AppColor.white,
       padding: EdgeInsets.only(right: 20.0),
       child: new ListView.builder(
           controller: scrollController,
           itemCount: cityListUtils.cityList.length,
           itemBuilder: (listContext, position) {
             var city = cityListUtils.cityList[position];
             if (city is CityModel) {
               return new GestureDetector(
                   behavior: HitTestBehavior.translucent,
                   child: new Container(
                       decoration: new BoxDecoration(
                           border: new Border.all(
                               color: AppColor.bg1, width: 0.5)),
                       height: 48.0,
                       padding: EdgeInsets.only(left: 15.0),
                       alignment: Alignment.centerLeft,
                       child: new Text(city.name)),
                   onTap:selectCity(city));
             } else if (city is CityLabel) {
               return new Container(
                 width: MediaQuery.of(context).size.width,
                 height: 20.0,
                 padding: EdgeInsets.only(left: 15.0),
                 child: new Text(city.keyLabel),
                 color: AppColor.bg1,
               );
             }
           }));
複製程式碼

城市列表資料處理

   城市列表的資料格式如下

{"A":[{"name":"澳門","id":"***","fullWord":"aomen","first":"am","isShow":"true"}]}
複製程式碼

資料解析使用到dart:convert包，呼叫json.decode(jsonStr)解析的資料為map，在將Map轉為具體的實體，實體解析工具推薦使用開源工具自動生成模型檔案 FlutterJsonBeanFactory 得到城市實體的解析Model如下：

import 'dart:convert' show json;

class CityModel {
  String first;
  String fullWord;
  String id;
  String isShow;
  String name;
  bool isSelected = false;

  CityModel.fromParams(
      {this.first, this.fullWord, this.id, this.isShow, this.name});

  factory CityModel(jsonStr) => jsonStr is String
      ? CityModel.fromJson(json.decode(jsonStr))
      : CityModel.fromJson(jsonStr);

  CityModel.fromJson(jsonRes) {
    first = jsonRes['first'];
    fullWord = jsonRes['fullWord'];
    id = jsonRes['id'];
    isShow = jsonRes['isShow'];
    name = jsonRes['name'];
  }

  @override
  String toString() {
    return '{"first": ${first != null?'${json.encode(first)}':'null'},"fullWord": ${fullWord != null?'${json.encode(fullWord)}':'null'},"id": ${id != null?'${json.encode(id)}':'null'},"isShow": ${isShow != null?'${json.encode(isShow)}':'null'},"name": ${name != null?'${json.encode(name)}':'null'}}';
  }
}
複製程式碼

將首字母，城市資料存入CityList裡，並將首字母列表傳入到SliderBar中，記錄字母索引所在的位置

class CityListUtils {
  List cityList = [];
  List<String> labelList = [];
  Map<String, IndexPosition> mapKey = {};

  void parse(var map) {
    if (map is String) {
      map = json.decode(map);
    }
    Map mapList = map['destination'];
    int index = 0, labelPosition = 0;
    mapList.keys.forEach((key) {
      cityList.add(new CityLabel(key));
      labelList.add(key);
      mapKey[key] = new IndexPosition(labelPosition, index);
      labelPosition++;
      index++;
      for (var value in mapList[key]) {
        index++;
        cityList.add(new CityModel(value));
      }
      ;
    });
  }
}
複製程式碼

聯動處理

當滑動SliderBar時，應將城市列表滑到對應的位置，ListView 提供 ScrollController 去為ListView 新增監聽及 Auto scroll ListView， 裡面對應的有兩個方法可以滑動,一個是帶有動畫 animateTo，一個不帶有動畫的滑動 jumpTo，此處使用不帶有的方法，傳遞引數為 滑動的偏移量，實現如下

  OnChangeSelect onChangeSelect = (keyLabel) {
        IndexPosition index = cityListUtils.mapKey[keyLabel];
        scrollController.jumpTo(index.total * 48.0 - index.label * 28.0);
      };
複製程式碼

其中 OnChangeSelect定義為

typedef OnChangeSelect(String keyLabel);
複製程式碼

使用介面回撥的方式將選中的key回傳，並使用CityListUtils裡儲存的mapKey找到對應的首字母索引，計算出ListView應該滑動的偏移量

遇到的問題

計算的偏移量不準，導致滑動不能準確定位到首字母索引上。
原因：item 使用 Container佈局 高度未限制，手動獲取到的高度不準確
解決方法：使用固定的item高度

相關文章