package eliom

  1. Overview
  2. Docs
Advanced client/server Web and mobile framework

Install 

dune-project
 Dependency

ocsigen.org Readme Edit opam file Versions (33)

Authors

  1. D
    dev@ocsigen.org

Maintainers

  1. D
    dev@ocsigen.org

Sources

11.0.1.tar.gz
md5=3aeeca5f734f8e932b5a00fbfd43bd26
sha512=d92948949c81fe5b84f7d262b72653175d4f69574cbb4f85433f3a40df436e9e78b3f024ebcd98cb0e1c8ec45af0e3f9cd1153187549883f4ddfd32feeee3176

doc/eliom.server/Eliom_shared/React/S/index.html

Module React.SSource

include Eliom_shared_sigs.S with type 'a sv := 'a Value.t
Sourcetype 'a t
Sourceval const : 'a -> 'a t
Sourceval value : 'a t -> 'a Value.t
Sourceval map : ?eq:('b -> 'b -> bool) Value.t -> ('a -> 'b) Value.t -> 'a t -> 'b t
Sourceval fmap : ?eq:('b -> 'b -> bool) Value.t -> ('a -> 'b option) Value.t -> 'b Value.t -> 'a t -> 'b t
Sourceval merge : ?eq:('a -> 'a -> bool) Value.t -> ('a -> 'b -> 'a) Value.t -> 'a -> 'b t list -> 'a t
Sourceval l2 : ?eq:('c -> 'c -> bool) Value.t -> ('a -> 'b -> 'c) Value.t -> 'a t -> 'b t -> 'c t
Sourceval l3 : ?eq:('d -> 'd -> bool) Value.t -> ('a -> 'b -> 'c -> 'd) Value.t -> 'a t -> 'b t -> 'c t -> 'd t
Sourceval l4 : ?eq:('e -> 'e -> bool) Value.t -> ('a -> 'b -> 'c -> 'd -> 'e) Value.t -> 'a t -> 'b t -> 'c t -> 'd t -> 'e t
Sourceval l5 : ?eq:('f -> 'f -> bool) Value.t -> ('a -> 'b -> 'c -> 'd -> 'e -> 'f) Value.t -> 'a t -> 'b t -> 'c t -> 'd t -> 'e t -> 'f t
Sourceval l6 : ?eq:('g -> 'g -> bool) Value.t -> ('a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g) Value.t -> 'a t -> 'b t -> 'c t -> 'd t -> 'e t -> 'f t -> 'g t
Sourceval switch : ?eq:('a -> 'a -> bool) Value.t -> 'a t t -> 'a t
Sourcemodule Infix : sig ... end

Infix operators

Sourcemodule Lwt : sig ... end

Cooperative versions of the React operators

Sourceval create : ?default: ('a React.S.t * (?step:React.step -> 'a -> unit)) option Eliom_client_value.t -> ?reset_default:bool -> ?eq:('a -> 'a -> bool) Value.t -> 'a -> 'a t * (?step:React.step -> 'a -> unit) Value.t

create ?default ?reset_default x produces a pair s, f, where s is a (shared) reactive signal, and f is a shared function for updating the signal.

The initial value of the signal is x, unless default is provided. default, if provided, is used as the client-side signal. reset_default, if set to true (default: false), resets the value of default to x.

The behavior of f is undefined on the server side. On the client side, f behaves just like the standard React-provided update functions.

Sourceval synced : 'a t -> bool

If synced s is true, then the server-side and client-side values of s are equal. This means that the client-side code can initially rely on the server-provided value, and defer updates until the first client-side update of s.