Moduleyesod-core-1.6.26.0Haskell2010

Yesod.Core.Widget

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

4 types
4 classes
25 values

Packageyesod-core-1.6.26.0
Exports33
LanguageHaskell2010
LicenceMIT
SourceWidget.hs

Datatype

3 declarations

typetype WidgetT site (m :: Type -> Type) = WidgetFor site

Deprecated. Use WidgetFor directly

newtypenewtype 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.

Instances20ToWidget, Monad, Functor, Applicative, MonadIO, MonadThrow, …

(site' ~ site, a ~ ()) => ToWidget site' (WidgetFor site a)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
Monad (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
Functor (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
Applicative (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
MonadIO (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
MonadThrow (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
PrimMonad (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
MonadUnliftIO (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
MonadResource (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
MonadLogger (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
MonadLoggerIO (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
MonadHandler (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Class.Handler
MonadWidget (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Class.Handler
MonadReader (WidgetData site) (WidgetFor site)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
a ~ () => IsString (WidgetFor site a)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
A String can be trivially promoted to a widget.
For example, in a yesod-scaffold site you could use:
```
getHomeR = do defaultLayout "Widget text"
```
a ~ () => Semigroup (WidgetFor site a)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
a ~ () => Monoid (WidgetFor site a)Defined in yesod-core-1.6.26.0 · Yesod.Core.Types
type PrimState (WidgetFor site) = PrimState IODefined in yesod-core-1.6.26.0 · Yesod.Core.Types
type HandlerSite (WidgetFor site) = siteDefined in yesod-core-1.6.26.0 · Yesod.Core.Class.Handler
type SubHandlerSite (WidgetFor site) = siteDefined in yesod-core-1.6.26.0 · Yesod.Core.Class.Handler

datadata 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
- pageTitle :: !Html
- pageDescription :: !Maybe Text
- pageHead :: !HtmlUrl url
- pageBody :: !HtmlUrl url

Special Hamlet quasiquoter/TH for Widgets

4 declarations

valuewhamlet :: QuasiQuoter

valuewhamletFile :: FilePath -> Q Exp

valueihamletToRepHtml

:: (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.

valueihamletToHtml

:: (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

4 declarations

classclass ToWidget site a where

Methods

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

Instances12ToWidget, …

ToWidget site HtmlDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidget site CssDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidget site JavascriptDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidget site TextDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidget site BuilderDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidget site TextDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidget site CssBuilderDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
(site' ~ site, a ~ ()) => ToWidget site' (WidgetFor site a)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidget site (render -> Html)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidget site (render -> Css)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidget site (render -> Javascript)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidget site (render -> CssBuilder)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget

classclass ToWidgetHead site a where

Methods

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

Instances8ToWidgetHead, …

ToWidgetHead site HtmlDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidgetHead site CssDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidgetHead site JavascriptDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidgetHead site CssBuilderDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetHead site (render -> Html)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetHead site (render -> Css)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetHead site (render -> Javascript)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetHead site (render -> CssBuilder)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget

classclass ToWidgetBody site a where

Methods

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

Instances4ToWidgetBody

ToWidgetBody site HtmlDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidgetBody site JavascriptDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetBody site (render -> Html)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetBody site (render -> Javascript)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget

classclass ToWidgetMedia site a where

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

Since 1.2

Methods

toWidgetMedia :: (MonadWidget m, HandlerSite m ~ site) => Text -> a -> m ()
Add the given content to the page, but only for the given media type.
Since 1.2

Instances4ToWidgetMedia

ToWidgetMedia site CssDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidgetMedia site CssBuilderDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetMedia site (render -> Css)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetMedia site (render -> CssBuilder)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget

Creating

0 declarations

Head of page

valuesetTitle :: MonadWidget m => Html -> m ()

Set the page title.

Calling setTitle or setTitleI multiple times overrides previously set values.

SEO Notes:

Title tags are the second most important on-page factor for SEO, after content
Every page should have a unique title tag
Start your title tag with your main targeted keyword
Don't stuff your keywords
Google typically shows 55-64 characters, so aim to keep your title length under 60 characters

valuesetTitleI

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

Set the localised page title.

n.b. See comments for setTitle

valuesetDescription :: MonadWidget m => Text -> m ()

setDescription is not idempotent; we recommend setDescriptionIdemp instead Multiple calls to setDescription will insert multiple meta tags in the page head. If you want an idempotent function, use setDescriptionIdemp - but if you do, you may need to change your layout to include pageDescription.

Add description meta tag to the head of the page

Google does not use the description tag as a ranking signal, but the contents of this tag will likely affect your click-through rate since it shows up in search results.

The average length of the description shown in Google's search results is about 160 characters on desktop, and about 130 characters on mobile, at time of writing.

Source: https://www.advancedwebranking.com/blog/meta-tags-important-in-seo/

valuesetDescriptionI

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

setDescriptionI is not idempotent; we recommend setDescriptionIdempI instead Multiple calls to setDescriptionI will insert multiple meta tags in the page head. If you want an idempotent function, use setDescriptionIdempI - but if you do, you may need to change your layout to include pageDescription.

Add translated description meta tag to the head of the page

n.b. See comments for setDescription.

valuesetDescriptionIdemp :: MonadWidget m => Text -> m ()

Add description meta tag to the head of the page

Google does not use the description tag as a ranking signal, but the contents of this tag will likely affect your click-through rate since it shows up in search results.

The average length of the description shown in Google's search results is about 160 characters on desktop, and about 130 characters on mobile, at time of writing.

Unlike setDescription, this version is *idempotent* - calling it multiple times will result in only a single description meta tag in the head.

Source: https://www.advancedwebranking.com/blog/meta-tags-important-in-seo/

valuesetDescriptionIdempI

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

Add translated description meta tag to the head of the page

n.b. See comments for setDescriptionIdemp.

Unlike setDescriptionI, this version is *idempotent* - calling it multiple times will result in only a single description meta tag in the head.

valuesetOGType :: MonadWidget m => Text -> m ()

Add OpenGraph type meta tag to the head of the page

See all available OG types here: https://ogp.me/#types

valuesetOGImage :: MonadWidget m => Text -> m ()

Add OpenGraph image meta tag to the head of the page

Best practices:

Use custom images for shareable pages, e.g., homepage, articles, etc.
Use your logo or any other branded image for the rest of your pages.
Use images with a 1.91:1 ratio and minimum recommended dimensions of 1200x630 for optimal clarity across all devices.

Source: https://ahrefs.com/blog/open-graph-meta-tags/

CSS

valueaddStylesheet :: MonadWidget m => Route (HandlerSite m) -> m ()

Link to the specified local stylesheet.

valueaddStylesheetAttrs

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

Link to the specified local stylesheet.

valueaddStylesheetRemote :: MonadWidget m => Text -> m ()

Link to the specified remote stylesheet.

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

Link to the specified remote stylesheet.

valueaddStylesheetEither

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

newtypenewtype CssBuilder

Newtype wrapper allowing injection of arbitrary content into CSS.

Usage:

toWidget $ CssBuilder "p { color: red }"

Since: 1.1.3

Constructors

CssBuilder
- unCssBuilder :: Builder

Instances6ToWidget, ToWidgetHead, ToWidgetMedia

ToWidget site CssBuilderDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidgetHead site CssBuilderDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
ToWidgetMedia site CssBuilderDefined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidget site (render -> CssBuilder)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetHead site (render -> CssBuilder)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget
render ~ RY site => ToWidgetMedia site (render -> CssBuilder)Defined in yesod-core-1.6.26.0 · Yesod.Core.Widget

Javascript

valueaddScript :: MonadWidget m => Route (HandlerSite m) -> m ()

Link to the specified local script.

valueaddScriptAttrs

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

Link to the specified local script.

valueaddScriptRemote :: MonadWidget m => Text -> m ()

Link to the specified remote script.

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

Link to the specified remote script.

valueaddScriptEither

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

Subsites

1 declaration

valuehandlerToWidget :: HandlerFor site a -> WidgetFor site a

Internal

2 declarations

valuewhamletFileWithSettings :: HamletSettings -> FilePath -> Q Exp

valueasWidgetT :: WidgetT site m () -> WidgetT site m ()