Ranvier.Plume 0.2.0

dotnet add package Ranvier.Plume --version 0.2.0
                    
NuGet\Install-Package Ranvier.Plume -Version 0.2.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Ranvier.Plume" Version="0.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Ranvier.Plume" Version="0.2.0" />
                    
Directory.Packages.props
<PackageReference Include="Ranvier.Plume" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Ranvier.Plume --version 0.2.0
                    
#r "nuget: Ranvier.Plume, 0.2.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Ranvier.Plume@0.2.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Ranvier.Plume&version=0.2.0
                    
Install as a Cake Addin
#tool nuget:?package=Ranvier.Plume&version=0.2.0
                    
Install as a Cake Tool

Ranvier.Plume

A text editor as a fold over a log of edits, built on Ranvier.

  • Ranvier.Plume: the state. An immutable rope, change sets with position mapping, selections, transactions, facets, state fields, compartments, history, commands and keymaps. No DOM dependency.
  • Ranvier.Plume.View: the EditorView component for Ranvier.View, with native IME composition, clipboard input, accessible selection, and typed decorations with hover templates.

A Document is one file: its log of transactions, its saved text and its current text. An Editor is one view of a document, with its own selection and extensions. Consumers read through Ranvier memos.

open Ranvier
open Ranvier.Plume

let document = Document.create (Text.ofString "let answer = 42\n")
let editor = Editor.create document [ Keymap.extension Keymap.defaults ]   // under a Ranvier owner

Api.createEffect (fun () -> printfn "caret at %d" editor.Selection.Value.Main.Head)

editor.Dispatch [ Tx.change { From = 4; To = 10; Insert = Text.ofString "result" }; Tx.userEvent "input.type" ]

Read the installation guide, typed shortcut guide, and generated API reference. The documentation site also covers shared documents, view extensions and performance probes.

The design is in docs/DOSSIER.md. Pre-1.0: the API may change.

Bind editor commands

Use Keymap.bindChords for a shortcut or a sequence. Use Keymap.bindChordsWithShift when holding Shift on the last stroke should select an alternate command.

open Ranvier.Keyboard
open Ranvier.Plume

let right = chord { key (Navigation ArrowRight) }
let movement =
    Keymap.extension [ Keymap.bindChordsWithShift [ right ] Commands.cursorCharRight Commands.selectCharRight ]

For bindings loaded from text configuration, Keymap.bind and Keymap.bindShift accept editor notation such as "Ctrl-z" and "Ctrl-k Ctrl-c".

The formal verification suite covers edit inversion, retained history and reader cursor ownership, with conformance checks against the compiled editor.

Build, test and measure

dotnet fsi --exec build.fsx -- ci

builds the solution in Release and runs both test projects, the state tests on net10.0 and net8.0 (the view tests open hidden windows). dotnet fsi --exec build.fsx -- check builds it in Debug and runs rfs check --fail-on-error. dotnet fsi --exec build.fsx -- dev runs the sample under the hot reload host, window off screen, and checks that edits to a copy of its sources reach the page. dotnet fsi --exec build.fsx -- traced builds both libraries on the traced core and runs the state tests on them. dotnet fsi --exec build.fsx -- acceptance recomputes the acceptance verdicts of the dossier's section 7. dotnet fsi --exec build.fsx -- red shows the tests of plan tasks 1 and 2 failing to compile without their implementation.

The sample in samples/EditorShowcase is the workspace's EditorShowcase rebuilt on the library:

dotnet run -c Release --project samples/EditorShowcase                 # the window
dotnet run -c Release --project samples/EditorShowcase -- --bench      # frame cost, hidden window
dotnet run -c Release --project samples/EditorShowcase -- --memory     # what history holds
dotnet run -c Release --project samples/EditorShowcase -- --load       # scalar against vectorised line scan
dotnet run -c Release --project samples/EditorShowcase -- --profile    # frame cost with each view feature off
dotnet run -c Release --project samples/EditorShowcase -- --writes     # the page writes of a keystroke and a scroll
dotnet run -c Release --project samples/EditorShowcase -- --tour       # the app as its window runs it, hidden
dotnet run -c Release --project samples/EditorShowcase -- --tour --shown out.png   # the same, window shown
dotnet run -c Release --project samples/EditorShowcase -- --tour --shown out.png --pointer   # and the real pointer moved
dotnet run -c Release --project samples/EditorShowcase -- --shot out.png

Use the full-feature editor baseline for typing and scrolling comparisons. The phase 1 measurements record the original acceptance workloads.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Ranvier.Plume:

Package Downloads
Ranvier.Plume.View

The EditorView component of Ranvier.Plume for Ranvier.View: a virtualised text view with pooled rows, gutters, layers, pointer and keyboard input, and a theme over Ranvier.Css.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.2.0 0 11/19/2026
0.1.1 0 11/19/2026
0.1.0 44 11/19/2026

Preserves unpaired UTF-16 code units through edits and undo. Optimises reader retention and text materialization, with Rocq and Iris verification.