org_flutter

org_flutter 是一个用于在 Flutter 应用中显示 Org Mode 文档的插件。Org Mode 是一种文本标记语言，常用于编写结构化文档。

使用方法

基本使用

最简单的显示 Org Mode 文档的方法是使用 Org 小部件：

import 'package:org_flutter/org_flutter.dart';

class MyOrgViewWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Org('''* TODO [#A] foo bar
baz buzz''');
  }
}

富文本

使用 Org 标记创建富文本等效小部件：

OrgText('*This* is a /rich/ text label ([[https://example.com][details]])')

高级使用

对于更高级的用法，例如指定链接处理，可以结合使用 OrgController 和 OrgRootWidget：

import 'package:org_flutter/org_flutter.dart';

Widget build(BuildContext context) {
  final doc = OrgDocument.parse(
    rawOrgModeDocString,
    interpretEmbeddedSettings: true, // 解释嵌入设置
  );
  return OrgController(
    root: doc,
    child: OrgLocator( // 启用跳转功能，如脚注跳转
      child: OrgRootWidget(
        style: myTextStyle,
        onLinkTap: launch, // 使用 url_launcher 包中的 launch 函数
        child: OrgDocumentWidget(doc),
      ),
    ),
  );
}

您可以在更高层次的小部件树中放置 OrgController 并通过 OrgController.of(context) 访问它来动态控制显示文档的各种属性：

IconButton(
  icon: const Icon(Icons.repeat),
  onPressed: OrgController.of(context).cycleVisibility,
);

文本选择

默认情况下，Org Mode 文本不可选，但可以通过将其包裹在 SelectionArea 中使其可选：

SelectionArea(child: Org('Your Org content here'))

示例 Demo

以下是一个完整的示例应用程序，展示如何在 Flutter 应用中使用 org_flutter 插件：

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

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'org_flutter',
      restorationScopeId: 'example_root',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  const MyHomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return DefaultTabController(
      length: 2,
      child: Scaffold(
        appBar: AppBar(
          title: const Text('org_flutter'),
          bottom: const TabBar(
            tabs: [
              Tab(text: 'Simple'),
              Tab(text: 'Complex'),
            ],
          ),
        ),
        body: const TabBarView(children: [
          SimpleTab(),
          ComplexTab(),
        ]),
      ),
    );
  }
}

class SimpleTab extends StatelessWidget {
  const SimpleTab({super.key});

  @override
  Widget build(BuildContext context) {
    return const Org(
      '''* TODO [#A] foo bar
baz buzz''',
      restorationId: 'my_org_widget',
    );
  }
}

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

  @override
  State<ComplexTab> createState() => _ComplexTabState();
}

class _ComplexTabState extends State<ComplexTab> {
  late OrgDocument root;

  @override
  void initState() {
    root = OrgDocument.parse('''* TODO [#A] foo bar
~1~''');

    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    return OrgController(
      root: root,
      child: ListView(
        children: [
          OrgRootWidget(child: OrgDocumentWidget(root, shrinkWrap: true)),
          ElevatedButton(
            onPressed: _incrementCounter,
            child: const Text('Increment'),
          ),
        ],
      ),
    );
  }

  void _incrementCounter() {
    late OrgMarkup markupNode;
    root.visit<OrgMarkup>((node) {
      markupNode = node;
      return false; // 停止遍历
    });
    final value = int.parse(markupNode.content.children.single.toMarkup());
    setState(() {
      root = root
          .editNode(markupNode)!
          .replace(OrgMarkup.just('${value + 1}', OrgStyle.code))
          .commit() as OrgDocument;
    });
  }
}

以上代码展示了如何在一个 Flutter 应用中集成和使用 org_flutter 插件，并提供了基本和复杂两种不同的使用场景。