Flutter标签化列表展示插件labeled_list的使用

Flutter标签化列表展示插件labeled_list的使用

使用说明

labeled_list 是一个实现了列表功能的插件，允许为每个添加到列表中的元素分配一个可选标签。

引入插件

import 'package:labeled_list/labeled_list.dart';

示例代码

LabeledList 的行为与其他 List 类似，但它的值可以通过分配给每个元素的可选标签来设置和检索。

void main() {
  // 创建一个带标签的列表
  final labeledList = LabeledList<String>.of(
    ['a', 'b', 'c'],
    labels: ['one', 'two', 'three'],
  );

  // 打印元素
  print(labeledList[0]); // 输出: a
  print(labeledList['one']); // 输出: a

  // 更改标签对应的值
  labeledList['one'] = 'd';
  print(labeledList['one']); // 输出: d
}

构造函数

LabeledList 具有与 List 相同的构造函数，但 of 和 from 构造函数的行为有所不同。

• LabeledList.of 构造一个新的列表，包含提供的 Iterable 的元素。这应该用于创建不引用提供的 Iterable 的新列表。

void main() {
  final list = <int>[0, 1, 2];
  final labeledList = LabeledList<int>.of(list, labels: ['a', 'b', 'c']);

  list.add(4);

  print(list); // 输出: [0, 1, 2, 3, 4]
  print(labeledList); // 输出: [0, 1, 2, 3]
}

• LabeledList.from 如果提供的 Iterable 不是一个 List，则其行为与 LabeledList.of 构造函数相同。但如果提供的 List，则构造的 LabeledList 将包装提供的 List；因此，对提供的列表所做的任何更改也将影响 LabeledList，因为它引用了提供的 List。

void main() {
  final list = <int>[0, 1, 2];
  final labeledList = LabeledList<int>.from(list, labels: ['a', 'b', 'c']);

  list.add(4);

  print(list); // 输出: [0, 1, 2, 3, 4]
  print(labeledList); // 输出: [0, 1, 2, 3, 4]
}

注意: 提供的 labels 必须包含与构建列表相同的元素数量。未标记的元素应提供 null 值。

// 只有位置为 `1` 的元素被标记。
final labeledList = LabeledList<int>.from([0, 1, 2], labels: [null, 'b', null]);

添加元素

add 和 insert 方法接受一个可选参数 label，用于为新添加的元素分配标签。

void main() {
  final labeledList = LabeledList<int>.from([0, 1, 2], labels: ['a', 'b', 'c']);

  labeledList.add(3, label: 'd');
  print(labeledList['d']); // 输出: 3

  labeledList.insert(0, 4, label: 'e');
  print(labeledList['e']); // 输出: 4
}

addAll 和 insertAll 方法接受一个可选参数 labels，用于为新添加的元素分配标签。

void main() {
  final labeledList = LabeledList<int>.from([0, 1, 2], labels: ['a', 'b', 'c']);
  labeledList.addAll([3, 4, 5], labels: ['d', 'e', 'f']);
  labeledList.insertAll(0, [6, 7, 8], labels: ['g', 'h', 'i']);
}

获取、设置和移除标签

LabeledList 提供了一些方法来处理标签。

• labels 属性返回与列表中元素关联的所有标签的列表。返回的列表将包含列表中的每个元素的一个值。任何未标记的元素都将具有 null 标签。

void main() {
  final list = LabeledList<int>.of([0, 1, 2], labels: ['a', 'b', 'c']);
  print(list.labels); // 输出: ['a', 'b', 'c']
}

// 注意: 返回的列表是底层标签列表的副本，因此对其所做的任何更改都不会影响列表中的标签。

• hasLabel 和 hasLabelAt 方法分别返回 true，如果列表包含与提供的标签关联的元素，或者如果提供的索引处的元素有标签。

void main() {
  final list = LabeledList<int>.of([0, 1, 2], labels: ['a', 'b', null]);

  print(list.hasLabel('a')); // 输出: true
  print(list.hasLabel('c')); // 输出: false

  print(list.hasLabelAt(0)); // 输出: true
  print(list.hasLabelAt(2)); // 输出: false
}

• indexOfLabel 方法返回与提供的标签关联的元素的索引。

void main() {
  final list = LabeledList<int>.of([0, 1, 2], labels: ['a', 'b', 'c']);
  print(list.indexOfLabel('b')); // 输出: 1
}

• getLabel 和 getLabelAt 方法分别返回提供的元素或提供的索引处的元素的标签。

void main() {
  final list = LabeledList<int>.of([0, 1, 2], labels: ['a', 'b', 'c']);
  print(list.getLabel(0)); // 输出: a
  print(list.getLabelAt(0)); // 输出: b
}

• setLabel 和 setLabelAt 方法分别更新提供的元素或提供的索引处的元素的标签。

void main() {
  final list = LabeledList<int>.of([5, 6, 7]);

  list.setLabel(5, 'a');
  print(list['a']); // 输出: 5

  list.setLabelAt(1, 'b');
  print(list['b']); // 输出: 6
}

• removeLabelWhere 方法移除通过提供的测试的所有元素的标签。注意：通过移除标签，其值在底层标签列表中被设置为 null。

void main() {
  final list = LabeledList<int>.of([0, 1, 2], labels: ['a', 'b', 'c']);
  list.removeLabelWhere((element) => element.isEven);
  print(list.labels); // 输出: [null, 'b', null]
}

• removeByLabel 方法从列表中移除与提供的标签关联的元素。

void main() {
  final list = LabeledList<int>.of([0, 1, 2], labels: ['a', 'b', 'c']);
  list.removeByLabel('b');
  print(list); // 输出: [0, 1]
}