Safe Haskell	None
Language	Haskell2010

Yesod.Alert

Contents

Setting alerts
- Shortcuts
Getting alerts

Description

Setup this package by modifying your definition of *defaultLayout* in *Foundation.hs*

     ...
     defaultLayout widget = do
     ...
     alerts  <- getAlerts
     ...

Then Include a renderer in *default-layout.hamlet*

     ...
     #{renderAlertsBootstrap3 alerts}
     ...
     ^{widget}
     ...

Set alerts from your handlers

     getHomeR :: Handler Html
     getHomeR = do
         ...
         setAlert (Alert Error "oops")
         setSuccessAlert "Yay!"
         ...
         defautlLayout $ do
             $(widgetFile "homepage")

Synopsis

setAlert :: MonadHandler m => Alert -> m ()
setAlertI :: (MonadHandler m, RenderMessage (HandlerSite m) msg) => AlertStatus -> msg -> m ()
setDefaultAlert :: MonadHandler m => Text -> m ()
setInfoAlert :: MonadHandler m => Text -> m ()
setSuccessAlert :: MonadHandler m => Text -> m ()
setWarningAlert :: MonadHandler m => Text -> m ()
setErrorAlert :: MonadHandler m => Text -> m ()
getAlerts :: MonadHandler m => m [Alert]
data Alert = Alert {
- alertStatus :: AlertStatus
- alertMessage :: Text
}
data AlertStatus
- = Default
- | Info
- | Success
- | Warning
- | Error

Setting alerts

setAlert :: MonadHandler m => Alert -> m () Source #

Set an Alert

setAlertI :: (MonadHandler m, RenderMessage (HandlerSite m) msg) => AlertStatus -> msg -> m () Source #

Set an Alert allowing i18n

Shortcuts

setDefaultAlert :: MonadHandler m => Text -> m () Source #

setInfoAlert :: MonadHandler m => Text -> m () Source #

setSuccessAlert :: MonadHandler m => Text -> m () Source #

setWarningAlert :: MonadHandler m => Text -> m () Source #

setErrorAlert :: MonadHandler m => Text -> m () Source #

Getting alerts

getAlerts :: MonadHandler m => m [Alert] Source #

Get available Alerts

data Alert #

Constructors

Alert
Fields alertStatus :: AlertStatus alertMessage :: Text

Instances

Eq Alert
Instance details Defined in Web.Alert Methods (==) :: Alert -> Alert -> Bool # (/=) :: Alert -> Alert -> Bool #
Read Alert
Instance details Defined in Web.Alert Methods readsPrec :: Int -> ReadS Alert # readList :: ReadS [Alert] # readPrec :: ReadPrec Alert # readListPrec :: ReadPrec [Alert] #
Show Alert
Instance details Defined in Web.Alert Methods showsPrec :: Int -> Alert -> ShowS # show :: Alert -> String # showList :: [Alert] -> ShowS #

data AlertStatus #

Constructors

Default
Info
Success
Warning
Error

Instances

Bounded AlertStatus
Instance details Defined in Web.Alert Methods minBound :: AlertStatus # maxBound :: AlertStatus #
Eq AlertStatus
Instance details Defined in Web.Alert Methods (==) :: AlertStatus -> AlertStatus -> Bool # (/=) :: AlertStatus -> AlertStatus -> Bool #
Read AlertStatus
Instance details Defined in Web.Alert Methods readsPrec :: Int -> ReadS AlertStatus # readList :: ReadS [AlertStatus] # readPrec :: ReadPrec AlertStatus # readListPrec :: ReadPrec [AlertStatus] #
Show AlertStatus
Instance details Defined in Web.Alert Methods showsPrec :: Int -> AlertStatus -> ShowS # show :: AlertStatus -> String # showList :: [AlertStatus] -> ShowS #