Ranvier.Keyboard 0.2.0

dotnet add package Ranvier.Keyboard --version 0.2.0
                    
NuGet\Install-Package Ranvier.Keyboard -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.Keyboard" Version="0.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Ranvier.Keyboard" Version="0.2.0" />
                    
Directory.Packages.props
<PackageReference Include="Ranvier.Keyboard" />
                    
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.Keyboard --version 0.2.0
                    
#r "nuget: Ranvier.Keyboard, 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.Keyboard@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.Keyboard&version=0.2.0
                    
Install as a Cake Addin
#tool nuget:?package=Ranvier.Keyboard&version=0.2.0
                    
Install as a Cake Tool

Ranvier.Keyboard

DOM-free, standards-typed keyboard model, Unicode UAX #29 grapheme utilities, and 30-bit packed KeyChord / KeyPress primitives for .NET (net10.0, net8.0, NativeAOT) and Fable (fickl).

What Ranvier.Keyboard Contains

All types live in namespace Ranvier.Keyboard:

  • Physical keys (IsoAndW3cKeys.fs):
    • PhysicalKeyCode (all 116 W3C KeyboardEvent.code scan positions; [<Struct>] DU on .NET with three-tier Vector512 / Vector256 / Vector128 SIMD ofW3cCode / ofW3cCodeSpan / ofW3cCodeUtf8, and [<StringEnum>] under fickl for zero-cost JS string interop).
    • PhysicalKeyCode.ofUsbHidUsage (USB HID Usage Page 0x07 scancode mapping) and PhysicalKeyCode.toIso9995 (Iso9995Coordinate, IsoSection, IsoRow).
  • Unicode, C0 controls & UAX #29 graphemes (UnicodeAndControl.fs):
    • C0Control (0x00..0x1F + 0x7F DEL, caret notation ^@..^?, Ctrl+ASCII mapping, and SIMD indexOfControlByte / indexOfControlChar).
    • UnicodeChar (classify, tryBracketPartner, isVimWordRune, vimWordClass across LetterCase, BracketRole, QuoteStyle, UnicodeCharClass).
    • Grapheme (nextClusterLength, prevClusterStart, stepForward, stepBackward, runeAt, toLower, toUpper, toggleCase with SIMD ASCII fast paths).
  • Dead keys, RFC 1345 digraphs & logical keys (DeadKeysAndDigraphs.fs):
    • ComposingAccent & DeadKey.compose (ISO/IEC 9995-3 NFC dead-key composition + stroked letters), Rfc1345Digraph.lookup (Vim <C-k> two-char mnemonics).
    • LogicalKey (Character of Rune, GraphemeText, Whitespace, Navigation, Editing, Ui, FunctionKey 1..24, Modifier, Dead, Ime, LeaderVirtual, Unidentified) with SIMD W3C KeyboardEvent.key parsing and KeyModifiers (Ctrl, Alt, Shift, Meta, AltGraph, 5-bit toBits/ofBits).
  • 30-bit packed KeyChord & KeyPress (KeyChord.fs):
    • PackedKey, [<Struct>] KeyChord = { Packed: int; OverflowText: string }, and [<Struct>] KeyPress = { Chord: KeyChord; Physical: PhysicalKeyCode }.
    • O(1) KeyChord.isPlainChar, tryPlainChar, tryPlainRune, tryPlainText, c0Control, active patterns (ClassifiedKey, PlainChar, PlainRune, PlainText, CtrlC0), and SIMD Vim-notation KeyChord.parse / KeyChord.parseArray ("<leader>ff", "<C-w>v", "<C-S-x>", "3dd").

When to Use Ranvier.Keyboard vs Ranvier.Keyboard.Dom / Fable.Ranvier.Keyboard.Dom

Declare shortcuts with typed keys. Modifiers may appear in any order before the final key. A sequence of strokes keeps its order in an ordinary F# list.

open Ranvier.Keyboard

let extendLeft = chord { ctrl; shift; key (Navigation ArrowLeft) }
let sequence = [ chord { key (FunctionKey 5) }; chord { key (Whitespace Enter) } ]
  • Use Ranvier.Keyboard alone (on .NET or fickl) when your project does not directly touch Ranvier.Dom.KeyboardEvent — for example: modal editing engines, keymap registries, .fsx configuration scripts, SDL / USB HID native input loops, IPC protocols, CLI/TUI apps, or unit tests. It ships its F# sources for fickl directly inside the .nupkg and carries no DOM package dependency.
  • Add Ranvier.Keyboard.Dom on native .NET / Ranvier.View.WebCore hosts, or Fable.Ranvier.Keyboard.Dom in browser fickl apps, when you want to decode Ranvier.Dom.KeyboardEvent instances via Ranvier.Keyboard.Dom.KeyboardEvent.{toKeyChord, toKeyPress, physicalCode, logicalKey, modifiers, isEscape}.
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 (5)

Showing the top 5 NuGet packages that depend on Ranvier.Keyboard:

Package Downloads
Ranvier.Keyboard.Dom

Native .NET DOM adapter bridging Ranvier.Dom.KeyboardEvent to Ranvier.Keyboard (PhysicalKeyCode, LogicalKey, KeyModifiers with lazy AltGraph guard, KeyChord, KeyPress, and isEscape). Use on native .NET / Ranvier.View.WebCore hosts; use Fable.Ranvier.Keyboard.Dom in browser fickl apps, or Ranvier.Keyboard alone when no DOM dependency is needed.

Fable.Ranvier.Keyboard.Dom

Fable (fickl) browser DOM adapter bridging Ranvier.Dom.KeyboardEvent (from Fable.Ranvier.Dom) to Ranvier.Keyboard with zero-cost StringEnum physical key reads and lazy AltGraph modifier queries. Use in browser fickl apps; use Ranvier.Keyboard.Dom on native .NET / Ranvier.View.WebCore hosts, or Ranvier.Keyboard alone when no DOM dependency is needed.

Ranvier.Terminal.Core

Native terminal rendering, layout and reactive controls for F# applications.

Ranvier.Plume

The state of a text editor as a fold over a log of edits, on Ranvier: an immutable rope, change sets with position mapping, selections, transactions, facets, state fields, compartments, history, commands and keymaps. No DOM dependency.

Ranvier.Plume.Traced

The state of a text editor as a fold over a log of edits, on Ranvier: an immutable rope, change sets with position mapping, selections, transactions, facets, state fields, compartments, history, commands and keymaps. No DOM dependency.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.2.0 85 11/19/2026
0.1.0 66 11/18/2026

Pre-1.0 release. The API may change before 1.0.