Flutter全屏控制插件flutter_fullscreen的使用

flutter_fullscreen 是一个简单的包，允许在Flutter的所有平台上设置全屏模式。支持的平台包括Web、Linux、macOS、Windows、Android和iOS。

特性

• 支持以下平台的全屏模式：
  • Web
  • Linux
  • macOS
  • Windows
  • Android
  • iOS

开始使用

安装

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

dependencies:
  flutter_fullscreen: ^1.1.0

使用方法

初始化

确保在 main 函数中添加以下两行代码：

import 'package:flutter_fullscreen/flutter_fullscreen.dart';

void main() async {
    // 确保这两行代码被添加到main函数中
    WidgetsFlutterBinding.ensureInitialized();
    await FullScreen.ensureInitialized();

    runApp(const MyApp());
}

设置全屏

你可以通过调用 FullScreen.setFullScreen(true) 来启用全屏模式，或者调用 FullScreen.setFullScreen(false) 来退出全屏模式。

// 启用全屏
FullScreen.setFullScreen(true);

// 退出全屏
FullScreen.setFullScreen(false);

监听全屏状态变化

你可以监听全屏状态的变化，并根据需要更新UI。

import 'package:flutter/material.dart';
import 'package:flutter/src/services/system_chrome.dart';
import 'package:flutter_fullscreen/flutter_fullscreen.dart';

class Page extends StatefulWidget {
  const Page({super.key});

  [@override](/user/override)
  State<Page> createState() => _PageState();
}

class _PageState extends State<Page> with FullScreenListener {
  bool isFullScreen = FullScreen.isFullScreen;

  [@override](/user/override)
  void initState() {
    FullScreen.addListener(this);
    super.initState();
  }

  [@override](/user/override)
  void dispose() {
    FullScreen.removeListener(this);
    super.dispose();
  }

  [@override](/user/override)
  void onFullScreenChanged(bool enabled, SystemUiMode? systemUiMode) {
    setState(() {
      isFullScreen = enabled;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(isFullScreen ? "Fullscreen" : "Not Fullscreen"),
      ),
      body: Center(
        child: IconButton(
          onPressed: () {
            FullScreen.setFullScreen(!isFullScreen);
          },
          icon: Icon(isFullScreen ? Icons.fullscreen_exit : Icons.fullscreen),
        ),
      ),
    );
  }
}

示例Demo

以下是一个完整的示例项目，展示了如何使用 flutter_fullscreen 插件来切换应用的全屏状态。

/*
flutter_fullscreen

Copyright (c) 2024 Jefferey Neuffer <jeff@jefferey.dev>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await FullScreen.ensureInitialized();
  runApp(const App());
}

class App extends StatefulWidget {
  const App({super.key});

  [@override](/user/override)
  State<App> createState() => _AppState();
}

class _AppState extends State<App> with FullScreenListener {
  bool isFullScreen = FullScreen.isFullScreen;

  [@override](/user/override)
  void initState() {
    FullScreen.addListener(this);
    super.initState();
  }

  [@override](/user/override)
  void dispose() {
    FullScreen.removeListener(this);
    super.dispose();
  }

  [@override](/user/override)
  void onFullScreenChanged(bool enabled, SystemUiMode? systemUiMode) {
    setState(() {
      isFullScreen = enabled;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: "Fullscreen Example",
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.green),
        useMaterial3: true,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: const Row(
            children: [
              Text("Fullscreen Example"),
            ],
          ),
        ),
        body: Center(
          child: IconButton(
            onPressed: () {
              FullScreen.setFullScreen(!isFullScreen);
            },
            icon: Icon(isFullScreen ? Icons.fullscreen_exit : Icons.fullscreen),
          ),
        ),
      ),
    );
  }
}