FSharp.ReactiveWpf 0.2.0

FSharp.ReactiveWpf

一个用于 F# 与 WPF 的轻量级响应式绑定工具库。它以 System.Reactive 的 IObservable / ISubject 为纽带，把 WPF 控件的事件与属性转换为可组合、可测试的数据流，用函数式风格搭建界面。

项目标题：F# 与 WPF 的响应式绑定工具库 版本：0.1.10　·　许可证：LGPL-3.0-or-later　·　作者：xp44mm 目标框架：net10.0-windows　·　依赖：System.Reactive 7.0 / MahApps.Metro 2.4 / FSharp.Idioms

特性

• 双向绑定：文本、数值、下拉框、开关、单选等控件与 ISubject 双向同步。值驱动界面、界面驱动值各走一条独立数据流，无需手工维护中间状态。
• Rx 原生：所有绑定建立在 IObservable / ISubject 之上，可自由组合 Select / DistinctUntilChanged / Throttle / ObserveOn 等操作符。
• 生命周期集中管理：绑定统一向调用方传入的 CompositeDisposable 注册，窗口关闭或界面销毁时一次性释放，杜绝订阅泄漏。
• 类型安全：数值框内置 float / float32 / int / int64 解析，非法输入不会进入数据流。
• 文档排版支持：提供 FlowDocument 表格（Table / Row）与 Run / Paragraph 的构建辅助，便于在代码中生成富文本。
• 实用工具：内置文件打开/保存对话框（TextFileOpener / TextFileSaver）、输入弹窗（TextBoxWindow）、媒体播放列表（MediaPlayer）等。

引用

项目引用（推荐）

在另一个 .fsproj 中添加：

<ItemGroup>
  <ProjectReference Include="..\FSharp.ReactiveWpf\FSharp.ReactiveWpf.fsproj" />
</ItemGroup>

NuGet

通过包 ID FSharp.ReactiveWpf 引用（当前版本 0.1.10）。包内嵌 readme.md 作为包说明。

快速开始

以下示例创建数据源并绑定到各类控件：

open System.Reactive.Subjects
open System.Reactive.Disposables
open System.Windows
open System.Windows.Controls
open FSharp.ReactiveWpf

let disposable = new CompositeDisposable()

// 数值输入框（浮点），双向绑定
let numberSubject = new BehaviorSubject<float>(0.0)
let numberTextBox = NumberBox.createFloat disposable numberSubject

// 文本输入框，双向绑定
let textSubject = new BehaviorSubject<string>("hello")
let textBox = TextBox.create disposable textSubject

// 复选框
let boolSubject = new BehaviorSubject<bool>(false)
let check = CheckBox.create disposable boolSubject "启用"

// 单选按钮组（按索引绑定）
let radioIndex = new BehaviorSubject<int>(-1)
let r1, r2, r3 = RadioButton(), RadioButton(), RadioButton()
r1.Content <- "A"; r2.Content <- "B"; r3.Content <- "C"
RadioButton.bindingRadioButtonGroup disposable [| r1; r2; r3 |] radioIndex

// 下拉框（按项目值绑定）
let comboItem = new BehaviorSubject<string>("A")
let combo = ComboBox.itemCreate disposable [ "A"; "B"; "C" ] comboItem

// 文本块：订阅派生数据流
let data = numberSubject.Select(fun f -> f.ToString("0.##"))
let textBlock = TextBlock.create disposable data

// Run 文本元素（FlowDocument 行内）
let run = Run.create disposable textSubject

// 播放列表（MediaPlayer）
let mediaPlayer = new MediaPlayer()
let playlistSubject = new BehaviorSubject<seq<string>>(Seq.empty)
let playback = MediaPlayer.createPlaylistObservable mediaPlayer (playlistSubject :> IObservable<_>)
let sub = playback.Subscribe() // 触发播放副作用

// 窗口关闭时统一释放
// window.Closing.Add(fun _ -> disposable.Dispose())

模块 API 参考

签名取自库的公开 API。除特别说明外，参数中 CompositeDisposable（下文简称 disp）用于注册所有订阅；ISubject<'t> 既是数据源也是数据汇（双向绑定），IObservable<'t> 仅作数据源（单向）。

文本 / 数值绑定

NumberBox —— 数值输入框

TextBox —— 文本框

样式：defaultStyle / successStyle / dangerStyle（默认 / 成功绿边框 / 失败红边框），以及按布尔选样式的 successDangerStyle : bool -> Style、normalDangerStyle : bool -> Style。

ComboBox —— 下拉框

开关 / 单选

ToggleButton / CheckBox

RadioButton

只读文本

TextBlock

Run（FlowDocument 行内元素）

样式：defaultStyle / TransparentStyle / DangerStyle / SuccessStyle / visibleRunStyle / normalDangerRunStyle / successDangerRunStyle。

布局 / 样式

UIElement

FrameworkElement

Brushes —— 语义色板

文档排版（FlowDocument）

以下模块均采用「参数先行、对象在后」的管道风格，便于 |> 组合。

Row —— 表单行容器

Row 类型（命名空间 FSharp.ReactiveWpf）由内嵌 Row.xaml 模板定义，是一个含「名称 / 单位 / 数值 / 备注」四栏的 DockPanel：

示例：

let row =
    Row.fill(
        TextBlock(Text = "流速"),
        TextBlock(Text = "m/s"),
        value = textBlockForFloat section.velocity
    )
panel.Children.Add(row.Root) |> ignore

窗口 / 文件对话框

TextBoxWindow —— 输入弹窗

基于 TextBoxWindow.xaml（MahApps MetroWindow）的模态输入对话框，返回窗口与取值函数（ShowDialog 结果为 true 后再调用取值函数取得输入值）：

示例：

let window, getResult = TextBoxWindow.getFloat 0.0
if window.ShowDialog() = System.Nullable(true) then
    let value = getResult()
    f.OnNext(value)

TextFileOpener / TextFileSaver —— 文件对话框

默认 openJson / jsonSaver 使用 UTF-8（带 BOM）编码、.json 扩展名、JSON/文本过滤。

媒体播放

MediaPlayer —— 播放列表

富文本定位（GreenWhite）

面向「打字机 / 字幕」场景的「绿色已读 + 白色未读」定位工具：

其它工具

FSharp.ReactiveWpf.Internal 为库内部的 XAML 加载辅助（Row、TextBoxWindow 等依赖），一般无需直接使用。

设计要点

• UI 分层：控件创建/绑定逻辑与业务数据分离——业务侧持有 ISubject / IObservable，UI 侧通过 CompositeDisposable 注册绑定，便于单元测试与界面重建。
• 数据流双向但单向传播：每个绑定拆成「值→控件」与「控件→值」两条 Rx 流，用 DistinctUntilChanged 防止回环抖动，用 Throttle 降低高频更新开销。
• 生命周期集中管理：所有订阅汇入调用方传入的 CompositeDisposable，由窗口/页面关闭事件统一 Dispose。
• 依赖明确：纯 Rx 公共核心在 FSharp.Idioms.Reactive（netstandard2.0，与 UI 无关）；本库只负责 WPF 绑定，并通过 MahApps.Metro 提供 Metro 风格控件。

测试与示例

• FSharp.ReactiveWpf.Test：运行 dotnet test FSharp.ReactiveWpf.Test。
• Windows：TextBoxWindow、FrameworkElement.bindStyle、UIElement.bindVisible 的演示窗口。
• section：截面计算的响应式表单示例（Row、NumberBox、TextBlock、ComboBox 的组合用法）。
• PipeSections.cli / PipeSections.ui：管道截面应用的命令行与 UI 版本。

相关项目

• FSharp.Idioms.Reactive：System.Reactive 的惯用工具库（ObservableArray、BehaviorSubject.tryNext 系列），本库与 UI 无关的公共核心依赖。
• 仓库：https://github.com/xp44mm/FSharp.ReactiveWpf

许可证

LGPL-3.0-or-later

参考

WPF 的属性值优先级：

1. 本地值（Local Value）- 最高优先级
2. 样式触发器（Style Triggers）
3. 模板触发器（Template Triggers）
4. 样式设置器（Style Setters）
5. 主题样式（Theme Style）
6. 继承值（Inherited Value）
7. 默认值（Default Value）- 最低优先级