设置联系人列表页面

联系人列表 ContactsView 是 ChatUIKit 提供的主要组件, 用于展示用户列表，包括联系人搜索，添加联系人，好友申请列表入口，群组列表入口，联系人列表。

昵称在中文或者英文的情况下可以实现按首字母分类。

ContactsView 可以直接使用，也可以通过路由使用。

添加联系人列表

添加会话列表时，只需要将 ContactsView 添加到页面上即可。

@override
Widget build(BuildContext context) {
  return const ContactsView();
}

自定义联系人列表

参数	描述
final ContactListViewController? controller	联系人列表控制器。
final ChatUIKitAppBarModel? appBarModel	自定义消息页面 AppBar。如不设置会使用默认的。
final bool enableAppBar	是否开启 AppBar。默认开启，关闭后将不再显示 AppBar，传入的 AppBar 也不再生效。
final void Function(List<ContactItemModel> data)? onSearchTap	联系人列表搜索点击事件回调。点击后会把当前所有的恋人回调出来，如果不设置会有默认实现。
final bool enableSearchBar	是否显示联系人搜索框，默认为 true。
final List<ChatUIKitListViewMoreItem>? beforeItems	展示在联系人列表前面的 widget，设置后将不再显示好友申请和群组列表的入口。
final List<ChatUIKitListViewMoreItem>? afterItems	展示在联系人列表后面的 widget。
final ChatUIKitContactItemBuilder? itemBuilder	联系人列表 item builder。如果如要自定义显示需要在此处设置。
final void Function(BuildContext context, ContactItemModel model)? onTap	联系人列表 item 点击事件，如果不设置则默认进入联系人详情。
final void Function(BuildContext context, ContactItemModel model)? onLongPress	联系人列表 item 长按事件，无默认实现，如果需要添加长按事件需要在此处设置。
final String? searchHideText	搜索框中默认展示的文字内容。
final Widget? listViewBackground	联系人为空时展示的背景图。如果不设置会有默认实现。
final String? loadErrorMessage	联系人加载失败时现实的文字信息。如果设置会有默认实现。
final String? attributes	扩展参数，会传入到下一个页面。

自定义 AppBar

可通过 enableAppBar 设置是否显示 AppBar，也可通过 appBarModel 自定义 AppBar。

ContactsView(
  appBarModel: ChatUIKitAppBarModel( 
    title: 'Title',
    subtitle: 'Subtitle',
  ),
);

关于 AppBar 的自定义详细描述，参见进阶用法文档。

自定义联系人列表前后的 widget

• beforeItems：展示在联系人列表前面的 widget，设置后将不再显示好友申请和群组列表入口。

• afterItems：展示在联系人列表后面的 widget。

beforeItems 和 afterItems 分别在列表的 header 和 footer 中。

ContactsView(
  beforeItems: const [
    ChatUIKitListViewMoreItem(
      title: 'before',
    )
  ],
  afterItems: const [
    ChatUIKitListViewMoreItem(
      title: 'after',
    )
  ],
);

自定义列表项

可通过 itemBuilder 自定义列表项，model 是 ContactItemModel 对象。返回的 Widget 会替换原有显示，如果返回 null, 则使用默认样式显示。

ContactsView(
  itemBuilder: (context, model) {
    return ListTile(
      title: Text(model.profile.showName),
      leading: CircleAvatar(
        child: Text(model.profile.showName[0].toUpperCase()),
      ),
    );
  },
);

更多

如需获取好友申请数量，参考以下示例代码：

try {
  int newRequestCount = await ChatUIKit.instance.contactRequestCount();
} catch (e) {
  // some error
}