package incr_dom_widgets

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Form state

incr_dom_widgets
- Incr_dom_widgets
  - Buttons
  - Form
    
    Block
    
    Description
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Of_record
    
    Make_creator_types
    
    Form_error
    
    Id
    
    Input
    
    List
    
    List_id
    
    State
    
    Variant_id
  - Interactive
    
    Let_syntax
    
    Let_syntax
    
    Monad_infix
    
    Primitives
    
    Button_state
  - Modal
  - Sexp_form
    
    Case
    
    Init
    
    Primitives
    
    Record_builder
    
    Record_field
    
    Unsafe
    
    Applicative_infix
    
    Let_syntax
    
    Applicative_infix
    
    Let_syntax
  - Spinner

Legend:
Library
Module
Module type
Parameter
Class
Class type

Form state

type t

Represent the state of a form. A state does not have any type parameter so that it's easier to embed in other data structure (like Incr_dom.App_intf.Simple.Model.t).

A state is used in conjunction with the form it was created from. If you use a state with any other form an exception will be thrown.

val compare : t -> t -> int

val create : ?init:'a -> ('a, _) form -> t

Raises an exception if any initial value for variants is not a part of the options available in form.

val field_ids : t -> (_, 'ids) form -> 'ids

Returns all ids defined in the given form.

val read_value : t -> ('a, _) form -> 'a option * t

Try to read the value contained in a form. Errors, if any, will be stored in the returned state.

val error : t -> _ Id.t -> Core_kernel.Error.t option

Return the error attached to a given id, if any.

val errors : t -> Core_kernel.Error.t list

Return all errors associated with the form state