Web.Page.Types

Documentation

data Page

Components of a web page.

A web page typically can take many forms but still be the same web page. For example, css can be linked to in a separate file, or can be inline within html, but still be the same css. This type represents the practical components of what makes up a web page.

Constructors

Page

Fields

• libsCss :: [Html ()]

  css library links

• libsJs :: [Html ()]

  javascript library links

• cssBody :: PageCss

  css

• jsGlobal :: PageJs

  javascript with global scope

• jsOnLoad :: PageJs

  javascript included within the onLoad function

• htmlHeader :: Html ()

  html within the header

• htmlBody :: Html ()

  body html

Instances

Show Page

Defined in Web.Page.Types

Methods

showsPrec :: Int -> Page -> ShowS

show :: Page -> String

showList :: [Page] -> ShowS

Generic Page

Defined in Web.Page.Types

Associated Types

type Rep Page :: Type -> Type

Methods

from :: Page -> Rep Page x

to :: Rep Page x -> Page

Semigroup Page

Defined in Web.Page.Types

Methods

(<>) :: Page -> Page -> Page

sconcat :: NonEmpty Page -> Page

stimes :: Integral b => b -> Page -> Page

Monoid Page

Defined in Web.Page.Types

Methods

mempty :: Page

mappend :: Page -> Page -> Page

mconcat :: [Page] -> Page

type Rep Page

Defined in Web.Page.Types

type Rep Page = D1 (MetaData "Page" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "Page" PrefixI True) ((S1 (MetaSel (Just "libsCss") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Html ()]) :*: (S1 (MetaSel (Just "libsJs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Html ()]) :*: S1 (MetaSel (Just "cssBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageCss))) :*: ((S1 (MetaSel (Just "jsGlobal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageJs) :*: S1 (MetaSel (Just "jsOnLoad") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageJs)) :*: (S1 (MetaSel (Just "htmlHeader") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Html ())) :*: S1 (MetaSel (Just "htmlBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Html ()))))))

data PageConfig

Configuration of the rendering of a web page

Constructors

PageConfig

Fields

• concerns :: PageConcerns
• structure :: PageStructure
• pageRender :: PageRender
• filenames :: Concerns FilePath
• localdirs :: [FilePath]

Instances

Eq PageConfig

Defined in Web.Page.Types

Methods

(==) :: PageConfig -> PageConfig -> Bool

(/=) :: PageConfig -> PageConfig -> Bool

Show PageConfig

Defined in Web.Page.Types

Methods

showsPrec :: Int -> PageConfig -> ShowS

show :: PageConfig -> String

showList :: [PageConfig] -> ShowS

Generic PageConfig

Defined in Web.Page.Types

Associated Types

type Rep PageConfig :: Type -> Type

Methods

from :: PageConfig -> Rep PageConfig x

to :: Rep PageConfig x -> PageConfig

type Rep PageConfig

Defined in Web.Page.Types

type Rep PageConfig = D1 (MetaData "PageConfig" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "PageConfig" PrefixI True) ((S1 (MetaSel (Just "concerns") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageConcerns) :*: S1 (MetaSel (Just "structure") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageStructure)) :*: (S1 (MetaSel (Just "pageRender") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PageRender) :*: (S1 (MetaSel (Just "filenames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Concerns FilePath)) :*: S1 (MetaSel (Just "localdirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])))))

defaultPageConfig :: FilePath -> PageConfig

data Concerns a

A web page typically is composed of css, javascript and html

Concerns abstracts this compositional feature of a web page.

Constructors

Concerns

Fields

• cssConcern :: a
• jsConcern :: a
• htmlConcern :: a

Instances

Functor Concerns

Defined in Web.Page.Types

Methods

fmap :: (a -> b) -> Concerns a -> Concerns b

(<$) :: a -> Concerns b -> Concerns a

Applicative Concerns

Defined in Web.Page.Types

Methods

pure :: a -> Concerns a

(<*>) :: Concerns (a -> b) -> Concerns a -> Concerns b

liftA2 :: (a -> b -> c) -> Concerns a -> Concerns b -> Concerns c

(*>) :: Concerns a -> Concerns b -> Concerns b

(<*) :: Concerns a -> Concerns b -> Concerns a

Foldable Concerns

Defined in Web.Page.Types

Methods

fold :: Monoid m => Concerns m -> m

foldMap :: Monoid m => (a -> m) -> Concerns a -> m

foldr :: (a -> b -> b) -> b -> Concerns a -> b

foldr' :: (a -> b -> b) -> b -> Concerns a -> b

foldl :: (b -> a -> b) -> b -> Concerns a -> b

foldl' :: (b -> a -> b) -> b -> Concerns a -> b

foldr1 :: (a -> a -> a) -> Concerns a -> a

foldl1 :: (a -> a -> a) -> Concerns a -> a

toList :: Concerns a -> [a]

null :: Concerns a -> Bool

length :: Concerns a -> Int

elem :: Eq a => a -> Concerns a -> Bool

maximum :: Ord a => Concerns a -> a

minimum :: Ord a => Concerns a -> a

sum :: Num a => Concerns a -> a

product :: Num a => Concerns a -> a

Traversable Concerns

Defined in Web.Page.Types

Methods

traverse :: Applicative f => (a -> f b) -> Concerns a -> f (Concerns b)

sequenceA :: Applicative f => Concerns (f a) -> f (Concerns a)

mapM :: Monad m => (a -> m b) -> Concerns a -> m (Concerns b)

sequence :: Monad m => Concerns (m a) -> m (Concerns a)

Eq a => Eq (Concerns a)

Defined in Web.Page.Types

Methods

(==) :: Concerns a -> Concerns a -> Bool

(/=) :: Concerns a -> Concerns a -> Bool

Show a => Show (Concerns a)

Defined in Web.Page.Types

Methods

showsPrec :: Int -> Concerns a -> ShowS

show :: Concerns a -> String

showList :: [Concerns a] -> ShowS

Generic (Concerns a)

Defined in Web.Page.Types

Associated Types

type Rep (Concerns a) :: Type -> Type

Methods

from :: Concerns a -> Rep (Concerns a) x

to :: Rep (Concerns a) x -> Concerns a

type Rep (Concerns a)

Defined in Web.Page.Types

type Rep (Concerns a) = D1 (MetaData "Concerns" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "Concerns" PrefixI True) (S1 (MetaSel (Just "cssConcern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: (S1 (MetaSel (Just "jsConcern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Just "htmlConcern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))

suffixes :: Concerns FilePath

the common file suffixes of the three concerns

concernNames :: FilePath -> FilePath -> Concerns FilePath

create filenames for each Concern element.

data PageConcerns

Is the rendering to include all Concerns or be separated?

Constructors

Inline

Separated

Instances

Eq PageConcerns

Defined in Web.Page.Types

Methods

(==) :: PageConcerns -> PageConcerns -> Bool

(/=) :: PageConcerns -> PageConcerns -> Bool

Show PageConcerns

Defined in Web.Page.Types

Methods

showsPrec :: Int -> PageConcerns -> ShowS

show :: PageConcerns -> String

showList :: [PageConcerns] -> ShowS

Generic PageConcerns

Defined in Web.Page.Types

Associated Types

type Rep PageConcerns :: Type -> Type

Methods

from :: PageConcerns -> Rep PageConcerns x

to :: Rep PageConcerns x -> PageConcerns

type Rep PageConcerns

Defined in Web.Page.Types

type Rep PageConcerns = D1 (MetaData "PageConcerns" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "Inline" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Separated" PrefixI False) (U1 :: Type -> Type))

data PageStructure

Various ways that a Html file can be structured.

Constructors

HeaderBody

Headless

Snippet

Svg

Instances

Eq PageStructure

Defined in Web.Page.Types

Methods

(==) :: PageStructure -> PageStructure -> Bool

(/=) :: PageStructure -> PageStructure -> Bool

Show PageStructure

Defined in Web.Page.Types

Methods

showsPrec :: Int -> PageStructure -> ShowS

show :: PageStructure -> String

showList :: [PageStructure] -> ShowS

Generic PageStructure

Defined in Web.Page.Types

Associated Types

type Rep PageStructure :: Type -> Type

Methods

from :: PageStructure -> Rep PageStructure x

to :: Rep PageStructure x -> PageStructure

type Rep PageStructure

Defined in Web.Page.Types

type Rep PageStructure = D1 (MetaData "PageStructure" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) ((C1 (MetaCons "HeaderBody" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Headless" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Snippet" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Svg" PrefixI False) (U1 :: Type -> Type)))

data PageRender

Post-processing of page concerns

Constructors

Pretty

Minified

NoPost

Instances

Eq PageRender

Defined in Web.Page.Types

Methods

(==) :: PageRender -> PageRender -> Bool

(/=) :: PageRender -> PageRender -> Bool

Show PageRender

Defined in Web.Page.Types

Methods

showsPrec :: Int -> PageRender -> ShowS

show :: PageRender -> String

showList :: [PageRender] -> ShowS

Generic PageRender

Defined in Web.Page.Types

Associated Types

type Rep PageRender :: Type -> Type

Methods

from :: PageRender -> Rep PageRender x

to :: Rep PageRender x -> PageRender

type Rep PageRender

Defined in Web.Page.Types

type Rep PageRender = D1 (MetaData "PageRender" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "Pretty" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Minified" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "NoPost" PrefixI False) (U1 :: Type -> Type)))

type Css = StyleM ()

The Css context is used to collect style rules which are mappings from selectors to style properties. The Css type is a computation in the StyleM monad that just collects and doesn't return anything.

data PageCss

unifies css as a Clay.Css and css as Text

Constructors

PageCss Css

PageCssText Text

Instances

Show PageCss

Defined in Web.Page.Types

Methods

showsPrec :: Int -> PageCss -> ShowS

show :: PageCss -> String

showList :: [PageCss] -> ShowS

Generic PageCss

Defined in Web.Page.Types

Associated Types

type Rep PageCss :: Type -> Type

Methods

from :: PageCss -> Rep PageCss x

to :: Rep PageCss x -> PageCss

Semigroup PageCss

Defined in Web.Page.Types

Methods

(<>) :: PageCss -> PageCss -> PageCss

sconcat :: NonEmpty PageCss -> PageCss

stimes :: Integral b => b -> PageCss -> PageCss

Monoid PageCss

Defined in Web.Page.Types

Methods

mempty :: PageCss

mappend :: PageCss -> PageCss -> PageCss

mconcat :: [PageCss] -> PageCss

type Rep PageCss

Defined in Web.Page.Types

type Rep PageCss = D1 (MetaData "PageCss" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "PageCss" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Css)) :+: C1 (MetaCons "PageCssText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

renderCss :: Css -> Text

render Css as text

renderPageCss :: PageRender -> PageCss -> Text

render PageCss as text

newtype JS

wrapper for JSAST

Constructors

JS

Fields

• unJS :: JSAST

Instances

Eq JS

Defined in Web.Page.Types

Methods

(==) :: JS -> JS -> Bool

(/=) :: JS -> JS -> Bool

Show JS

Defined in Web.Page.Types

Methods

showsPrec :: Int -> JS -> ShowS

show :: JS -> String

showList :: [JS] -> ShowS

Generic JS

Defined in Web.Page.Types

Associated Types

type Rep JS :: Type -> Type

Methods

from :: JS -> Rep JS x

to :: Rep JS x -> JS

Semigroup JS

Defined in Web.Page.Types

Methods

(<>) :: JS -> JS -> JS

sconcat :: NonEmpty JS -> JS

stimes :: Integral b => b -> JS -> JS

Monoid JS

Defined in Web.Page.Types

Methods

mempty :: JS

mappend :: JS -> JS -> JS

mconcat :: [JS] -> JS

type Rep JS

Defined in Web.Page.Types

type Rep JS = D1 (MetaData "JS" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" True) (C1 (MetaCons "JS" PrefixI True) (S1 (MetaSel (Just "unJS") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JSAST)))

data PageJs

unify JSStatement javascript and text-rendered script

Constructors

PageJs JS

PageJsText Text

Instances

Eq PageJs

Defined in Web.Page.Types

Methods

(==) :: PageJs -> PageJs -> Bool

(/=) :: PageJs -> PageJs -> Bool

Show PageJs

Defined in Web.Page.Types

Methods

showsPrec :: Int -> PageJs -> ShowS

show :: PageJs -> String

showList :: [PageJs] -> ShowS

Generic PageJs

Defined in Web.Page.Types

Associated Types

type Rep PageJs :: Type -> Type

Methods

from :: PageJs -> Rep PageJs x

to :: Rep PageJs x -> PageJs

Semigroup PageJs

Defined in Web.Page.Types

Methods

(<>) :: PageJs -> PageJs -> PageJs

sconcat :: NonEmpty PageJs -> PageJs

stimes :: Integral b => b -> PageJs -> PageJs

Monoid PageJs

Defined in Web.Page.Types

Methods

mempty :: PageJs

mappend :: PageJs -> PageJs -> PageJs

mconcat :: [PageJs] -> PageJs

type Rep PageJs

Defined in Web.Page.Types

type Rep PageJs = D1 (MetaData "PageJs" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "PageJs" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JS)) :+: C1 (MetaCons "PageJsText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

onLoad :: PageJs -> PageJs

wrap js in standard DOM window loader

renderPageJs :: PageRender -> PageJs -> Text

render PageJs as text

parseJs :: Text -> JS

convert text to JS

renderJs :: JS -> Text

render JS as text

data Element

Abstracted message event element

Constructors

Element

Fields

• element :: Text
• value :: Text

Instances

Eq Element

Defined in Web.Page.Types

Methods

(==) :: Element -> Element -> Bool

(/=) :: Element -> Element -> Bool

Show Element

Defined in Web.Page.Types

Methods

showsPrec :: Int -> Element -> ShowS

show :: Element -> String

showList :: [Element] -> ShowS

Generic Element

Defined in Web.Page.Types

Associated Types

type Rep Element :: Type -> Type

Methods

from :: Element -> Rep Element x

to :: Rep Element x -> Element

ToJSON Element

Defined in Web.Page.Types

Methods

toJSON :: Element -> Value

toEncoding :: Element -> Encoding

toJSONList :: [Element] -> Value

toEncodingList :: [Element] -> Encoding

FromJSON Element

Defined in Web.Page.Types

Methods

parseJSON :: Value -> Parser Element

parseJSONList :: Value -> Parser [Element]

type Rep Element

Defined in Web.Page.Types

type Rep Element = D1 (MetaData "Element" "Web.Page.Types" "web-rep-0.2.0-FIwogXICtLkCMjX6u6XK6R" False) (C1 (MetaCons "Element" PrefixI True) (S1 (MetaSel (Just "element") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "value") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data RepF r a

Constructors

Rep

Fields

• rep :: r
• make :: HashMap Text Text -> (HashMap Text Text, Either Text a)

Instances

Bifunctor RepF

Defined in Web.Page.Types

Methods

bimap :: (a -> b) -> (c -> d) -> RepF a c -> RepF b d

first :: (a -> b) -> RepF a c -> RepF b c

second :: (b -> c) -> RepF a b -> RepF a c

Biapplicative RepF

Defined in Web.Page.Types

Methods

bipure :: a -> b -> RepF a b

(<<*>>) :: RepF (a -> b) (c -> d) -> RepF a c -> RepF b d

biliftA2 :: (a -> b -> c) -> (d -> e -> f) -> RepF a d -> RepF b e -> RepF c f

(*>>) :: RepF a b -> RepF c d -> RepF c d

(<<*) :: RepF a b -> RepF c d -> RepF a b

Functor (RepF r)

Defined in Web.Page.Types

Methods

fmap :: (a -> b) -> RepF r a -> RepF r b

(<$) :: a -> RepF r b -> RepF r a

Monoid r => Applicative (RepF r)

Defined in Web.Page.Types

Methods

pure :: a -> RepF r a

(<*>) :: RepF r (a -> b) -> RepF r a -> RepF r b

liftA2 :: (a -> b -> c) -> RepF r a -> RepF r b -> RepF r c

(*>) :: RepF r a -> RepF r b -> RepF r b

(<*) :: RepF r a -> RepF r b -> RepF r a

Semigroup r => Semigroup (RepF r a)

Defined in Web.Page.Types

Methods

(<>) :: RepF r a -> RepF r a -> RepF r a

sconcat :: NonEmpty (RepF r a) -> RepF r a

stimes :: Integral b => b -> RepF r a -> RepF r a

(Monoid a, Monoid r) => Monoid (RepF r a)

Defined in Web.Page.Types

Methods

mempty :: RepF r a

mappend :: RepF r a -> RepF r a -> RepF r a

mconcat :: [RepF r a] -> RepF r a

type Rep a = RepF (Html ()) a

oneRep :: (Monad m, MonadIO m) => Rep a -> (Rep a -> HashMap Text Text -> m ()) -> StateT (HashMap Text Text) m (HashMap Text Text, Either Text a)

newtype SharedRepF m r a

Constructors

SharedRep

Fields

• unrep :: StateT (Int, HashMap Text Text) m (RepF r a)

Instances

Functor m => Bifunctor (SharedRepF m)

Defined in Web.Page.Types

Methods

bimap :: (a -> b) -> (c -> d) -> SharedRepF m a c -> SharedRepF m b d

first :: (a -> b) -> SharedRepF m a c -> SharedRepF m b c

second :: (b -> c) -> SharedRepF m a b -> SharedRepF m a c

Monad m => Biapplicative (SharedRepF m)

Defined in Web.Page.Types

Methods

bipure :: a -> b -> SharedRepF m a b

(<<*>>) :: SharedRepF m (a -> b) (c -> d) -> SharedRepF m a c -> SharedRepF m b d

biliftA2 :: (a -> b -> c) -> (d -> e -> f) -> SharedRepF m a d -> SharedRepF m b e -> SharedRepF m c f

(*>>) :: SharedRepF m a b -> SharedRepF m c d -> SharedRepF m c d

(<<*) :: SharedRepF m a b -> SharedRepF m c d -> SharedRepF m a b

Functor m => Functor (SharedRepF m r)

Defined in Web.Page.Types

Methods

fmap :: (a -> b) -> SharedRepF m r a -> SharedRepF m r b

(<$) :: a -> SharedRepF m r b -> SharedRepF m r a

(Monad m, Monoid r) => Applicative (SharedRepF m r)

Defined in Web.Page.Types

Methods

pure :: a -> SharedRepF m r a

(<*>) :: SharedRepF m r (a -> b) -> SharedRepF m r a -> SharedRepF m r b

liftA2 :: (a -> b -> c) -> SharedRepF m r a -> SharedRepF m r b -> SharedRepF m r c

(*>) :: SharedRepF m r a -> SharedRepF m r b -> SharedRepF m r b

(<*) :: SharedRepF m r a -> SharedRepF m r b -> SharedRepF m r a

type SharedRep m a = SharedRepF m (Html ()) a

runOnce :: Monad m => SharedRep m a -> (Html () -> HashMap Text Text -> m ()) -> m (HashMap Text Text, Either Text a)

compute the initial state of a SharedRep and then run a single action (testing)

zeroState :: Monad m => SharedRep m a -> m (Html (), (HashMap Text Text, Either Text a))

compute the initial state of a SharedRep (testing)