Safe Haskell	None
Language	Haskell98

Yesod.Core.Widget

Contents

Datatype
Special Hamlet quasiquoter/TH for Widgets
Convert to Widget
Creating
Subsites
Internal

Description

Widgets combine HTML with JS and CSS dependencies with a unique identifier generator, allowing you to create truly modular HTML components.

Synopsis

Datatype

type WidgetT site (m :: * -> *) = WidgetFor site #

Deprecated: Use WidgetFor directly

data WidgetFor site a #

A generic widget, allowing specification of both the subsite and master site datatypes. While this is simply a WriterT, we define a newtype for better error messages.

Instances

((~) * site' site, (~) * a ()) => ToWidget site' (WidgetFor site a) #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site') => WidgetFor site a -> m () #
Monad (WidgetFor site) #
Methods (>>=) :: WidgetFor site a -> (a -> WidgetFor site b) -> WidgetFor site b # (>>) :: WidgetFor site a -> WidgetFor site b -> WidgetFor site b # return :: a -> WidgetFor site a # fail :: String -> WidgetFor site a #
Functor (WidgetFor site) #
Methods fmap :: (a -> b) -> WidgetFor site a -> WidgetFor site b # (<$) :: a -> WidgetFor site b -> WidgetFor site a #
Applicative (WidgetFor site) #
Methods pure :: a -> WidgetFor site a # (<>) :: WidgetFor site (a -> b) -> WidgetFor site a -> WidgetFor site b # liftA2 :: (a -> b -> c) -> WidgetFor site a -> WidgetFor site b -> WidgetFor site c # (>) :: WidgetFor site a -> WidgetFor site b -> WidgetFor site b # (<*) :: WidgetFor site a -> WidgetFor site b -> WidgetFor site a #
MonadIO (WidgetFor site) #
Methods liftIO :: IO a -> WidgetFor site a #
MonadUnliftIO (WidgetFor site) #	Since: 1.4.38
Methods askUnliftIO :: WidgetFor site (UnliftIO (WidgetFor site)) # withRunInIO :: ((forall a. WidgetFor site a -> IO a) -> IO b) -> WidgetFor site b #
MonadResource (WidgetFor site) #
Methods liftResourceT :: ResourceT IO a -> WidgetFor site a #
MonadThrow (WidgetFor site) #
Methods throwM :: Exception e => e -> WidgetFor site a #
MonadLogger (WidgetFor site) #
Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> WidgetFor site () #
MonadLoggerIO (WidgetFor site) #
Methods askLoggerIO :: WidgetFor site (Loc -> LogSource -> LogLevel -> LogStr -> IO ()) #
MonadWidget (WidgetFor site) #
Methods liftWidget :: WidgetFor (HandlerSite (WidgetFor site)) a -> WidgetFor site a #
MonadHandler (WidgetFor site) #
Associated Types type HandlerSite (WidgetFor site :: * -> ) :: # type SubHandlerSite (WidgetFor site :: * -> ) :: # Methods liftHandler :: HandlerFor (HandlerSite (WidgetFor site)) a -> WidgetFor site a # liftSubHandler :: SubHandlerFor (SubHandlerSite (WidgetFor site)) (HandlerSite (WidgetFor site)) a -> WidgetFor site a #
MonadReader (WidgetData site) (WidgetFor site) #
Methods ask :: WidgetFor site (WidgetData site) # local :: (WidgetData site -> WidgetData site) -> WidgetFor site a -> WidgetFor site a # reader :: (WidgetData site -> a) -> WidgetFor site a #
(~) * a () => IsString (WidgetFor site a) #	A `String` can be trivially promoted to a widget. For example, in a yesod-scaffold site you could use: getHomeR = do defaultLayout "Widget text"
Methods fromString :: String -> WidgetFor site a #
(~) * a () => Semigroup (WidgetFor site a) #
Methods (<>) :: WidgetFor site a -> WidgetFor site a -> WidgetFor site a # sconcat :: NonEmpty (WidgetFor site a) -> WidgetFor site a # stimes :: Integral b => b -> WidgetFor site a -> WidgetFor site a #
(~) * a () => Monoid (WidgetFor site a) #
Methods mempty :: WidgetFor site a # mappend :: WidgetFor site a -> WidgetFor site a -> WidgetFor site a # mconcat :: [WidgetFor site a] -> WidgetFor site a #
type HandlerSite (WidgetFor site) #
type HandlerSite (WidgetFor site) = site
type SubHandlerSite (WidgetFor site) #
type SubHandlerSite (WidgetFor site) = site

data PageContent url #

Content for a web page. By providing this datatype, we can easily create generic site templates, which would have the type signature:

PageContent url -> HtmlUrl url

Constructors

PageContent
Fields pageTitle :: !Html pageHead :: !(HtmlUrl url) pageBody :: !(HtmlUrl url)

Special Hamlet quasiquoter/TH for Widgets

whamlet :: QuasiQuoter #

whamletFile :: FilePath -> Q Exp #

ihamletToRepHtml :: (MonadHandler m, RenderMessage (HandlerSite m) message) => HtmlUrlI18n message (Route (HandlerSite m)) -> m Html #

Deprecated: Please use ihamletToHtml instead

Wraps the Content generated by hamletToContent in a RepHtml.

ihamletToHtml :: (MonadHandler m, RenderMessage (HandlerSite m) message) => HtmlUrlI18n message (Route (HandlerSite m)) -> m Html #

Wraps the Content generated by hamletToContent in a RepHtml.

Since 1.2.1

Convert to Widget

class ToWidget site a where #

Minimal complete definition

toWidget

Methods

toWidget :: (MonadWidget m, HandlerSite m ~ site) => a -> m () #

Instances

ToWidget site Builder #	Since: 1.4.28
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => Builder -> m () #
ToWidget site Text #	Since: 1.4.28
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> m () #
ToWidget site Text #	Since: 1.4.28
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> m () #
ToWidget site Html #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => Html -> m () #
ToWidget site Javascript #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => Javascript -> m () #
ToWidget site CssBuilder #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => CssBuilder -> m () #
ToWidget site Css #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => Css -> m () #
((~) * site' site, (~) * a ()) => ToWidget site' (WidgetFor site a) #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site') => WidgetFor site a -> m () #
(~) * render (RY site) => ToWidget site (render -> Javascript) #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Javascript) -> m () #
(~) * render (RY site) => ToWidget site (render -> CssBuilder) #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> CssBuilder) -> m () #
(~) * render (RY site) => ToWidget site (render -> Css) #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Css) -> m () #
(~) * render (RY site) => ToWidget site (render -> Html) #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Html) -> m () #

class ToWidgetHead site a where #

Minimal complete definition

toWidgetHead

Methods

toWidgetHead :: (MonadWidget m, HandlerSite m ~ site) => a -> m () #

Instances

ToWidgetHead site Html #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => Html -> m () #
ToWidgetHead site Javascript #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => Javascript -> m () #
ToWidgetHead site CssBuilder #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => CssBuilder -> m () #
ToWidgetHead site Css #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => Css -> m () #
(~) * render (RY site) => ToWidgetHead site (render -> Javascript) #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Javascript) -> m () #
(~) * render (RY site) => ToWidgetHead site (render -> CssBuilder) #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> CssBuilder) -> m () #
(~) * render (RY site) => ToWidgetHead site (render -> Css) #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Css) -> m () #
(~) * render (RY site) => ToWidgetHead site (render -> Html) #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Html) -> m () #

class ToWidgetBody site a where #

Minimal complete definition

toWidgetBody

Methods

toWidgetBody :: (MonadWidget m, HandlerSite m ~ site) => a -> m () #

Instances

ToWidgetBody site Html #
Methods toWidgetBody :: (MonadWidget m, (* ~ HandlerSite m) site) => Html -> m () #
ToWidgetBody site Javascript #
Methods toWidgetBody :: (MonadWidget m, (* ~ HandlerSite m) site) => Javascript -> m () #
(~) * render (RY site) => ToWidgetBody site (render -> Javascript) #
Methods toWidgetBody :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Javascript) -> m () #
(~) * render (RY site) => ToWidgetBody site (render -> Html) #
Methods toWidgetBody :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> Html) -> m () #

class ToWidgetMedia site a where #

Allows adding some CSS to the page with a specific media type.

Since 1.2

Minimal complete definition

toWidgetMedia

Methods

toWidgetMedia #

Arguments

:: (MonadWidget m, HandlerSite m ~ site)
=> Text	media value
-> a
-> m ()

Add the given content to the page, but only for the given media type.

Since 1.2

Instances

ToWidgetMedia site CssBuilder #
Methods toWidgetMedia :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> CssBuilder -> m () #
ToWidgetMedia site Css #
Methods toWidgetMedia :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> Css -> m () #
(~) * render (RY site) => ToWidgetMedia site (render -> CssBuilder) #
Methods toWidgetMedia :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> (render -> CssBuilder) -> m () #
(~) * render (RY site) => ToWidgetMedia site (render -> Css) #
Methods toWidgetMedia :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> (render -> Css) -> m () #

Creating

Head of page

setTitle :: MonadWidget m => Html -> m () #

Set the page title. Calling setTitle multiple times overrides previously set values.

setTitleI :: (MonadWidget m, RenderMessage (HandlerSite m) msg) => msg -> m () #

Set the page title. Calling setTitle multiple times overrides previously set values.

CSS

addStylesheet :: MonadWidget m => Route (HandlerSite m) -> m () #

Link to the specified local stylesheet.

addStylesheetAttrs :: MonadWidget m => Route (HandlerSite m) -> [(Text, Text)] -> m () #

Link to the specified local stylesheet.

addStylesheetRemote :: MonadWidget m => Text -> m () #

Link to the specified remote stylesheet.

addStylesheetRemoteAttrs :: MonadWidget m => Text -> [(Text, Text)] -> m () #

Link to the specified remote stylesheet.

addStylesheetEither :: MonadWidget m => Either (Route (HandlerSite m)) Text -> m () #

newtype CssBuilder #

Newtype wrapper allowing injection of arbitrary content into CSS.

Usage:

toWidget $ CssBuilder "p { color: red }"

Since: 1.1.3

Constructors

CssBuilder
Fields unCssBuilder :: Builder

Instances

ToWidgetHead site CssBuilder #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => CssBuilder -> m () #
ToWidgetMedia site CssBuilder #
Methods toWidgetMedia :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> CssBuilder -> m () #
ToWidget site CssBuilder #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => CssBuilder -> m () #
(~) * render (RY site) => ToWidgetHead site (render -> CssBuilder) #
Methods toWidgetHead :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> CssBuilder) -> m () #
(~) * render (RY site) => ToWidgetMedia site (render -> CssBuilder) #
Methods toWidgetMedia :: (MonadWidget m, (* ~ HandlerSite m) site) => Text -> (render -> CssBuilder) -> m () #
(~) * render (RY site) => ToWidget site (render -> CssBuilder) #
Methods toWidget :: (MonadWidget m, (* ~ HandlerSite m) site) => (render -> CssBuilder) -> m () #

Javascript

addScript :: MonadWidget m => Route (HandlerSite m) -> m () #

Link to the specified local script.

addScriptAttrs :: MonadWidget m => Route (HandlerSite m) -> [(Text, Text)] -> m () #

Link to the specified local script.

addScriptRemote :: MonadWidget m => Text -> m () #

Link to the specified remote script.

addScriptRemoteAttrs :: MonadWidget m => Text -> [(Text, Text)] -> m () #

Link to the specified remote script.

addScriptEither :: MonadWidget m => Either (Route (HandlerSite m)) Text -> m () #

Subsites

handlerToWidget :: HandlerFor site a -> WidgetFor site a #

Internal

whamletFileWithSettings :: HamletSettings -> FilePath -> Q Exp #

asWidgetT :: WidgetT site m () -> WidgetT site m () #