Flutter时间线展示插件timelines的使用

Flutter时间线展示插件timelines的使用

示例

这个示例展示了如何使用timelines插件创建一个具有交替文本内容的简单时间线。

示例代码

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Timelines Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Timelines Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Timeline.tileBuilder(
        builder: TimelineTileBuilder.fromStyle(
          contentsAlign: ContentsAlign.alternating, // 内容对齐方式为交替排列
          contentsBuilder: (context, index) => Padding(
            padding: const EdgeInsets.all(24.0), // 设置内容内边距
            child: Text('Timeline Event $index'), // 显示事件内容
          ),
          itemCount: 10, // 设置事件数量
        ),
      ),
    );
  }
}

使用说明

安装

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

   dependencies:
     timelines: ^[latest_version]
   

2. 安装依赖 通过命令行安装依赖：

   flutter pub get
   

3. 导入库 在你的Dart文件中导入：

   import 'package:timelines/timelines.dart';
   

基本用法

@override
Widget build(BuildContext context) {
  return Timeline.tileBuilder(
    builder: TimelineTileBuilder.fromStyle(
      contentsAlign: ContentsAlign.alternating,
      contentsBuilder: (context, index) => Padding(
        padding: const EdgeInsets.all(24.0),
        child: Text('Timeline Event $index'),
      ),
      itemCount: 10,
    ),
  );
}

组件

主题 (Theme)

TimelineTheme(
  data: TimelineThemeData(...),
  child: DotIndicator(...),
);

如果只想更改父主题的一部分，可以使用TimelineTheme.of(context)：

TimelineTheme(
  data: TimelineThemeData.of(context).copyWith(...),
  child: DotIndicator(...),
);

如果要自定义Timeline或FixedTimeline组件，也可以这样做：

FixedTimeline(
  theme: TimelineThemeData(...),
  children: [...],
);

指示器 (Indicator)

// 容器指示器
ContainerIndicator(
  child: Container(
    width: 15.0,
    height: 15.0,
    color: Colors.blue,
  ),
)

// 点指示器
DotIndicator()

// 边框点指示器
OutlinedDotIndicator()

连接器 (Connector)

// 实线连接器
SizedBox(
  height: 20.0,
  child: SolidLineConnector(),
)

// 虚线连接器
SizedBox(
  height: 20.0,
  child: DashedLineConnector(),
)

// 装饰线连接器
SizedBox(
  height: 20.0,
  child: DecoratedLineConnector(
    decoration: BoxDecoration(
      gradient: LinearGradient(
        begin: Alignment.topCenter,
        end: Alignment.bottomCenter,
        colors: [Colors.blue, Colors.lightBlueAccent[100]],
      ),
    ),
  ),
)

时间节点 (TimelineNode)

纯时间线UI组件，不包含内容：

// 简单的时间节点
SizedBox(
height: 50.0,
child: TimelineNode.simple(),
)

// 复杂的时间节点
SizedBox(
height: 80.0,
child: TimelineNode(
indicator: Card(
margin: EdgeInsets.zero,
child: Padding(
padding: EdgeInsets.all(8.0),
child: Text('Complex'),
),
),
startConnector: DashedLineConnector(),
endConnector: SolidLineConnector(),
),
)

时间线瓦片 (TimelineTile)

在节点两侧显示内容：

TimelineTile(
oppositeContents: Padding(
padding: const EdgeInsets.all(8.0),
child: Text('opposite\ncontents'),
),
contents: Card(
child: Container(
padding: EdgeInsets.all(8.0),
child: Text('contents'),
),
),
node: TimelineNode(
indicator: DotIndicator(),
startConnector: SolidLineConnector(),
endConnector: SolidLineConnector(),
),
)

时间线瓦片构建器 (TimelineTileBuilder)

提供了强大的构建功能。例如，连接方向和内容对齐方式：

// 连接方向为before
FixedTimeline.tileBuilder(
builder: TimelineTileBuilder.connectedFromStyle(
connectionDirection: ConnectionDirection.before,
connectorStyleBuilder: (context, index) {
return (index == 1) ? ConnectorStyle.dashedLine : ConnectorStyle.solidLine;
},
indicatorStyleBuilder: (context, index) => IndicatorStyle.dot,
itemExtent: 40.0,
itemCount: 3,
),
)

// 连接方向为after
FixedTimeline.tileBuilder(
builder: TimelineTileBuilder.connectedFromStyle(
connectionDirection: ConnectionDirection.after,
connectorStyleBuilder: (context, index) {
return (index == 1) ? ConnectorStyle.dashedLine : ConnectorStyle.solidLine;
},
indicatorStyleBuilder: (context, index) => IndicatorStyle.dot,
itemExtent: 40.0,
itemCount: 3,
),
)