Web.Hyperbole.View.Event

Documentation

type DelayMs = Int

onLoad :: ViewAction (Action id) => Action id -> DelayMs -> Mod id

Send the action after N milliseconds. Can be used to implement lazy loading or polling. See Example.Page.Concurrent

viewUpdating :: Int -> View Progress ()
viewUpdating prg = do
  let pct = fromIntegral prg / 100
  Progress taskId _ <- viewId
  col (onLoad (CheckProgress prg) 0) $ do
    progressBar pct $ do
      el grow $ text $ "Task" <> pack (show taskId)

onClick :: ViewAction (Action id) => Action id -> Mod id

onDblClick :: ViewAction (Action id) => Action id -> Mod id

onInput :: ViewAction (Action id) => (Text -> Action id) -> DelayMs -> Mod id

Run an action when the user types into an input or textarea.

WARNING: a short delay can result in poor performance. It is not recommended to set the value of the input

input (onInput OnSearch) 250 id

onSubmit :: ViewAction (Action id) => Action id -> Mod id

onKeyDown :: ViewAction (Action id) => Key -> Action id -> Mod id

onKeyUp :: ViewAction (Action id) => Key -> Action id -> Mod id

keyDataAttribute :: Key -> Text

data Key

Constructors

ArrowDown

ArrowUp

ArrowLeft

ArrowRight

Enter

Space

Escape

Alt

CapsLock

Control

Fn

Meta

Shift

OtherKey Text

Instances

Read Key

Defined in Web.Hyperbole.View.Event

Methods

readsPrec :: Int -> ReadS Key

readList :: ReadS [Key]

readPrec :: ReadPrec Key

readListPrec :: ReadPrec [Key]

Show Key

Defined in Web.Hyperbole.View.Event

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

toActionInput :: ViewAction a => (Text -> a) -> Text

Serialize a constructor that expects a single Text, like `data MyAction = GoSearch Text`

onRequest :: Mod id -> Mod id

Apply a Mod only when a request is in flight. See Example.Page.Contact

contactEditView :: User -> View Contact ()
contactEditView u = do
  el (hide . onRequest flexCol) contactLoading
  el (onRequest hide) $ contactEdit View Save u

dataTarget :: ViewId a => a -> Mod x

Internal

target :: (HyperViewHandled id ctx, ViewId id) => id -> View id () -> View ctx ()

Allow inputs to trigger actions for a different view