Header menu logo Sutil

Sutil Namespace

Type/Module Description

Bind

Bindings for observables and the Core. For example, use an IObservable<bool> to toggle an element's class attribute

BindArray

Bindings for array observables and the Core. For example, IObservable<int[]>. The Bind class already handles lists. BindArray exists to eliminate compilation errors related to overloading of the each method.

BindOperators

Operators to help with bindings

Bulma

Adapter for Feliz.Engine.Bulma

Cmd

Sutil's Elmish Cmd

Cmd<'Msg>

Cmd - container for effects that may produce messages

Core

The Sutil core engine. Definition for type SutilElement and functions that instantiate Browser DOM from SutilElement.

CoreElements

The core SutilElements required for building DOM, setting attributes, parsing HTML, managing resources etc.

CssMedia

Helpers for basic CSS media queries

Dispatch<'Msg>

Dispatch - feed new message into the processing loop

DomHelpers

Utilities to help with browser DOM API

Easing

Easing functions for CSS transitions

Effect<'msg>

Effect - return immediately, but may schedule dispatch of a message at any time

ElementRef

EngineHelpers

DOM builders such as Html, Attr, Ev and Css

Helpers

General purpose helpers

IStore<'T>

Media

Helpers for listening and reacting to media changes

Navigable (Module)

Window location events

Navigable (Type)

Window location events

Observable

Helper functions for IObservables

ObservablePromise

Support for IObservable<Promise<T>>

ObservableStore

Stores are values that can - be updated - subscribed to This module defines Sutil's Store type

Program

Main entry points for a Sutil program

PseudoCss

Experimental pseudo-CSS styles

ResizeObserver

Support for listening and reacting to window resize events

Store

Functions for working with stores

StoreOperators

Operators for store functions

Styling

Support CSS styling

SutilAttrEngine

DOM element attributes

SutilEventEngine

DOM attributes for listening to events

SutilHtmlEngine

Functions for building DOM elements. Note that not all members are documented here, only a few specialized augmentations over the class Feliz.HtmlEngine In theory, every HTML element should be an inherited member of SutilHtmlEngine, in the form

     // Create div with float value as a child text node
     member _.div (value: float)

     // Create div with float value as a child text node
     member _.div (value: int)

     // Create div with SutilElement value as a child element
     member _.div (value: SutilElement)

     // Create div with string value as child text node
     member _.div (value: string)

     // Create div with multiple child SutilElements.
     // Not all SutilElements are DOM elements; they may be attribute-setters, or event-listeners
     member _.div (children: seq<SutilElement>)
Multiple items
val float: value: 'T -> float (requires member op_Explicit)

--------------------
type float = System.Double

--------------------
type float<'Measure> = float
Multiple items
val int: value: 'T -> int (requires member op_Explicit)

--------------------
type int = int32

--------------------
type int<'Measure> = int
Multiple items
val string: value: 'T -> string

--------------------
type string = System.String
Multiple items
val seq: sequence: 'T seq -> 'T seq

--------------------
type 'T seq = System.Collections.Generic.IEnumerable<'T>

SutilSvgEngine

SvgEngineHelpers

Transition

Support for CSS transitions that can react to store values

TransitionFunctions

Transitions that can be used in the transition function

WebComponent

Support for defining Web Components in Sutil

Type something to start searching.