Skip to content

feat: implement Typora-style live markdown rendering mode - #69

Closed
Hatsume0202 wants to merge 1 commit into
Radiant303:mainfrom
Hatsume0202:feat/typora-live-rendering
Closed

Hatsume0202 wants to merge 1 commit into
Radiant303:mainfrom
Hatsume0202:feat/typora-live-rendering

Conversation

@Hatsume0202

Copy link
Copy Markdown

Closes #68

实现内容

实现了 Typora 风格的实时 Markdown 渲染模式,用户可以通过切换按钮在分栏编辑模式和实时渲染模式之间切换。

主要改动

  • 在预览面板标题栏添加了 Typora 模式切换按钮
  • 实现全宽预览的实时渲染模式
  • 点击编辑按钮弹出编辑器面板
  • 保留侧边栏和自动保存功能

使用方法

  1. 在预览面板顶部点击 👁️ 图标切换到 Typora 模式
  2. 预览区域占据全宽显示渲染效果
  3. 点击右下角 ✏️ 按钮编辑文档内容
  4. 再次点击 👁️ 图标切换回分栏模式

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

AI 审查结果

代码审查结论

本次 PR 实现了 Typora 风格的实时 Markdown 渲染模式,包含状态管理、布局切换和新组件创建。整体设计合理,但存在几个需要关注的问题。

问题列表

严重程度:高

问题 1:_TyporaPane 中 AnimatedPositioned 的 height 为 0 时,子组件仍会被构建

  • 位置/文件:spring_note/lib/features/notes/notes_page.dart,_TyporaPane.build() 中的 AnimatedPositioned
  • 原因:当 editOverlayOpen 为 false 时,AnimatedPositioned 的 height 为 0,但 SizedBox 和 _EditorPane 仍然会被构建。_EditorPane 可能包含昂贵的初始化逻辑(如控制器绑定、监听器注册),即使不可见也会执行,导致性能浪费。
  • 建议修复方式:使用 if (editOverlayOpen || ...) 条件包裹 SizedBox,或使用 Visibility widget 配合 maintainState: false 来避免不必要的构建:
if (editOverlayOpen || animation.isAnimating) // 需要额外处理动画状态
// 或更简单的方案:
Visibility(
  visible: editOverlayOpen,
  maintainState: false,
  child: AnimatedPositioned(...)
)

严重程度:中

问题 2:_TyporaPane 中 AnimatedPositioned 的初始动画问题

  • 位置/文件:spring_note/lib/features/notes/notes_page.dart,_TyporaPane.build() 中的 AnimatedPositioned
  • 原因:AnimatedPositioned 在首次构建时,如果 editOverlayOpen 为 false,height 为 0,但 bottom 为 0,会导致编辑器面板从底部滑入时出现视觉跳跃。此外,AnimatedPositioned 没有设置 onEnd 回调,无法在动画完成后执行清理逻辑。
  • 建议修复方式:添加 AnimatedPositioned 的 onEnd 回调,并在首次构建时跳过动画:
AnimatedPositioned(
  duration: const Duration(milliseconds: 300),
  curve: Curves.easeOutCubic,
  left: 0,
  right: 0,
  bottom: 0,
  height: editOverlayOpen ? overlayHeight : 0,
  onEnd: () {
    // 动画完成后的清理逻辑
    if (!editOverlayOpen) {
      // 可选:释放编辑器资源
    }
  },
  child: ...
)

问题 3:_TyporaPane 中 FAB 的 bottom 位置计算可能不准确

  • 位置/文件:spring_note/lib/features/notes/notes_page.dart,_TyporaPane.build() 中的 FAB Positioned
  • 原因:当 editOverlayOpen 为 true 时,FAB 的 bottom 为 overlayHeight + 24。但在动画过程中,overlayHeight 是固定的,而 AnimatedPositioned 的 height 是动态变化的,导致 FAB 位置与编辑器面板顶部不对齐。
  • 建议修复方式:使用 AnimatedPositioned 的 onEnd 回调来更新 FAB 位置,或使用 AnimatedBuilder 监听动画值:
// 方案1:使用 AnimatedBuilder
AnimatedBuilder(
  animation: _animationController, // 需要添加 AnimationController
  builder: (context, child) {
    return Positioned(
      right: 24,
      bottom: editOverlayOpen ? overlayHeight * _animationController.value + 24 : 24,
      child: child!,
    );
  },
  child: FloatingActionButton.small(...),
);

严重程度:低

问题 4:_TyporaPane 中硬编码的颜色值

  • 位置/文件:spring_note/lib/features/notes/notes_page.dart,_TyporaPane.build() 中的 FloatingActionButton
  • 原因:backgroundColor: const Color(0xFF3A3A3A) 和 color: Colors.white 是硬编码的颜色值,未使用项目中已有的 AppTheme 常量。这可能导致主题不一致,且未来主题变更时需要多处修改。
  • 建议修复方式:使用 AppTheme 中的颜色常量:
FloatingActionButton.small(
  onPressed: onToggleEditOverlay,
  backgroundColor: AppTheme.surface, // 或 AppTheme.primary
  child: Icon(
    editOverlayOpen ? Icons.close : Icons.edit_outlined,
    color: AppTheme.onSurface, // 或 AppTheme.onPrimary
  ),
),

问题 5:_TyporaPane 中 Material 的 elevation 值未使用常量

  • 位置/文件:spring_note/lib/features/notes/notes_page.dart,_TyporaPane.build() 中的 Material
  • 原因:elevation: 8 是硬编码值,未使用项目中可能存在的 elevation 常量或主题定义。
  • 建议修复方式:使用主题中的 elevation 值或定义常量:
Material(
  elevation: Theme.of(context).elevationOverlayColor != null ? 8 : 4,
  // 或使用 AppTheme.elevationMedium
  color: Colors.white,
  child: ...
)

问题 6:缺少对 _TyporaPane 的单元测试和 widget 测试

  • 位置/文件:spring_note/lib/features/notes/notes_page.dart,整个 _TyporaPane 组件
  • 原因:PR 中未包含任何测试文件变更。_TyporaPane 是一个新的 StatefulWidget,包含动画、条件渲染和交互逻辑,需要测试以下场景:
    • 初始状态(编辑面板隐藏)
    • 点击 FAB 后编辑面板滑出
    • 再次点击 FAB 后编辑面板滑入
    • 切换 Typora 模式时编辑面板状态重置
    • 动画过程中的状态一致性
  • 建议修复方式:添加 widget 测试文件 test/features/notes/notes_page_test.dart,覆盖上述场景。

问题 7:_TyporaPane 中 LayoutBuilder 的使用可能导致不必要的重建

  • 位置/文件:spring_note/lib/features/notes/notes_page.dart,_TyporaPane.build() 中的 LayoutBuilder
  • 原因:LayoutBuilder 会在父组件尺寸变化时重建整个 widget 树。如果 _TyporaPane 的父组件频繁调整尺寸(如窗口大小变化),会导致 _PreviewPane 和 _EditorPane 频繁重建,影响性能。
  • 建议修复方式:将 overlayHeight 的计算逻辑移到 initState 或使用 MediaQuery 获取屏幕尺寸,避免每次构建都重新计算:
// 在 _TyporaPane 的构造函数或 build 方法中
final overlayHeight = MediaQuery.of(context).size.height * 0.4;
// 或使用 LayoutBuilder 但缓存结果

严重程度:信息

问题 8:文档中的 Git 操作步骤包含在 PR diff 中

  • 位置/文件:docs/superpowers/plans/2026-07-03-typora-live-rendering.md
  • 原因:文档中包含 git checkout -b、git commit、git push 等 Git 操作步骤,这些是开发流程说明,不应出现在最终提交的文档中。虽然不影响功能,但会污染文档内容。
  • 建议修复方式:从文档中移除 Git 操作步骤,或将其移至独立的开发指南文档。

总结

本次 PR 实现了核心功能,但存在性能问题(不必要的 widget 构建)、UI 问题(动画对齐)和代码质量问题(硬编码值、缺少测试)。建议优先修复高严重性问题,并在后续迭代中补充测试。

@Radiant303 Radiant303 closed this Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

能否做到实时渲染(像typora那样)

3 participants