Flutter文本选择控制插件selection_controller的使用

在Flutter开发中，有时我们需要管理一组选项的状态，并能够动态地选择或取消选择某些选项。selection_controller 是一个非常有用的插件，可以帮助我们轻松实现这一功能。

使用场景

假设你有一个 User 类，它包含用户的ID、姓名和年龄：

class User {
	String id;
	String name;
	int age;

	String get ageGroup {
		if (age >= 0 && age <= 12) return 'child';
		if (age >= 12 && age <= 18) return 'teen';
		return 'adult';
	}

	User({
		required this.id;
		required this.name;
		required this.age;
	});
}

同时，你有一组用户作为选项：

List<User> users = [
	User(id: 'u0', name: 'James', age: 24), // 成人
	User(id: 'u1', name: 'Mike', age: 17), // 青少年
	User(id: 'u2', name: 'John', age: 16), // 青少年
	User(id: 'u3', name: 'Harry', age: 28), // 成人
	User(id: 'u4', name: 'Kid', age: 12), // 儿童
];

我们可以使用 SelectionController 来管理这些用户的选中状态。

初始化 SelectionController

首先，我们需要初始化 SelectionController，并传入可选项列表和索引生成器：

SelectionController<User> selection = SelectionController(
	choosableOptions: users,
	indexGetter: (user) => user.id, // 每个选项将通过用户的ID进行索引
);

检查和操作单个选项

你可以使用以下方法来检查和操作某个用户的选中状态：

selection.isSelected('u0'); // 如果詹姆斯被选中，则返回true（通过索引检查）
selection.isSelected(users[0]); // 如果詹姆斯被选中，则返回true（通过实际的User对象检查）

selection.select('u0'); // 选中詹姆斯
selection.select(users[0]); // 同样可以选中詹姆斯

selection.unselect('u1'); // 取消选中迈克
selection.unselect(users[1]); // 同样可以取消选中迈克

selection.toggle('u2'); // 切换约翰的状态
selection.toggle(users[2]); // 同样可以切换约翰的状态

selection.selected; // 获取当前所有选中的用户

检查和操作多个用户

你还可以检查和操作多个用户的状态：

selection.isAllSelected; // 如果所有用户都被选中，则返回true
selection.isNoneSelected; // 如果没有任何用户被选中，则返回true

selection.selectAll(); // 选中所有用户
selection.unselectAll(); // 取消选中所有用户

selection.toggleAll(); // 如果所有用户都已选中，则取消选中；否则，选中所有用户。

设置约束条件

单选模式

如果你只允许一次选择一个用户，可以设置 SelectionMode.single：

SelectionController<User> selection = SelectionController(
	choosableOptions: users,
	indexGetter: (user) => user.id,
	mode: SelectionMode.single, // 应用约束，只允许一次选择一个选项
);

selection.select('u0'); // 选中詹姆斯

selection.isSelected('u0'); // 詹姆斯: true
selection.isSelected('u1'); // 迈克: false
selection.isSelected('u2'); // 约翰: false
...

selection.select('u1'); // 选中迈克。詹姆斯自动取消选中。

selection.isSelected('u0'); // 詹姆斯: false
selection.isSelected('u1'); // 迈克: true
selection.isSelected('u2'); // 约翰: false
...

同一组内选择模式

如果你需要按组进行分组，并且只允许在一个组内选择，可以设置 SelectionMode.sameGroup：

SelectionController<User> selection = SelectionController(
	choosableOptions: users,
	indexGetter: (user) => user.id,
	groupNameGetter: (user) => user.ageGroup, // 从每个选项（用户）生成组名
	mode: SelectionMode.sameGroup, // 应用约束，只允许选中的选项在同一组内（这里按年龄组划分）
);

selection.select('u0'); // 选中詹姆斯

selection.isSelected('u0'); // 詹姆斯: true
selection.isSelected('u1'); // 迈克: false
selection.isSelected('u2'); // 约翰: false
selection.isSelected('u3'); // 哈里: false
...
selection.isGroupSelected('adult'); // true
selection.isGroupSelected('teen'); // false
selection.isGroupSelectedAll('adult'); // false
selection.isGroupSelectedAll('teen'); // false

selection.select('u3'); // 选中哈里。詹姆斯仍然保持选中状态，因为哈里和詹姆斯属于同一组（成人组）。

selection.isSelected('u0'); // 詹姆斯: true
selection.isSelected('u1'); // 迈克: false
selection.isSelected('u2'); // 约翰: false
selection.isSelected('u3'); // 哈里: true
...
selection.isGroupSelected('adult'); // true
selection.isGroupSelected('teen'); // false
selection.isGroupSelectedAll('adult'); // true
selection.isGroupSelectedAll('teen'); // false

selection.select('u2'); // 选中约翰。詹姆斯和哈里会自动取消选中，因为约翰属于青少年组。

selection.isSelected('u0'); // 詹姆斯: false
selection.isSelected('u1'); // 迈克: false
selection.isSelected('u2'); // 约翰: true
selection.isSelected('u3'); // 哈里: false
...
selection.isGroupSelected('adult'); // false
selection.isGroupSelected('teen'); // true
selection.isGroupSelectedAll('adult'); // false
selection.isGroupSelectedAll('teen'); // false

selection.select('u1'); // 选中迈克。约翰仍然保持选中状态，因为迈克和约翰属于同一组（青少年组）。

selection.isSelected('u0'); // 詹姆斯: false
selection.isSelected('u1'); // 迈克: true
selection.isSelected('u2'); // 约翰: true
selection.isSelected('u3'); // 哈里: false
...
selection.isGroupSelected('adult'); // false
selection.isGroupSelected('teen'); // true
selection.isGroupSelectedAll('adult'); // false
selection.isGroupSelectedAll('teen'); // true

多组选择与取消选择

你还可以选择和取消选择多个组：

selection.selectGroup('adult'); // 选中所有成年人。

selection.isGroupSelected('adult'); // true
selection.isGroupSelectedAll('adult'); // true

selection.unselectGroup('adult'); // 取消选中所有成年人。

selection.isGroupSelected('adult'); // false
selection.isGroupSelectedAll('adult'); // false