sprocket - v2.1.0

sprocket/html/events

Types

KeyEvent

</> 
pub type KeyEvent {
  KeyEvent(
    key: String,
    code: String,
    ctrl_key: Bool,
    shift_key: Bool,
    alt_key: Bool,
    meta_key: Bool,
  )
}

Constructors 

  • KeyEvent(
  key: String,
  code: String,
  ctrl_key: Bool,
  shift_key: Bool,
  alt_key: Bool,
  meta_key: Bool,
)

MouseEvent

</> 
pub type MouseEvent {
  MouseEvent(
    x: Int,
    y: Int,
    ctrl_key: Bool,
    shift_key: Bool,
    alt_key: Bool,
    meta_key: Bool,
  )
}

Constructors 

  • MouseEvent(
  x: Int,
  y: Int,
  ctrl_key: Bool,
  shift_key: Bool,
  alt_key: Bool,
  meta_key: Bool,
)

Values

decode_form_data

</> 
pub fn decode_form_data(
  event: dynamic.Dynamic,
) -> Result(dict.Dict(String, String), List(decode.DecodeError))

Decode the form data from a form submit event.

decode_key_event

</> 
pub fn decode_key_event(
  event: dynamic.Dynamic,
) -> Result(KeyEvent, List(decode.DecodeError))

decode_keypress

</> 
pub fn decode_keypress(
  event: dynamic.Dynamic,
) -> Result(String, List(decode.DecodeError))

Decode the key from a key press event.

decode_mouse_event

</> 
pub fn decode_mouse_event(
  event: dynamic.Dynamic,
) -> Result(MouseEvent, List(decode.DecodeError))

Decode a mouse event that includes position clientX and clientY and modifier keys.

decode_target_checked

</> 
pub fn decode_target_checked(
  event: dynamic.Dynamic,
) -> Result(Bool, List(decode.DecodeError))

decode_target_value

</> 
pub fn decode_target_value(
  event: dynamic.Dynamic,
) -> Result(String, List(decode.DecodeError))

Decode the value from an event event.target.value.

event

</> 
pub fn event(
  name: String,
  cb: fn(dynamic.Dynamic) -> Nil,
) -> //internal

event_dispatcher

</> 
pub fn event_dispatcher(
  dispatch: fn(msg) -> Nil,
  cb: fn(
    fn(fn(dynamic.Dynamic) -> msg) -> fn(dynamic.Dynamic) -> Nil,
  ) -> #(//internal, //internal),
) -> #(//internal, //internal)

Creates a helper function that allows us to directly dispatch a message from an event handler without needing to create a separate function for each event.

Example:

  use dispatch_event <- event_dispatcher(dispatch)
  ...

  button([events.on_click(dispatch_event(UserClickedButton))], [])

on_blur

</> 
pub fn on_blur(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_change

</> 
pub fn on_change(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_check

</> 
pub fn on_check(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_click

</> 
pub fn on_click(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_dblclick

</> 
pub fn on_dblclick(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_drag

</> 
pub fn on_drag(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_dragend

</> 
pub fn on_dragend(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_dragenter

</> 
pub fn on_dragenter(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_dragleave

</> 
pub fn on_dragleave(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_dragover

</> 
pub fn on_dragover(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_dragstart

</> 
pub fn on_dragstart(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_drop

</> 
pub fn on_drop(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_focus

</> 
pub fn on_focus(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_focusin

</> 
pub fn on_focusin(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_focusout

</> 
pub fn on_focusout(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_input

</> 
pub fn on_input(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_keydown

</> 
pub fn on_keydown(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_keyup

</> 
pub fn on_keyup(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_mousedown

</> 
pub fn on_mousedown(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_mouseenter

</> 
pub fn on_mouseenter(
  cb: fn(dynamic.Dynamic) -> Nil,
) -> //internal

on_mouseleave

</> 
pub fn on_mouseleave(
  cb: fn(dynamic.Dynamic) -> Nil,
) -> //internal

on_mousemove

</> 
pub fn on_mousemove(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_mouseout

</> 
pub fn on_mouseout(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_mouseover

</> 
pub fn on_mouseover(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_mouseup

</> 
pub fn on_mouseup(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_scroll

</> 
pub fn on_scroll(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_submit

</> 
pub fn on_submit(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_touchcancel

</> 
pub fn on_touchcancel(
  cb: fn(dynamic.Dynamic) -> Nil,
) -> //internal

on_touchend

</> 
pub fn on_touchend(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_touchmove

</> 
pub fn on_touchmove(cb: fn(dynamic.Dynamic) -> Nil) -> //internal

on_touchstart

</> 
pub fn on_touchstart(
  cb: fn(dynamic.Dynamic) -> Nil,
) -> //internal

on_wheel

</> 
pub fn on_wheel(cb: fn(dynamic.Dynamic) -> Nil) -> //internal
✨ Search Document