Web.Rep.Page

Documentation

data Page

Components of a web page.

A web page can take many forms but still have the same underlying representation. For example, CSS can be linked to in a separate file, or can be inline within html, but still be the same css and have the same expected external effect. A Page represents the practical components of what makes up a static snapshot of a web page.

Constructors

Page

Fields

• libsCss :: [Html ()]

  css library links

• libsJs :: [Html ()]

  javascript library links

• cssBody :: RepCss

  css

• jsGlobal :: RepJs

  javascript with global scope

• jsOnLoad :: RepJs

  javascript included within the onLoad function

• htmlHeader :: Html ()

  html within the header

• htmlBody :: Html ()

  body html

Instances

Monoid Page

Defined in Web.Rep.Page

Methods

mempty :: Page

mappend :: Page -> Page -> Page

mconcat :: [Page] -> Page

Semigroup Page

Defined in Web.Rep.Page

Methods

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

sconcat :: NonEmpty Page -> Page

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

Generic Page

Defined in Web.Rep.Page

Associated Types

type Rep Page :: Type -> Type

Methods

from :: Page -> Rep Page x

to :: Rep Page x -> Page

Show Page

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> Page -> ShowS

show :: Page -> String

showList :: [Page] -> ShowS

type Rep Page

Defined in Web.Rep.Page

type Rep Page = D1 ('MetaData "Page" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" '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 RepCss))) :*: ((S1 ('MetaSel ('Just "jsGlobal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RepJs) :*: S1 ('MetaSel ('Just "jsOnLoad") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RepJs)) :*: (S1 ('MetaSel ('Just "htmlHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Html ())) :*: S1 ('MetaSel ('Just "htmlBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Html ()))))))

data PageConfig

Configuration options when rendering a Page.

Constructors

PageConfig

Fields

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

Instances

Generic PageConfig

Defined in Web.Rep.Page

Associated Types

type Rep PageConfig :: Type -> Type

Methods

from :: PageConfig -> Rep PageConfig x

to :: Rep PageConfig x -> PageConfig

Show PageConfig

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageConfig -> ShowS

show :: PageConfig -> String

showList :: [PageConfig] -> ShowS

Eq PageConfig

Defined in Web.Rep.Page

Methods

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

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

type Rep PageConfig

Defined in Web.Rep.Page

type Rep PageConfig = D1 ('MetaData "PageConfig" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" '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

Default configuration is inline ecma and css, separate html header and body, minified code, with the suggested filename prefix.

data Concerns a

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

Concerns abstracts this structural feature of a web page.

Constructors

Concerns

Fields

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

Instances

Foldable Concerns

Defined in Web.Rep.Page

Methods

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

foldMap :: Monoid m => (a -> m) -> Concerns a -> 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.Rep.Page

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)

Applicative Concerns

Defined in Web.Rep.Page

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

Functor Concerns

Defined in Web.Rep.Page

Methods

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

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

Generic (Concerns a)

Defined in Web.Rep.Page

Associated Types

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

Methods

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

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

Show a => Show (Concerns a)

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> Concerns a -> ShowS

show :: Concerns a -> String

showList :: [Concerns a] -> ShowS

Eq a => Eq (Concerns a)

Defined in Web.Rep.Page

Methods

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

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

type Rep (Concerns a)

Defined in Web.Rep.Page

type Rep (Concerns a) = D1 ('MetaData "Concerns" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" '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 (typically in a html file) or be separated (tyypically into separate files and linked in the html file)?

Constructors

Inline

Separated

Instances

Generic PageConcerns

Defined in Web.Rep.Page

Associated Types

type Rep PageConcerns :: Type -> Type

Methods

from :: PageConcerns -> Rep PageConcerns x

to :: Rep PageConcerns x -> PageConcerns

Show PageConcerns

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageConcerns -> ShowS

show :: PageConcerns -> String

showList :: [PageConcerns] -> ShowS

Eq PageConcerns

Defined in Web.Rep.Page

Methods

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

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

type Rep PageConcerns

Defined in Web.Rep.Page

type Rep PageConcerns = D1 ('MetaData "PageConcerns" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" '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

Generic PageStructure

Defined in Web.Rep.Page

Associated Types

type Rep PageStructure :: Type -> Type

Methods

from :: PageStructure -> Rep PageStructure x

to :: Rep PageStructure x -> PageStructure

Show PageStructure

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageStructure -> ShowS

show :: PageStructure -> String

showList :: [PageStructure] -> ShowS

Eq PageStructure

Defined in Web.Rep.Page

Methods

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

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

type Rep PageStructure

Defined in Web.Rep.Page

type Rep PageStructure = D1 ('MetaData "PageStructure" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" '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

Generic PageRender

Defined in Web.Rep.Page

Associated Types

type Rep PageRender :: Type -> Type

Methods

from :: PageRender -> Rep PageRender x

to :: Rep PageRender x -> PageRender

Show PageRender

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> PageRender -> ShowS

show :: PageRender -> String

showList :: [PageRender] -> ShowS

Eq PageRender

Defined in Web.Rep.Page

Methods

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

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

type Rep PageRender

Defined in Web.Rep.Page

type Rep PageRender = D1 ('MetaData "PageRender" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" '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 RepCss

Unifies css as either a Css or as Text.

Constructors

RepCss Css

RepCssText Text

Instances

Monoid RepCss

Defined in Web.Rep.Page

Methods

mempty :: RepCss

mappend :: RepCss -> RepCss -> RepCss

mconcat :: [RepCss] -> RepCss

Semigroup RepCss

Defined in Web.Rep.Page

Methods

(<>) :: RepCss -> RepCss -> RepCss

sconcat :: NonEmpty RepCss -> RepCss

stimes :: Integral b => b -> RepCss -> RepCss

Generic RepCss

Defined in Web.Rep.Page

Associated Types

type Rep RepCss :: Type -> Type

Methods

from :: RepCss -> Rep RepCss x

to :: Rep RepCss x -> RepCss

Show RepCss

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> RepCss -> ShowS

show :: RepCss -> String

showList :: [RepCss] -> ShowS

type Rep RepCss

Defined in Web.Rep.Page

type Rep RepCss = D1 ('MetaData "RepCss" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" 'False) (C1 ('MetaCons "RepCss" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Css)) :+: C1 ('MetaCons "RepCssText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

renderCss :: Css -> Text

Render Css as text.

renderRepCss :: PageRender -> RepCss -> Text

Render RepCss as text.

newtype JS

wrapper for JSAST

Constructors

JS

Fields

• unJS :: JSAST

Instances

Monoid JS

Defined in Web.Rep.Page

Methods

mempty :: JS

mappend :: JS -> JS -> JS

mconcat :: [JS] -> JS

Semigroup JS

Defined in Web.Rep.Page

Methods

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

sconcat :: NonEmpty JS -> JS

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

Generic JS

Defined in Web.Rep.Page

Associated Types

type Rep JS :: Type -> Type

Methods

from :: JS -> Rep JS x

to :: Rep JS x -> JS

Show JS

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> JS -> ShowS

show :: JS -> String

showList :: [JS] -> ShowS

Eq JS

Defined in Web.Rep.Page

Methods

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

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

type Rep JS

Defined in Web.Rep.Page

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

data RepJs

Unifies javascript as JSStatement and script as Text.

Constructors

RepJs JS

RepJsText Text

Instances

Monoid RepJs

Defined in Web.Rep.Page

Methods

mempty :: RepJs

mappend :: RepJs -> RepJs -> RepJs

mconcat :: [RepJs] -> RepJs

Semigroup RepJs

Defined in Web.Rep.Page

Methods

(<>) :: RepJs -> RepJs -> RepJs

sconcat :: NonEmpty RepJs -> RepJs

stimes :: Integral b => b -> RepJs -> RepJs

Generic RepJs

Defined in Web.Rep.Page

Associated Types

type Rep RepJs :: Type -> Type

Methods

from :: RepJs -> Rep RepJs x

to :: Rep RepJs x -> RepJs

Show RepJs

Defined in Web.Rep.Page

Methods

showsPrec :: Int -> RepJs -> ShowS

show :: RepJs -> String

showList :: [RepJs] -> ShowS

Eq RepJs

Defined in Web.Rep.Page

Methods

(==) :: RepJs -> RepJs -> Bool

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

type Rep RepJs

Defined in Web.Rep.Page

type Rep RepJs = D1 ('MetaData "RepJs" "Web.Rep.Page" "web-rep-0.10.2.0-B2YHxkxT2gHDHhcJpNYihj" 'False) (C1 ('MetaCons "RepJs" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JS)) :+: C1 ('MetaCons "RepJsText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

onLoad :: RepJs -> RepJs

Wrap js in standard DOM window loader.

renderRepJs :: PageRender -> RepJs -> Text

Render RepJs as Text.

parseJs :: Text -> JS

Convert Text to JS, throwing an error on incorrectness.

renderJs :: JS -> Text

Render JS as Text.