Flutter空安全展示插件flutter_showcase_nullsafety的使用

Flutter空安全展示插件flutter_showcase_nullsafety的使用

一个简单、快速且易于分享你的Flutter项目或原型的方法。你可以通过网络与世界分享你的项目。

简介

Flutter Showcase 是一个帮助你在线分享Flutter项目的项目。虽然将你的项目构建为网站已经足够了,但这个包旨在增强你的演示。你可以有不同的外观、可操作的链接和社会元数据。

仅在构建Web项目时才会显示Flutter Showcase。编译到其他平台时,你的项目仍会保持原样。

目前只有一个SimpleTemplate模板,但目标是提供多种选项来分享你的项目,让你可以选择最适合你的那一款。

请查看带有@gskennerTeam精美示例的在线演示

入门指南

  1. 安装包

  2. 将你的应用包装在一个Showcase小部件中

    runApp(Showcase(
      title: '我的超赞项目',
      description: '你好,欢迎来到我的超赞Flutter项目!',
      app: MyApp(),
    ));
    
  3. 在Material App中添加frame builder

    MaterialApp(
      ....
      builder: Frame.builder,
      ....
    )
    

    为什么需要这一步?这个builder用于设置新的MediaQuery参数,以适应手机大小。

  4. 运行Flutter build web

  5. 发布Web项目

那么简单吗?是的!!!

继续阅读以了解更多的详细功能。

自定义我的展示

  1. 从Templates类中选择你喜欢的模板。

  2. 添加可操作链接

    Showcase(
      // 添加LinkData.github、LinkData.pub或者创建自定义的LinkData()
      links: [
        LinkData.github(
          'https://github.com/jamesblasco/flutter_showcase'),
        LinkData.pub(
          'https://github.com/jamesblasco/flutter_showcase')
      ],
      // 在Flutter Logo旁边添加你的品牌Logo
      logoLink: LinkData(
          icon: Image.asset('assets/jaime_logo.png',
              fit: BoxFit.fitHeight),
          url: 'https://github.com/jamesblasco')
    )      
    
  3. 创建自定义主题

    Showcase(
      theme : TemplateThemeData(
        brightness: Brightness.dark,
        backgroundColor: Colors.black,
        titleTextStyle: TextStyle(
          fontFamily: 'WorkSans',
          fontWeight: FontWeight.bold,
          color: Colors.white,
          height: 1.1,
          letterSpacing: 5),
        descriptionTextStyle: TextStyle(
            fontFamily: 'WorkSans',
            color: Colors.white70,
            fontWeight: FontWeight.w400,
            letterSpacing: 2),  
        flutterLogoColor: FlutterLogoColor.white,
        frameTheme: FrameThemeData(
          frameColor: Colors.white,
          statusBarBrightness: Brightness.dark,
        ),    
        buttonTheme: ButtonThemeData(
          buttonColor: Colors.white,
          shape:
              RoundedRectangleBorder(borderRadius: BorderRadius.circular(50)),
          textTheme: ButtonTextTheme.accent,
          padding: EdgeInsets.all(16),
        ),
        buttonTextStyle: TextStyle(
            fontFamily: 'WorkSans',
            color: Colors.black,
            fontWeight: FontWeight.bold,
            letterSpacing: 2),
        buttonIconTheme: IconThemeData(color: Colors.black) 
      ),
    )
    

当前包的问题

  • Flutter Web仍然有限制,一些功能不可用,并且性能有时可能会较低。
  • 虽然大多数UI包在Web上可以工作,但有些包可能无法正常工作或不允许编译应用程序。
  • 在Flutter Web应用程序中创建移动框架会使手势的全局位置成为整个屏幕而不是框架化的应用程序的参考,这可能会导致如果你在任何GestureDetector或更高级的小部件中使用globalPosition时出现问题。

自动生成社交媒体标签 - 实验性

注意!此功能仍在实验阶段;它会生成一个新的index.html文件,如果你添加了自己的js脚本(如Firebase),目前它将不起作用。

该项目旨在为你的Flutter项目生成社交媒体标签标题、描述、URL和图像,因此你不必手动操作。

  1. 需要一个WebDriver来截取项目的截图。

    • 对于实验版本,我正在使用ChromeDriver

    GitHub Actions默认安装了ChromeDriver🎉

    • Mac用户使用Homebrew安装:
      brew tap homebrew/cask && brew cask install chromedriver
      
    • 基于Debian的Linux发行版:
      sudo apt-get install chromium-chromedriver
      
    • Windows用户使用Chocolatey安装:
      choco install chromedriver
      
    • 手动安装请参阅这里
  2. pubspec.yaml文件底部添加以下内容

    showcase:
      title: 你的项目名称
      description: 这是你的项目描述
      url: https://showcase-custom-web.com
    
  3. 使用flutter pub run flutter_showcase build而不是flutter build web,这将生成在build/web_showcase文件夹中的Web项目。

完整示例代码

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

import 'apps/apps.dart';
import 'indicator/effects/expanding_dots_effect.dart';
import 'indicator/smooth_page_indicator.dart';

void main() => runApp(const Examples());

class Examples extends StatefulWidget {
  const Examples({Key? key}) : super(key: key);

  [@override](/user/override)
  State<StatefulWidget> createState() => _ExamplesState();
}

class _ExamplesState extends State<Examples> {
  late PageController pageController;

  [@override](/user/override)
  void initState() {
    pageController = PageController(initialPage: 0);
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Directionality(
        textDirection: TextDirection.ltr,
        child: Stack(children: [
          PageView.builder(
              controller: pageController,
              scrollDirection: Axis.vertical,
              itemBuilder: (context, index) {
                if (index > 0 && index <= GskinnerApps.values.length) {
                  final app = GskinnerApps.values[index - 1];
                  return app.showcase;
                } else {
                  return Showcase(
                      title: 'Flutter Showcase',
                      app: MyApp(pageController: pageController),
                      description:
                          '''
分享你的Flutter项目给全世界
                          ''',
                      template: SimpleTemplate(reverse: false),
                      theme: TemplateThemeData(
                          backgroundColor: Colors.grey[100],
                          titleTextStyle:
                              const TextStyle(fontWeight: FontWeight.w700),
                          descriptionTextStyle: const TextStyle(
                              fontSize: 24,
                              height: 1.2,
                              fontWeight: FontWeight.w200)),
                      links: [
                        LinkData.github(
                            'https://github.com/jamesblasco/flutter_showcase'),
                        LinkData.pub(
                            'https://github.com/jamesblasco/flutter_showcase')
                      ],
                      logoLink: LinkData(
                          icon: Image.asset('assets/jaime_logo.png',
                              fit: BoxFit.fitHeight),
                          url: 'https://github.com/jamesblasco'));
                }
              },
              itemCount: 1 + GskinnerApps.values.length),
          Align(
              alignment: Alignment.centerRight,
              child: Padding(
                  padding: const EdgeInsets.all(20),
                  child: SmoothPageIndicator(
                      controller: pageController,
                      count: 1 + GskinnerApps.values.length,
                      effect: ExpandingDotsEffect(
                          radius: 14,
                          dotHeight: 10,
                          dotWidth: 10,
                          dotColor: Colors.black12,
                          activeDotColor: Colors.black87))))
        ]));
  }
}

class MyApp extends StatelessWidget {
  final PageController? pageController;
  const MyApp({Key? key, this.pageController}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
        title: 'Flutter Showcase',
        builder: (context, child) =>
            FrameBuilder(app: child, builder: Frame.builder),
        debugShowCheckedModeBanner: false,
        theme: ThemeData(accentColor: Colors.black, primaryColor: Colors.white),
        home: MyHomePage(title: '你的应用', pageController: pageController));
  }
}

class MyHomePage extends StatefulWidget {
  final PageController? pageController;
  const MyHomePage({Key? key, this.title, this.pageController})
      : super(key: key);

  final String? title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
        body: Center(
            child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: <Widget>[
          Text('在这里添加你的应用',
              style: Theme.of(context)
                  .textTheme
                  .headline4!
                  .copyWith(color: Colors.black87)),
          const SizedBox(height: 8),
          const Text('使你的展示项目互动',
              style: TextStyle(fontSize: 20)),
          const SizedBox(height: 200),
          const Text('向下滚动\n探索一些示例',
              style: TextStyle(fontSize: 20), textAlign: TextAlign.center),
          const SizedBox(height: 20),
          FloatingActionButton(
              onPressed: () => widget.pageController?.animateToPage(1,
                  duration: const Duration(seconds: 1),
                  curve: Curves.easeInOutQuart),
              tooltip: '滚动',
              child: const Icon(Icons.arrow_downward))
        ])));
  }
}

更多关于Flutter空安全展示插件flutter_showcase_nullsafety的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter空安全展示插件flutter_showcase_nullsafety的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


flutter_showcase_nullsafety 是一个用于在 Flutter 应用中展示空安全特性的插件。它帮助开发者理解和展示空安全在 Flutter 中的使用方式。以下是如何使用 flutter_showcase_nullsafety 插件的步骤:

1. 添加依赖

首先,你需要在 pubspec.yaml 文件中添加 flutter_showcase_nullsafety 插件的依赖。

dependencies:
  flutter:
    sdk: flutter
  flutter_showcase_nullsafety: ^1.0.0

然后,运行 flutter pub get 来获取依赖。

2. 导入插件

在你的 Dart 文件中导入 flutter_showcase_nullsafety 插件。

import 'package:flutter_showcase_nullsafety/flutter_showcase_nullsafety.dart';

3. 使用插件

你可以使用 ShowcaseNullSafety 小部件来展示空安全的特性。以下是一个简单的示例:

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Showcase Null Safety',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: ShowcaseNullSafety(),
    );
  }
}

4. 展示空安全特性

ShowcaseNullSafety 小部件会展示一些示例,帮助开发者理解空安全在 Flutter 中的使用。例如:

  • 非空类型:展示如何声明非空类型的变量。
  • 可空类型:展示如何声明可空类型的变量。
  • 空断言操作符:展示如何使用 ! 操作符来断言变量不为空。
  • 空合并操作符:展示如何使用 ?? 操作符来提供默认值。

5. 运行应用

运行你的 Flutter 应用,你将看到一个界面,展示空安全的各种特性。

flutter run

6. 自定义展示

你可以根据需要自定义 ShowcaseNullSafety 小部件的内容,以更好地展示你的应用中的空安全特性。

示例代码

以下是一个完整的示例代码,展示如何使用 flutter_showcase_nullsafety 插件:

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Showcase Null Safety',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Showcase Null Safety'),
        ),
        body: ShowcaseNullSafety(),
      ),
    );
  }
}
回到顶部