Flutter获取GitHub趋势项目插件github_trending的使用

Flutter获取GitHub趋势项目插件github_trending的使用

github_trending 是一个用于通过 github-trending-api 获取 GitHub 趋势项目的 Dart 库。

安装

在你的 pubspec.yaml 文件中添加 github_trending 作为依赖：

dependencies:
  github_trending: ^版本号

然后运行 flutter pub get 来安装该包。

使用

以下是一个完整的示例，展示了如何使用 github_trending 插件来获取 GitHub 趋势项目。

示例代码

import 'package:flutter/material.dart';
import 'package:github_trending/github_trending.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('GitHub Trending'),
        ),
        body: Center(
          child: FutureBuilder(
            future: getTrendingRepositories(),
            builder: (context, snapshot) {
              if (snapshot.connectionState == ConnectionState.waiting) {
                return CircularProgressIndicator();
              } else if (snapshot.hasError) {
                return Text('Error: ${snapshot.error}');
              } else {
                var repos = snapshot.data;
                return ListView.builder(
                  itemCount: repos.length,
                  itemBuilder: (context, index) {
                    return ListTile(
                      title: Text(repos[index].name),
                      subtitle: Text(repos[index].description ?? 'No description'),
                      trailing: Text(repos[index].language ?? 'Unknown'),
                    );
                  },
                );
              }
            },
          ),
        ),
      ),
    );
  }

  Future<List<TrendingRepository>> getTrendingRepositories() async {
    final trending = GithubTrending();

    // 获取趋势仓库
    var repos = await trending.getTrendingRepositories();
    return repos;
  }
}

说明

1. 导入必要的库：

   import 'package:flutter/material.dart';
   import 'package:github_trending/github_trending.dart';
   

2. 创建一个 Flutter 应用程序：

   void main() {
     runApp(MyApp());
   }
   

3. 定义 MyApp 类：

   class MyApp extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return MaterialApp(
         home: Scaffold(
           appBar: AppBar(
             title: Text('GitHub Trending'),
           ),
           body: Center(
             child: FutureBuilder(
               future: getTrendingRepositories(),
               builder: (context, snapshot) {
                 if (snapshot.connectionState == ConnectionState.waiting) {
                   return CircularProgressIndicator();
                 } else if (snapshot.hasError) {
                   return Text('Error: ${snapshot.error}');
                 } else {
                   var repos = snapshot.data;
                   return ListView.builder(
                     itemCount: repos.length,
                     itemBuilder: (context, index) {
                       return ListTile(
                         title: Text(repos[index].name),
                         subtitle: Text(repos[index].description ?? 'No description'),
                         trailing: Text(repos[index].language ?? 'Unknown'),
                       );
                     },
                   );
                 }
               },
             ),
           ),
         ),
       );
     }
   }
   

4. 定义 getTrendingRepositories 函数：

   Future<List<TrendingRepository>> getTrendingRepositories() async {
     final trending = GithubTrending();
   
     // 获取趋势仓库
     var repos = await trending.getTrendingRepositories();
     return repos;
   }