Web.Hyperbole.HyperView

Documentation

class (Param id, Param (Action id)) => HyperView id

HyperViews are interactive subsections of a Page

Create an instance with a unique view id type and a sum type describing the actions the HyperView supports. The View Id can contain context (a database id, for example)

data Message = Message Int
  deriving (Generic, Param)

data MessageAction
  = Louder Text
  | ClearMessage
  deriving (Generic, Param)

instance HyperView Message where
  type Action Message = MessageAction

Associated Types

type Action id :: Type

Instances

(HyperView id, Param id) => HyperView (FormFields id)

Defined in Web.Hyperbole.Forms

Associated Types

type Action (FormFields id)

hyper :: forall id ctx. HyperView id => id -> View id () -> View ctx ()

Embed HyperViews into the page, or nest them into other views

myPage :: (Hyperbole :> es) => Page es Response
myPage = do
  handle messages
  load $ do
    pure $ do
      el_ "My Page"
      hyper (Message 1) $ messageView "Hello World"
      hyper (Message 2) $ do
        messageView "Another Message"
        hyper OtherView otherView

Views can only trigger actions that match their HyperView

messageView :: Text -> View Message ()
messageView m = do
  el_ (text m)
  button (Louder m) Louder

otherView :: View OtherView ()
otherView = do
  -- Type Error!
  button (Louder "Hi") id Louder

button :: HyperView id => Action id -> Mod -> View id () -> View id ()

<button> HTML tag which sends the action when pressed

button SomeAction (border 1) "Click Me"

onLoad :: HyperView id => Action id -> DelayMs -> View id () -> View id ()

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

pollMessageView :: Text -> View Message ()
pollMessageView m = do
  onLoad LoadMessage 1000 $ do
    el bold "Current Message. Reloading in 1s"
    el_ (text m)

type DelayMs = Int

onRequest :: View id () -> View id () -> View id ()

Give visual feedback when an action is in-flight.

myView = do
  onRequest loadingIndicator $ do
    el_ "Loaded"
  where
    loadingIndicator = el_ "Loading..."

dataTarget :: Param a => a -> Mod

Internal

target :: HyperView id => id -> View id () -> View a ()

Trigger actions for another view. They will update the view specified

otherView :: View OtherView ()
otherView = do
  el_ "This is not a message view"
  button OtherAction id "Do Something"

  target (Message 2) $ do
    el_ "Now we can trigger a MessageAction which will update our Message HyperView, not this one"
    button ClearMessage id "Clear Message #2"

dropdown :: HyperView id => (opt -> Action id) -> (opt -> Bool) -> Mod -> View (Option opt id (Action id)) () -> View id ()

Type-safe dropdown. Sends (opt -> Action id) when selected. The selection predicate (opt -> Bool) controls which option is selected. See Example.Contacts

data ContactsAction
  = Reload (Maybe Filter)
  | Delete Int
  deriving (Generic, Param)

allContactsView :: Maybe Filter -> View Contacts ()
allContactsView fil = do
  row (gap 10) $ do
    el (pad 10) "Filter: "
    dropdown Reload (== fil) id $ do
      option Nothing ""
      option (Just Active) "Active!"
      option (Just Inactive) Inactive
  ...

option :: (HyperView id, Eq opt) => opt -> View (Option opt id (Action id)) () -> View (Option opt id (Action id)) ()

An option for a dropdown. First argument is passed to (opt -> Action id) in the dropdown, and to the selected predicate

selected :: Bool -> Mod

sets selected = true if the dropdown predicate returns True

data Option opt id action

The view context for an option

Constructors

Option

Fields

• toAction :: opt -> action
• selected :: opt -> Bool

class Param a where

Types that can be serialized. HyperView requires this for both its view id and action

data Message = Message Int
  deriving (Generic, Param)

Minimal complete definition

Nothing

Methods

toParam :: a -> Text

default toParam :: (Generic a, GParam (Rep a)) => a -> Text

parseParam :: Text -> Maybe a

default parseParam :: (Generic a, GParam (Rep a)) => Text -> Maybe a

Instances

Param Text

Defined in Web.Hyperbole.HyperView

Methods

toParam :: Text -> Text

parseParam :: Text -> Maybe Text

Param Integer

Defined in Web.Hyperbole.HyperView

Methods

toParam :: Integer -> Text

parseParam :: Text -> Maybe Integer

Param ()

Defined in Web.Hyperbole.HyperView

Methods

toParam :: () -> Text

parseParam :: Text -> Maybe ()

Param Float

Defined in Web.Hyperbole.HyperView

Methods

toParam :: Float -> Text

parseParam :: Text -> Maybe Float

Param Int

Defined in Web.Hyperbole.HyperView

Methods

toParam :: Int -> Text

parseParam :: Text -> Maybe Int

Param id => Param (FormFields id)

Defined in Web.Hyperbole.Forms

Methods

toParam :: FormFields id -> Text

parseParam :: Text -> Maybe (FormFields id)

Param a => Param (Maybe a)

Defined in Web.Hyperbole.HyperView

Methods

toParam :: Maybe a -> Text

parseParam :: Text -> Maybe (Maybe a)

class GParam f where

Methods

gToParam :: f p -> Text

gParseParam :: Text -> Maybe (f p)

Instances

GParam (U1 :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). U1 p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe (U1 p)

(GParam f, GParam g) => GParam (f :*: g :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). (f :*: g) p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe ((f :*: g) p)

(GParam f, GParam g) => GParam (f :+: g :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). (f :+: g) p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe ((f :+: g) p)

GParam (K1 R Text :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). K1 R Text p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe (K1 R Text p)

GParam (K1 R String :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). K1 R String p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe (K1 R String p)

Param a => GParam (K1 R a :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). K1 R a p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe (K1 R a p)

(Constructor c, GParam f) => GParam (M1 C c f :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). M1 C c f p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe (M1 C c f p)

(Datatype d, GParam f) => GParam (M1 D d f :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). M1 D d f p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe (M1 D d f p)

GParam f => GParam (M1 S s f :: k -> Type)

Defined in Web.Hyperbole.HyperView

Methods

gToParam :: forall (p :: k0). M1 S s f p -> Text

gParseParam :: forall (p :: k0). Text -> Maybe (M1 S s f p)

breakSegment :: Text -> (Text, Text)

toSegment :: String -> Text

route :: Route a => a -> Mod -> View c () -> View c ()

A hyperlink to another route

>>> route (User 100) id "View User"
<a href="/user/100">View User</a>