如何在Flutter中使用flutter_markdown

文章介绍了如何在Flutter应用中使用flutter_markdown插件来显示和处理Markdown格式的文本,包括安装依赖、加载本地Markdown文件、自定义样式以及处理点击链接等。同时,文章提到了项目命名避免与依赖包名冲突的问题。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

很多博客,论坛都支持markdown语法,flutter也有支持markdown语法的插件flutter_markdown

安装依赖

Copydependencies:
  flutter:
    sdk: flutter
  flutter_markdown: ^0.3.4

保存后,编辑器自动下载依赖,或者执行 flutter pub get

创建markdown文件,放开pubspec.yaml 静态文件路径

Copy assets:
    - assets/markdown.md

加载本地markdown.md文件。

main.dart文件
Copyimport 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_markdown/flutter_markdown.dart';
​
void main() => runApp(MyApp());
​
class MyApp extends StatelessWidget {
  const MyApp({Key key}) : super(key: key);
​
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Markdown Demo'),
          centerTitle: true,
        ),
        body: FlutterMarkdown(),
      ),
    );
  }
}
​
class FlutterMarkdown extends StatelessWidget {
  const FlutterMarkdown({Key key}) : super(key: key);
​
  @override
  Widget build(BuildContext context) {
    return Container(
      child: FutureBuilder(
        future: rootBundle.loadString('assets/markdown.md'),
        builder: (BuildContext context,AsyncSnapshot snapshot){
          if(snapshot.hasData){
            return Markdown(data: snapshot.data);
          }else{
            return Center(
              child: Text("加载中..."),
            );
          }
        },
      ),
    );
  }
}

展示markdown效果

 

Markdown 组件有两种Markdown(data: markdownSource) 和 MarkdownBody(data: markdownSource)

Markdown() 返回 ListView widget ,并且有默认padding:const EdgeInsets.all(16.0)
MarkdownBody() 返回 Column widget 没有默认的padding并且不支持滚动

Markdown支持自定义样式,监听点击超链

CopyMarkdown(
    data: snapshot.data,
    styleSheet: MarkdownStyleSheet(
        // 支持修改样式
        h1: TextStyle(fontSize: 14),
    ),
    onTapLink: (url){
        // 获取点击链接,可以使用webview展示
        print(url);
    },
)

Markdown源码

Copyclass Markdown extends MarkdownWidget {
  /// Creates a scrolling widget that parses and displays Markdown.
  const Markdown({
    Key key,
    @required String data,
    bool selectable = false,
    MarkdownStyleSheet styleSheet,
    MarkdownStyleSheetBaseTheme styleSheetTheme,
    SyntaxHighlighter syntaxHighlighter,
    MarkdownTapLinkCallback onTapLink,
    String imageDirectory,
    md.ExtensionSet extensionSet,
    MarkdownImageBuilder imageBuilder,
    MarkdownCheckboxBuilder checkboxBuilder,
    this.padding = const EdgeInsets.all(16.0),
    this.controller,
    this.physics,
    this.shrinkWrap = false,
  }) : super(
          key: key,
          data: data,
          selectable: selectable,
          styleSheet: styleSheet,
          styleSheetTheme: styleSheetTheme,
          syntaxHighlighter: syntaxHighlighter,
          onTapLink: onTapLink,
          imageDirectory: imageDirectory,
          extensionSet: extensionSet,
          imageBuilder: imageBuilder,
          checkboxBuilder: checkboxBuilder,
        );
}

意外发现

在创建项目之初,随手就创建了 flutter create flutter_markdown ,然后安装flutter_markdown依赖失败,考虑到project name 和 flutter_markdown重名了,那就换一个项目名称 flutter create markdown 然后flutter pub get 然后又报错了,flutter_markdown依赖另外一个markdown package。好吧,flutter create flutter_md_demo 一切正常了。

Flutter 项目名称不能和package依赖包名相同

 

### 如何在 Flutter使用 Markdown 插件 #### 添加依赖项 要在项目中集成 `flutter_markdown` 插件,在项目的根目录下的 `pubspec.yaml` 文件中的 dependencies 部分添加如下内容[^1]: ```yaml dependencies: flutter: sdk: flutter flutter_markdown: ^0.3.4 ``` 保存文件后,执行命令安装新的包。 #### 创建简单的Markdown视图组件 创建一个新的Dart文件用于定义展示Markdown数据的小部件。下面是一个基本的例子,它展示了如何加载并渲染一段Markdown字符串[^2]: ```dart import 'package:flutter/material.dart'; import 'package:flutter_markdown/flutter_markdown.dart'; class SimpleMarkdownView extends StatelessWidget { final String data; const SimpleMarkdownView({Key? key, required this.data}) : super(key: key); @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar(title: Text('Simple Markdown View')), body: Padding( padding: EdgeInsets.all(8), child: Markdown(data: data), // 使用Markdown widget解析传入的数据 ), ); } } ``` 此代码片段定义了一个名为 `SimpleMarkdownView` 的无状态小部件,该小部件接收一个包含Markdown格式文本的字符串作为参数,并通过内置的 `Markdown` 小部件将其转换成相应的UI元素显示出来。 #### 动态调整布局大小 对于希望根据内容自动适应高度的情况,可以在包裹 `Markdown` 组件外层容器上设置 `shrinkWrap=true` 属性,使得父级容器能够依据子组件的实际尺寸自适应收缩或扩展[^4]。 ```dart child: SingleChildScrollView( child: ConstrainedBox( constraints: BoxConstraints(maxWidth: double.infinity), child: Column( mainAxisSize: MainAxisSize.min, children: [ Markdown(data: data, shrinkWrap: true,) ], ), ), ) ``` 上述配置允许页面内的Markdown内容随着文本量的变化而灵活改变整体布局的高度,从而提供更好的用户体验。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值