Skip to content

API reference

The site's generated API reference excludes view and server modules. Use the source links below for their documentation comments, and the linked guides for examples.

Ranvier.View

ModuleContentsPage
Ranvier.View.TemplateAuto-opened with Ranvier.View. Component.define, render, renderWith; TemplateBuilder, AttributeBuilder, PropertyBuilder, EventBuilder, HookBuilder, UnsafeBuilder, DocumentBuilder; TemplateView, Part, Source, Arm, UnsafeHtml, PropertyHtml, primitiveSameTemplates, Components
Ranvier.View.HtmlTemplateGenerated: one t. member per tag, and the members of Attrs, Props and Events. Auto-opened with Ranvier.View.Templates
Ranvier.View.SugarBuilders: Element, VoidElement (whose View is the element as a view), ComponentTag, Attrs, Props, Events, Hooks, from, text, fragment, the control flow, render, renderOf, and Component.template, ofMembers, ofClass. Elements (generated): one class per tag.Sugar
Ranvier.View.RepresentationAuto-opened with Ranvier.View. Setup, Tag, BrowserPolicy, BoundaryFailure, BoundaryStatus, NodeRef, Backend, Program, Html.escape, Html.render, OperationsComponents, Other authoring layers
Ranvier.View.ServerOptions, render, renderTo, renderPage, Page, DocumentShell, ModuleScript, renderDocument, renderDocumentTo, stateScript, ServerPendingExceptionRendering
Lifetime.fs, Scope.fs, Identity.fsScopePhase, MountLifetime; the scopes that route pending reads and failures; positional idsMounts and lifetimes

Ranvier.View.Dom

ModuleContentsPage
Mountingmount, mountWith, Mounted, BuildContext, NativeOwnershipMounts and lifetimes
Hydrationhydrate, hydrateWith, HydrationOptions, readStateHydration
Scheduling, MicrotaskCommitMode, CommitFailure, Queue; Microtask.modeMounts and lifetimes
TemplateDomThe DOM compiler of templates; HydrationMismatchExceptionHydration
Authoring, Components, Generated.HtmlThe authored layerOther authoring layers

experiments/Ranvier.View.Arms

ModuleContentsPage
Ranvier.View.ArmsArms.Match, Arms.Prepare; on .NET BuildTimeReadException and ArmsMatchException (both inherit InvalidOperationException, which shared code catches on both targets)Conditional arms
Ranvier.View.Arms.FablePluginCaseArmsAttribute: the Fable plugin that lowers Arms.Match calls, referenced through Ranvier.View.Arms.targetsConditional arms

Other projects

ProjectPage
src/Fable.RanvierOther authoring layers
src/Fable.Ranvier.AnimeAnimation, Owning and driving animations, Testing and costs
src/Ranvier.View.AnimeMotion parts
examples/Ranvier.MotionMotion parts
src/Ranvier.WireState transfer
examples/Fable.Ranvier.PlaygroundGetting started, Testing views
Edit this page