Flutter阅读功能插件flutter_read的使用

Flutter阅读功能插件flutter_read的使用

Flutter Novel Reader 是一个多平台的小说阅读应用，支持流畅滚动、多样化的文本样式和个人化设置。它还支持章节评价和互动功能，并且易于安装和使用。此外，该应用可以实时监控阅读进度，并且是基于 LGPLv3 许可发布的。

功能

• 支持本地小说阅读
• 实现了覆盖式平滑滚动
• 提供多样化的文本样式设置，包括颜色、大小和字体
• 允许自由调整行间距和字母间距以获得个性化的阅读体验
• 可以设置封面页和章节结束页，包括章节评分和互动页面等功能

平台支持

安装

1. 将此插件添加到您的 Flutter 项目的 pubspec.yaml 文件中：

   dependencies:
      flutter_read: "^1.0.3"
   

2. 导入必要的库：

   import 'package:flutter_read/flutter_read.dart';
   

使用

1. 声明一个小说控制器变量：

   final ReadController readController = ReadController.create();
   

2. 在界面中添加小说组件：

   [@override](/user/override)            
   Widget build(BuildContext context) {
     return MaterialApp(
       home: ReadView(readController: readController),
     );
   }
   

3. 打开小说：

   final ByteData byteData = await rootBundle.load("assets/斗罗大陆.txt");
   BookSource source = ByteDataSource(byteData, "《斗罗大陆》", isSplit: true);
   int state = await readController.startReadBook(source);
   

4. 监听小说阅读进度：

   StreamSubscription subscription =
   readController.onPageIndexChanged.listen((progress) {
     // 处理页面索引变化的逻辑
   });
      
   // 当页面退出时取消订阅
   [@override](/user/override)
   void dispose() {
     subscription.cancel();
     super.dispose();
   }
   

示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 flutter_read 插件：

import 'dart:async';

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

import 'data.dart';

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

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final ReadController bookController = ReadController.create(
    loadingWidget: const Center(
      child: CircularProgressIndicator(),
    ),
    enableVerticalDrag: true
  );

  [@override](/user/override)
  void initState() {
    start();
    super.initState();
  }

  Future<void> start() async {
    DateTime now = DateTime.now();
    BookSource source = StringSource(bookData, "《斗罗大陆》", isSplit: true);
    int state = await bookController.startReadBook(source);
    Duration duration = DateTime.now().difference(now);
    debugPrint("wwww,加载小说耗时,$duration,$state");
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        backgroundColor: const Color(0xFFE2E8DC),
        body: SafeArea(
          child: ReadView(
            readController: bookController,
            onMenu: () {
              print("wwww,拉起菜单");
            },
          ),
        ),
      ),
    );
  }
}