Flutter側邊欄控件-SideBar

時間  2019-11-07
標籤 flutter 側邊欄 控件 sidebar 简体版
原文   原文鏈接

前言

SideBar是APP開發當中常見的功能之一，多用於索引列表，如城市選擇，分類等。在優化OpenGit趨勢列表時，因爲在選擇語言時須要用到這樣的控件，嘗試開發了這個控件，效果以下圖所示git

準備

完成SideBar須要向外提供如下參數github

  1. SideBar寬以及每一個letter的高度；
  2. 默認背景色和文本顏色；
  3. 按下時的背景色和文本顏色；
  4. 當前選中letter的回調；
  5. 索引列表；

選中letter的回掉函數以下所示canvas

typedef OnTouchingLetterChanged = void Function(String letter);
複製代碼

索引列表數據以下面代碼所示api

const List<String> A_Z_LIST = const [
  "A",
  "B",
  "C",
  "D",
  "E",
  "F",
  "G",
  "H",
  "I",
  "J",
  "K",
  "L",
  "M",
  "N",
  "O",
  "P",
  "Q",
  "R",
  "S",
  "T",
  "U",
  "V",
  "W",
  "X",
  "Y",
  "Z",
  "#"
];
複製代碼

當按下SideBar時須要刷新UI，因此SideBar須要繼承StatefulWidget，構造函數以下所示ide

class SideBar extends StatefulWidget {
  SideBar({
    Key key,
    @required this.onTouch,
    this.width = 30,
    this.letterHeight = 16,
    this.color = Colors.transparent,
    this.textStyle = const TextStyle(
      fontSize: 12.0,
      color: Color(YZColors.subTextColor),
    ),
    this.touchDownColor = const Color(0x40E0E0E0),
    this.touchDownTextStyle = const TextStyle(
      fontSize: 12.0,
      color: Color(YZColors.mainTextColor),
    ),
  });

  final int width;

  final int letterHeight;

  final Color color;

  final Color touchDownColor;

  final TextStyle textStyle;

  final TextStyle touchDownTextStyle;

  final OnTouchingLetterChanged onTouch;
}
複製代碼

封裝SideBar

在_SideBarState中，須要經過touch的狀態來判斷背景色的展現，相關代碼以下所示函數

class _SideBarState extends State<SideBar> {
  bool _isTouchDown = false;

  @override
  Widget build(BuildContext context) {
    return Container(
      alignment: Alignment.center,
      color: _isTouchDown ? widget.touchDownColor : widget.color,
      width: widget.width.toDouble(),
      child: _SlideItemBar(
        letterWidth: widget.width,
        letterHeight: widget.letterHeight,
        textStyle: _isTouchDown ? widget.touchDownTextStyle : widget.textStyle,
        onTouch: (letter) {
          if (widget.onTouch != null) {
            setState(() {
              _isTouchDown = !TextUtil.isEmpty(letter);
            });
            widget.onTouch(letter);
          }
        },
      ),
    );
  }
}
複製代碼

上面代碼，主要部分經過_SlideItemBar的letter狀態的改變來刷新Container的color，下面看下_SlideItemBar的實現，相關代碼以下所示優化

class _SlideItemBar extends StatefulWidget {
  final int letterWidth;

  final int letterHeight;

  final TextStyle textStyle;

  final OnTouchingLetterChanged onTouch;

  _SlideItemBar(
      {Key key,
      @required this.onTouch,
      this.letterWidth = 30,
      this.letterHeight = 16,
      this.textStyle})
      : assert(onTouch != null),
        super(key: key);

  @override
  _SlideItemBarState createState() {
    return _SlideItemBarState();
  }
}
複製代碼

上文代碼，沒有作過多的操做，只是定義了幾個變量，詳細的操做在_SlideItemBarState。 在_SlideItemBarState中，須要知道每一個letter在垂直方向上的偏移高度，以下面代碼所示動畫

void _init() {
    _letterPositionList.clear();
    _letterPositionList.add(0);
    int tempHeight = 0;
    A_Z_LIST?.forEach((value) {
      tempHeight = tempHeight + widget.letterHeight;
      _letterPositionList.add(tempHeight);
    });
}
複製代碼

填充每一個letter widget，並設置固定寬高，代碼以下所示ui

List<Widget> children = List();
A_Z_LIST.forEach((v) {
    children.add(SizedBox(
        width: widget.letterWidth.toDouble(),
        height: widget.letterHeight.toDouble(),
        child: Text(v, textAlign: TextAlign.center, style: _style),
    ));
});
複製代碼

在滑動SideBar過程當中，須要檢測手勢事件，代碼以下所示this

GestureDetector(
      onVerticalDragDown: (DragDownDetails details) {
        //計算索引列表距離頂部的距離
        if (_widgetTop == -1) {
          RenderBox box = context.findRenderObject();
          Offset topLeftPosition = box.localToGlobal(Offset.zero);
          _widgetTop = topLeftPosition.dy.toInt();
        }
        //獲取touch點在索引列表的偏移值
        int offset = details.globalPosition.dy.toInt() - _widgetTop;
        int index = _getIndex(offset);
        //判斷索引是否在列表中，若是存在，則通知上層更新數據
        if (index != -1) {
          _lastIndex = index;
          _triggerTouchEvent(A_Z_LIST[index]);
        }
      },
      onVerticalDragUpdate: (DragUpdateDetails details) {
        //獲取touch點在索引列表的偏移值
        int offset = details.globalPosition.dy.toInt() - _widgetTop;
        int index = _getIndex(offset);
        //而且先後兩次的是否一致，若是不一致，則通知上層更新數據
        if (index != -1 && _lastIndex != index) {
          _lastIndex = index;
          _triggerTouchEvent(A_Z_LIST[index]);
        }
      },
      onVerticalDragEnd: (DragEndDetails details) {
        _lastIndex = -1;
        _triggerTouchEvent('');
      },
      onTapUp: (TapUpDetails details) {
        _lastIndex = -1;
        _triggerTouchEvent('');
      },
      //填充UI
      child: Column(
        mainAxisSize: MainAxisSize.min,
        children: children,
      ),
    )
複製代碼

上文代碼，在onVerticalDragDown事件時，首次獲取索引距離頂部的高度，並經過touch點的y座標獲取到touch點在偏移值，並經過該值找到目前touch的索引，記錄該狀態，並通知上層ui；在onVerticalDragUpdate事件時，獲取索引跟onVerticalDragDown一致，只是多了出重的操做。而onVerticalDragEnd和onTapUp表明touch事件的結束。到此，能夠獲取到觸摸SideBar時，回掉的letter數據。

展現letter

SideBar一般展現在ListView的上面，父容器咱們採用Stack，以下面代碼所示

@override
Widget build(BuildContext context) {
    super.build(context);

    return Scaffold(
      body: Stack(
        children: <Widget>[
          _buildSideBar(context),
          _buildLetterTips(),
        ],
      ),
    );
}

Widget _buildSideBar(BuildContext context) {
    return Offstage(
      offstage: widget.offsetBuilder == null,
      child: Align(
        alignment: Alignment.centerRight,
        child: SideBar(
          onTouch: (letter) {
            setState(() {
              _letter = letter;
            });
          },
        ),
      ),
    );
}

Widget _buildLetterTips() {
    return Offstage(
      offstage: TextUtil.isEmpty(_letter),
      child: Align(
        alignment: Alignment.center,
        child: Container(
          alignment: Alignment.center,
          width: 65.0,
          height: 65.0,
          color: Color(0x40000000),
          child: Text(
            TextUtil.isEmpty(_letter) ? '' : _letter,
            style: YZConstant.largeLargeTextWhite,
          ),
        ),
      ),
    );
}
複製代碼

當接收到letter發生改變時，會經過setState刷新ui，當_letter不爲空時，就會展現當前letter的提示。

滾動ListView

滾動ListView目前只發現兩種方法，以下面代碼所示

//帶動畫的滾動
scrollController.animateTo(double offset);
//不帶動畫的滾動
scrollController.jumpTo(double offset);
複製代碼

因爲上述兩種方法都須要知道滾動的具體位置，因此須要知道ListView列表的每一個item相對於屏幕頂部的偏移量，因此高度必須是固定的。

獲取語言列表數據

調用接口github-trending-api.now.sh/languages，並封裝bean對象，以下面代碼所示

List<TrendingLanguageBean> getTrendingLanguageBeanList(List<dynamic> list) {
  List<TrendingLanguageBean> result = [];
  list.forEach((item) {
    result.add(TrendingLanguageBean.fromJson(item));
  });
  return result;
}

@JsonSerializable()
class TrendingLanguageBean extends Object {
  @JsonKey(name: 'id')
  String id;

  @JsonKey(name: 'name')
  String name;

  String letter;

  bool isShowLetter;

  TrendingLanguageBean(this.id, this.name, {this.letter});

  factory TrendingLanguageBean.fromJson(Map<String, dynamic> srcJson) =>
      _$TrendingLanguageBeanFromJson(srcJson);

  Map<String, dynamic> toJson() => _$TrendingLanguageBeanToJson(this);
}
複製代碼

對獲取到的數據進行排序，以下面代碼所示

void _sortListByLetter(List<TrendingLanguageBean> list) {
    if (list == null || list.isEmpty) return;
    list.sort(
      (a, b) {
        if (a.letter == "@" || b.letter == "#") {
          return -1;
        } else if (a.letter == "#" || b.letter == "@") {
          return 1;
        } else {
          return a.letter.compareTo(b.letter);
        }
      },
    );
}
複製代碼

經過語言對應的首字母，設置其展現狀態，以下面代碼所示

void _setShowLetter(List<TrendingLanguageBean> list) {
    if (list != null && list.isNotEmpty) {
      String tempLetter;
      for (int i = 0, length = list.length; i < length; i++) {
        TrendingLanguageBean bean = list[i];
        String letter = bean.letter;
        if (tempLetter != letter) {
          tempLetter = letter;
          bean.isShowLetter = true;
        } else {
          bean.isShowLetter = false;
        }
      }
    }
}
複製代碼

列表數據已經準備完畢，初始化單個item的高度，以下面代碼所示

double getLetterHeight() => 48.0;

double getItemHeight() => 56.0;
複製代碼

而後進一步計算每一個letter在ListView中所處的高度，以下面代碼所示

void _initListOffset(List<TrendingLanguageBean> list) {
    _letterOffsetMap.clear();
    double offset = 0;
    String letter;
    list?.forEach((v) {
      if (letter != v.letter) {
        letter = v.letter;
        _letterOffsetMap.putIfAbsent(letter, () => offset);
        offset = offset + getLetterHeight() + getItemHeight();
      } else {
        offset = offset + getItemHeight();
      }
    });
}
複製代碼

經過letter獲取滾動的指定高度，以下面代碼所示

double getOffset(String letter) => _letterOffsetMap[letter];
複製代碼

當獲取到高度後，完成ListView的滾動，以下面代碼所示

if (offset != null) {
    _scrollController.jumpTo(offset.clamp(
            .0, _scrollController.position.maxScrollExtent));
}
複製代碼

使用CustomPainter封裝SideBar

上文SideBar的封裝，用SizeBox封裝每一個letter，而後存放在List<Widget>列表中，最後填充Column，以下面代碼所示

List<Widget> children = List();
A_Z_LIST.forEach((v) {
    children.add(SizedBox(
        width: widget.letterWidth.toDouble(),
        height: widget.letterHeight.toDouble(),
        child: Text(v, textAlign: TextAlign.center, style: _style),
    ));
});

child: Column(
    mainAxisSize: MainAxisSize.min,
    children: children,
),
複製代碼

下面用CustomPainter實現SideBar，以下面代碼所示

class _SideBarPainter extends CustomPainter {
  final TextStyle textStyle;
  final int width;
  final int height;

  TextPainter _textPainter;

  _SideBarPainter(this.textStyle, this.width, this.height) {
    _textPainter = new TextPainter(
      textAlign: TextAlign.center,
      textDirection: TextDirection.ltr,
    );
  }

  @override
  void paint(Canvas canvas, Size size) {
    int length = A_Z_LIST.length;

    for (int i = 0; i < length; i++) {
      _textPainter.text = new TextSpan(
        text: A_Z_LIST[i],
        style: textStyle,
      );

      _textPainter.layout();
      _textPainter.paint(
          canvas, Offset(width.toDouble() / 2, i * height.toDouble()));
    }
  }

  @override
  bool shouldRepaint(CustomPainter oldDelegate) {
    return true;
  }
}
複製代碼

使用_SideBarPainter以下面代碼所示

child: CustomPaint(
    painter: _SideBarPainter(
        widget.textStyle, widget.width, widget.letterHeight),
    size: Size(widget.width.toDouble(), _height),
),
複製代碼

項目源碼

OpenGit_Fultter

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程