Header menu logo Sutil

Transition Module

Support for CSS transitions that can react to store values

Types

Type Description

Animation

AnimationBuilder

CreateTransition

Hideable

HideableRuntime

MatchOption<'T>

Transition

TransitionAttribute

TransitionBuilder

TransitionProp

Functions and values

Function or value Description

animateNode node from animator

Full Usage: animateNode node from animator

Parameters:
node : HTMLElement
from : ClientRect
animator : AnimationBuilder

applyProps props tr

Full Usage: applyProps props tr

Parameters:
Returns: Transition
props : TransitionProp list
tr : Transition
Returns: Transition

clearAnimations node

Full Usage: clearAnimations node

Parameters:
node : HTMLElement

collectNodes sn

Full Usage: collectNodes sn

Parameters:
Returns: Node list
sn : SutilEffect option
Returns: Node list

createAnimation node from animateFn props

Full Usage: createAnimation node from animateFn props

Parameters:
Returns: string
node : HTMLElement
from : ClientRect
animateFn : AnimationBuilder
props : TransitionProp list
Returns: string

createHideableRuntime h

Full Usage: createHideableRuntime h

Parameters:
Returns: HideableRuntime
h : Hideable
Returns: HideableRuntime

createRule node a b tr uid

Full Usage: createRule node a b tr uid

Parameters:
Returns: string
node : HTMLElement
a : float
b : float
tr : Transition
uid : int
Returns: string

element doc tag

Full Usage: element doc tag

Parameters:
Returns: HTMLElement
doc : Document
tag : string
Returns: HTMLElement

flip props node animation

Full Usage: flip props node animation

Parameters:
Returns: Transition
props : TransitionProp list
node : Element
animation : Animation
Returns: Transition

makeHideable guard element transOpt

Full Usage: makeHideable guard element transOpt

Parameters:
Returns: Hideable
guard : IObservable<bool>
element : SutilElement
transOpt : TransitionAttribute list
Returns: Hideable

makeTransition props

Full Usage: makeTransition props

Parameters:
Returns: Transition
props : TransitionProp list
Returns: Transition

mapTrans f t

Full Usage: mapTrans f t

Parameters:
Returns: Transition
f : Transition -> TransitionProp list
t : Transition
Returns: Transition

mergeProps newerProps existingProps

Full Usage: mergeProps newerProps existingProps

Parameters:
Returns: TransitionProp list
newerProps : TransitionProp list
existingProps : TransitionProp list
Returns: TransitionProp list

showIf visibility element

Full Usage: showIf visibility element

Parameters:
Returns: SutilElement

Show or hide according to an IObservable<bool> with no transition

visibility : IObservable<bool>
element : SutilElement
Returns: SutilElement

showIfElse visibility element otherElement

Full Usage: showIfElse visibility element otherElement

Parameters:
Returns: SutilElement

Alternate between a pair of elements according to an IObservable<bool> with no transition

visibility : IObservable<bool>
element : SutilElement
otherElement : SutilElement
Returns: SutilElement

transition options visibility element

Full Usage: transition options visibility element

Parameters:
Returns: SutilElement

Show or hide according to an IObservable<bool> using a transition

options : TransitionAttribute list
visibility : IObservable<bool>
element : SutilElement
Returns: SutilElement

transitionElse options visibility element otherElement

Full Usage: transitionElse options visibility element otherElement

Parameters:
Returns: SutilElement

Alternate between a pair of elements according to an IObservable<bool> with no transition

options : TransitionAttribute list
visibility : IObservable<bool>
element : SutilElement
otherElement : SutilElement
Returns: SutilElement

transitionList list

Full Usage: transitionList list

Parameters:
Returns: SutilElement
list : Hideable list
Returns: SutilElement

transitionMatch store options

Full Usage: transitionMatch store options

Parameters:
Returns: SutilElement
store : IObservable<'T>
options : MatchOption<'T> list
Returns: SutilElement

transitionNode el trans initProps isVisible start complete

Full Usage: transitionNode el trans initProps isVisible start complete

Parameters:
el : HTMLElement
trans : TransitionAttribute list
initProps : TransitionProp list
isVisible : bool
start : HTMLElement -> unit
complete : HTMLElement -> unit

transitionOpt trans store element elseElement

Full Usage: transitionOpt trans store element elseElement

Parameters:
Returns: SutilElement
trans : TransitionAttribute list
store : IObservable<bool>
element : SutilElement
elseElement : SutilElement option
Returns: SutilElement

withProps userProps f initProps

Full Usage: withProps userProps f initProps

Parameters:
Returns: 'a
userProps : TransitionProp list
f : TransitionProp list -> 'a
initProps : TransitionProp list
Returns: 'a

Type something to start searching.