Flutter用户动态展示插件user_feed的使用

user_feed 是一个开源项目，它是 Savannah Informatics Limited 提供的众多共享库之一。

user_feed 是为 BeWell-Consumer 和 SladeAdvantage 开发的一个共享库，负责渲染和刷新用户动态及互动。

安装说明

通过依赖项安装此包。

运行以下命令：

• 使用 Flutter:

flutter pub add user_feed

这将在您的包的 pubspec.yaml 文件中添加如下行（并运行隐式的 dart pub get）：

dependencies:
  user_feed: ^0.2.4

另外，您的编辑器可能支持 flutter pub get。请查阅您的编辑器文档以了解更多信息。

最后，导入该库：

import 'package:user_feed/user_feed.dart';

使用方法

请查看提供的 示例 来学习如何使用该包。

Dart & Flutter 版本

• Dart 2: >= 2.14
• Flutter: >= 2.0.0

开发与贡献

首先，感谢您花时间贡献！

请务必查看详细说明，了解如何为该项目做贡献 此处，并阅读我们的 行为准则。

GPG 签名： 作为贡献者，您需要签署您的提交。详情请参阅 此处。

许可证

此库遵循 MIT 许可证，可以在 LICENSE 文件中找到。

示例代码

以下是 main.dart 的完整示例代码：

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:misc_utilities/responsive_widget.dart';
import 'package:user_feed/user_feed.dart';

/// 一个包装器，处理获取用户的动态，并在加载状态时切换到闪烁动画，以向用户提供视觉反馈
class FeedComponentWrapper extends StatefulWidget {
  [@override](/user/override)
  _FeedComponentWrapperState createState() => _FeedComponentWrapperState();
}

class _FeedComponentWrapperState extends State<FeedComponentWrapper> {
  late Stream<dynamic> _feedStream;
  late StreamController<Object> _feedStreamController;

  [@override](/user/override)
  void initState() {
    super.initState();
    _feedStreamController = StreamController<Object>.broadcast();
    _feedStream = _feedStreamController.stream;

    WidgetsBinding.instance.addPostFrameCallback((Duration timeStamp) {
      /// 调用函数来获取用户的动态
      // fetchUserFeed();
    });
  }

  [@override](/user/override)
  void dispose() {
    _feedStreamController.close();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return StreamBuilder<dynamic>(
      stream: _feedStream,
      builder: (BuildContext context, AsyncSnapshot<dynamic> snapshot) {
        /// 在数据展示前显示动态加载闪烁效果
        if (snapshot.data is Map<String, dynamic> &&
            snapshot.data['data'] != null &&
            snapshot.data['data']['loading'] != null &&
            snapshot.data['data']['loading'] == true) {
          return const FeedLoadingShimmer(
            feedItemShimmerPadding: 0,
            flavor: Flavour.PRO,
            globalActionShimmerHorizontalPadding: 0,
            nudgeShimmerPadding: 0,
          );
        }

        /// 错误检查
        if (snapshot.hasError) {
          final Map<String, dynamic>? error = snapshot.error as Map<String, dynamic>?;

          /// 检查错误是否为超时错误，并返回适当的组件
          if (error!['error'] == 'timeout') {
            return Center(
                child: Container(
                    // 添加您的超时错误组件
                    ));
          }

          // 其他类型的错误但不是超时错误
          return Container(
              // 添加您的超时错误组件
              );
        }
        if (snapshot.hasData) {
          final FeedResponsePayload payload = FeedResponsePayload.fromJson(
              snapshot.data as Map<String, dynamic>);

          return FeedComponent(
            userFeed: payload,
            flavour: Flavour.PRO,
            profileProgress: '100',
            setupComplete: true,
            isSmallScreen: ResponsiveWidget.isSmallScreen(context),
            feedContentCallbacks: getFeedActionCallbacks(context: context),
          );
        }

        return const FeedLoadingShimmer(
          feedItemShimmerPadding: 0,
          flavor: Flavour.PRO,
          globalActionShimmerHorizontalPadding: 0,
          nudgeShimmerPadding: 0,
        );
      },
    );
  }
}

Map<String, Function> getFeedActionCallbacks({required BuildContext context}) {
  return <String, Function>{
    kCompleteProfile: () {
      Navigator.of(context, rootNavigator: true)
          .pushNamed('/completeProfileRoute');
    },
  };
}