Web.View.Types

Documentation

data Content

Constructors

Node Element

Text Text

Raw Text

Raw embedded HTML or SVG. See raw

Instances

Show Content

Defined in Web.View.Types

Methods

showsPrec :: Int -> Content -> ShowS

show :: Content -> String

showList :: [Content] -> ShowS

Eq Content

Defined in Web.View.Types

Methods

(==) :: Content -> Content -> Bool

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

data Element

A single HTML tag. Note that the class attribute is stored separately from the rest of the attributes to make adding styles easier

Constructors

Element

Fields

• inline :: Bool
• name :: Name
• attributes :: Attributes ()
• children :: [Content]

Instances

Show Element

Defined in Web.View.Types

Methods

showsPrec :: Int -> Element -> ShowS

show :: Element -> String

showList :: [Element] -> ShowS

Eq Element

Defined in Web.View.Types

Methods

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

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

element :: forall {k} (c :: k). Name -> Attributes c -> [Content] -> Element

Construct an Element

data Attributes (c :: k)

The Attributes for an Element. Classes are merged and managed separately from the other attributes.

Constructors

Attributes

Fields

• classes :: CSS
• other :: Map Name AttValue

Instances

Monoid (Attributes c)

Defined in Web.View.Types

Methods

mempty :: Attributes c

mappend :: Attributes c -> Attributes c -> Attributes c

mconcat :: [Attributes c] -> Attributes c

Semigroup (Attributes c)

Defined in Web.View.Types

Methods

(<>) :: Attributes c -> Attributes c -> Attributes c

sconcat :: NonEmpty (Attributes c) -> Attributes c

stimes :: Integral b => b -> Attributes c -> Attributes c

Show (Attributes c)

Defined in Web.View.Types

Methods

showsPrec :: Int -> Attributes c -> ShowS

show :: Attributes c -> String

showList :: [Attributes c] -> ShowS

Eq (Attributes c)

Defined in Web.View.Types

Methods

(==) :: Attributes c -> Attributes c -> Bool

(/=) :: Attributes c -> Attributes c -> Bool

type Attribute = (Name, AttValue)

type Name = Text

type AttValue = Text

Attribute Modifiers

type Mod context = Attributes context -> Attributes context

Element functions expect a modifier function as their first argument. These can add attributes and classes. Combine multiple Mods with (.)

userEmail :: User -> View c ()
userEmail user = input (fontSize 16 . active) (text user.email)
  where
    active = isActive user then bold else id

If you don't want to specify any attributes, you can use id

plainView :: View c ()
plainView = el id "No styles"

Atomic CSS

type CSS = Map Selector Class

All the atomic classes used in a View

data Class

Atomic classes include a selector and the corresponding styles

Constructors

Class

Fields

• selector :: Selector
• properties :: Styles

Instances

Show Class

Defined in Web.View.Types

Methods

showsPrec :: Int -> Class -> ShowS

show :: Class -> String

showList :: [Class] -> ShowS

Eq Class

Defined in Web.View.Types

Methods

(==) :: Class -> Class -> Bool

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

type Styles = Map Name StyleValue

The styles to apply for a given atomic Class

type Ancestor = Text

A parent selector limits the selector to only apply when a descendent of the parent in question

data ChildCombinator

A child selector limits

Constructors

AllChildren

ChildWithName Text

Instances

IsString ChildCombinator

Defined in Web.View.Types

Methods

fromString :: String -> ChildCombinator

Show ChildCombinator

Defined in Web.View.Types

Methods

showsPrec :: Int -> ChildCombinator -> ShowS

show :: ChildCombinator -> String

showList :: [ChildCombinator] -> ShowS

Eq ChildCombinator

Defined in Web.View.Types

Methods

(==) :: ChildCombinator -> ChildCombinator -> Bool

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

Ord ChildCombinator

Defined in Web.View.Types

Methods

compare :: ChildCombinator -> ChildCombinator -> Ordering

(<) :: ChildCombinator -> ChildCombinator -> Bool

(<=) :: ChildCombinator -> ChildCombinator -> Bool

(>) :: ChildCombinator -> ChildCombinator -> Bool

(>=) :: ChildCombinator -> ChildCombinator -> Bool

max :: ChildCombinator -> ChildCombinator -> ChildCombinator

min :: ChildCombinator -> ChildCombinator -> ChildCombinator

data Selector

The selector to use for the given atomic Class

Constructors

Selector

Fields

• media :: Maybe Media
• ancestor :: Maybe Ancestor
• child :: Maybe ChildCombinator
• pseudo :: Maybe Pseudo
• className :: ClassName

Instances

IsString Selector

Defined in Web.View.Types

Methods

fromString :: String -> Selector

Show Selector

Defined in Web.View.Types

Methods

showsPrec :: Int -> Selector -> ShowS

show :: Selector -> String

showList :: [Selector] -> ShowS

Eq Selector

Defined in Web.View.Types

Methods

(==) :: Selector -> Selector -> Bool

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

Ord Selector

Defined in Web.View.Types

Methods

compare :: Selector -> Selector -> Ordering

(<) :: Selector -> Selector -> Bool

(<=) :: Selector -> Selector -> Bool

(>) :: Selector -> Selector -> Bool

(>=) :: Selector -> Selector -> Bool

max :: Selector -> Selector -> Selector

min :: Selector -> Selector -> Selector

selector :: ClassName -> Selector

Create a Selector given only a ClassName

newtype ClassName

A class name

Constructors

ClassName

Fields

• text :: Text

Instances

IsString ClassName

Defined in Web.View.Types

Methods

fromString :: String -> ClassName

Monoid ClassName

Defined in Web.View.Types

Methods

mempty :: ClassName

mappend :: ClassName -> ClassName -> ClassName

mconcat :: [ClassName] -> ClassName

Semigroup ClassName

Defined in Web.View.Types

Methods

(<>) :: ClassName -> ClassName -> ClassName

sconcat :: NonEmpty ClassName -> ClassName

stimes :: Integral b => b -> ClassName -> ClassName

Show ClassName

Defined in Web.View.Types

Methods

showsPrec :: Int -> ClassName -> ShowS

show :: ClassName -> String

showList :: [ClassName] -> ShowS

Eq ClassName

Defined in Web.View.Types

Methods

(==) :: ClassName -> ClassName -> Bool

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

Ord ClassName

Defined in Web.View.Types

Methods

compare :: ClassName -> ClassName -> Ordering

(<) :: ClassName -> ClassName -> Bool

(<=) :: ClassName -> ClassName -> Bool

(>) :: ClassName -> ClassName -> Bool

(>=) :: ClassName -> ClassName -> Bool

max :: ClassName -> ClassName -> ClassName

min :: ClassName -> ClassName -> ClassName

className :: Text -> ClassName

Create a class name, escaping special characters

class ToClassName a where

Convert a type into a className segment to generate unique compound style names based on the value

Minimal complete definition

Nothing

Methods

toClassName :: a -> ClassName

default toClassName :: Show a => a -> ClassName

Instances

ToClassName Text

Defined in Web.View.Types

Methods

toClassName :: Text -> ClassName

ToClassName Display

Defined in Web.View.Style

Methods

toClassName :: Display -> ClassName

ToClassName Inner

Defined in Web.View.Style

Methods

toClassName :: Inner -> ClassName

ToClassName ListType

Defined in Web.View.Style

Methods

toClassName :: ListType -> ClassName

ToClassName Position

Defined in Web.View.Style

Methods

toClassName :: Position -> ClassName

ToClassName Align

Defined in Web.View.Types

Methods

toClassName :: Align -> ClassName

ToClassName HexColor

Defined in Web.View.Types

Methods

toClassName :: HexColor -> ClassName

ToClassName Length

Defined in Web.View.Types

Methods

toClassName :: Length -> ClassName

ToClassName Ms

Defined in Web.View.Types

Methods

toClassName :: Ms -> ClassName

ToClassName None

Defined in Web.View.Types

Methods

toClassName :: None -> ClassName

ToClassName PxRem

Defined in Web.View.Types

Methods

toClassName :: PxRem -> ClassName

ToClassName ()

Defined in Web.View.Types

Methods

toClassName :: () -> ClassName

ToClassName Float

Defined in Web.View.Types

Methods

toClassName :: Float -> ClassName

ToClassName Int

Defined in Web.View.Types

Methods

toClassName :: Int -> ClassName

data Pseudo

Psuedos allow for specifying styles that only apply in certain conditions. See hover etc

el (color Primary . hover (color White)) "hello"

Constructors

Hover

Active

Even

Odd

Instances

Show Pseudo

Defined in Web.View.Types

Methods

showsPrec :: Int -> Pseudo -> ShowS

show :: Pseudo -> String

showList :: [Pseudo] -> ShowS

Eq Pseudo

Defined in Web.View.Types

Methods

(==) :: Pseudo -> Pseudo -> Bool

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

Ord Pseudo

Defined in Web.View.Types

Methods

compare :: Pseudo -> Pseudo -> Ordering

(<) :: Pseudo -> Pseudo -> Bool

(<=) :: Pseudo -> Pseudo -> Bool

(>) :: Pseudo -> Pseudo -> Bool

(>=) :: Pseudo -> Pseudo -> Bool

max :: Pseudo -> Pseudo -> Pseudo

min :: Pseudo -> Pseudo -> Pseudo

newtype StyleValue

The value of a css style property

Constructors

StyleValue String

Instances

IsString StyleValue

Defined in Web.View.Types

Methods

fromString :: String -> StyleValue

Monoid StyleValue

Defined in Web.View.Types

Methods

mempty :: StyleValue

mappend :: StyleValue -> StyleValue -> StyleValue

mconcat :: [StyleValue] -> StyleValue

Semigroup StyleValue

Defined in Web.View.Types

Methods

(<>) :: StyleValue -> StyleValue -> StyleValue

sconcat :: NonEmpty StyleValue -> StyleValue

stimes :: Integral b => b -> StyleValue -> StyleValue

Show StyleValue

Defined in Web.View.Types

Methods

showsPrec :: Int -> StyleValue -> ShowS

show :: StyleValue -> String

showList :: [StyleValue] -> ShowS

Eq StyleValue

Defined in Web.View.Types

Methods

(==) :: StyleValue -> StyleValue -> Bool

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

ToStyleValue StyleValue

Defined in Web.View.Types

Methods

toStyleValue :: StyleValue -> StyleValue

class ToStyleValue a where

Use a type as a css style property value

Minimal complete definition

Nothing

Methods

toStyleValue :: a -> StyleValue

default toStyleValue :: Show a => a -> StyleValue

Instances

ToStyleValue Text

Defined in Web.View.Types

Methods

toStyleValue :: Text -> StyleValue

ToStyleValue Display

Defined in Web.View.Style

Methods

toStyleValue :: Display -> StyleValue

ToStyleValue ListType

Defined in Web.View.Style

Methods

toStyleValue :: ListType -> StyleValue

ToStyleValue Position

Defined in Web.View.Style

Methods

toStyleValue :: Position -> StyleValue

ToStyleValue Align

Defined in Web.View.Types

Methods

toStyleValue :: Align -> StyleValue

ToStyleValue HexColor

Defined in Web.View.Types

Methods

toStyleValue :: HexColor -> StyleValue

ToStyleValue Length

Defined in Web.View.Types

Methods

toStyleValue :: Length -> StyleValue

ToStyleValue Ms

Defined in Web.View.Types

Methods

toStyleValue :: Ms -> StyleValue

ToStyleValue None

Defined in Web.View.Types

Methods

toStyleValue :: None -> StyleValue

ToStyleValue PxRem

Defined in Web.View.Types

Methods

toStyleValue :: PxRem -> StyleValue

ToStyleValue StyleValue

Defined in Web.View.Types

Methods

toStyleValue :: StyleValue -> StyleValue

ToStyleValue String

Defined in Web.View.Types

Methods

toStyleValue :: String -> StyleValue

ToStyleValue Float

Defined in Web.View.Types

Methods

toStyleValue :: Float -> StyleValue

ToStyleValue Int

Defined in Web.View.Types

Methods

toStyleValue :: Int -> StyleValue

data Length

Constructors

PxRem PxRem

Pct Float

Instances

Num Length

Defined in Web.View.Types

Methods

(+) :: Length -> Length -> Length

(-) :: Length -> Length -> Length

(*) :: Length -> Length -> Length

negate :: Length -> Length

abs :: Length -> Length

signum :: Length -> Length

fromInteger :: Integer -> Length

Show Length

Defined in Web.View.Types

Methods

showsPrec :: Int -> Length -> ShowS

show :: Length -> String

showList :: [Length] -> ShowS

ToClassName Length

Defined in Web.View.Types

Methods

toClassName :: Length -> ClassName

ToStyleValue Length

Defined in Web.View.Types

Methods

toStyleValue :: Length -> StyleValue

newtype PxRem

Px, converted to Rem. Allows for the user to change the document font size and have the app scale accordingly. But allows the programmer to code in pixels to match a design

Constructors

PxRem' Int

Instances

Enum PxRem

Defined in Web.View.Types

Methods

succ :: PxRem -> PxRem

pred :: PxRem -> PxRem

toEnum :: Int -> PxRem

fromEnum :: PxRem -> Int

enumFrom :: PxRem -> [PxRem]

enumFromThen :: PxRem -> PxRem -> [PxRem]

enumFromTo :: PxRem -> PxRem -> [PxRem]

enumFromThenTo :: PxRem -> PxRem -> PxRem -> [PxRem]

Num PxRem

Defined in Web.View.Types

Methods

(+) :: PxRem -> PxRem -> PxRem

(-) :: PxRem -> PxRem -> PxRem

(*) :: PxRem -> PxRem -> PxRem

negate :: PxRem -> PxRem

abs :: PxRem -> PxRem

signum :: PxRem -> PxRem

fromInteger :: Integer -> PxRem

Integral PxRem

Defined in Web.View.Types

Methods

quot :: PxRem -> PxRem -> PxRem

rem :: PxRem -> PxRem -> PxRem

div :: PxRem -> PxRem -> PxRem

mod :: PxRem -> PxRem -> PxRem

quotRem :: PxRem -> PxRem -> (PxRem, PxRem)

divMod :: PxRem -> PxRem -> (PxRem, PxRem)

toInteger :: PxRem -> Integer

Real PxRem

Defined in Web.View.Types

Methods

toRational :: PxRem -> Rational

Show PxRem

Defined in Web.View.Types

Methods

showsPrec :: Int -> PxRem -> ShowS

show :: PxRem -> String

showList :: [PxRem] -> ShowS

Eq PxRem

Defined in Web.View.Types

Methods

(==) :: PxRem -> PxRem -> Bool

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

Ord PxRem

Defined in Web.View.Types

Methods

compare :: PxRem -> PxRem -> Ordering

(<) :: PxRem -> PxRem -> Bool

(<=) :: PxRem -> PxRem -> Bool

(>) :: PxRem -> PxRem -> Bool

(>=) :: PxRem -> PxRem -> Bool

max :: PxRem -> PxRem -> PxRem

min :: PxRem -> PxRem -> PxRem

ToClassName PxRem

Defined in Web.View.Types

Methods

toClassName :: PxRem -> ClassName

ToStyleValue PxRem

Defined in Web.View.Types

Methods

toStyleValue :: PxRem -> StyleValue

newtype Ms

Milliseconds, used for transitions

Constructors

Ms Int

Instances

Num Ms

Defined in Web.View.Types

Methods

(+) :: Ms -> Ms -> Ms

(-) :: Ms -> Ms -> Ms

(*) :: Ms -> Ms -> Ms

negate :: Ms -> Ms

abs :: Ms -> Ms

signum :: Ms -> Ms

fromInteger :: Integer -> Ms

Show Ms

Defined in Web.View.Types

Methods

showsPrec :: Int -> Ms -> ShowS

show :: Ms -> String

showList :: [Ms] -> ShowS

ToClassName Ms

Defined in Web.View.Types

Methods

toClassName :: Ms -> ClassName

ToStyleValue Ms

Defined in Web.View.Types

Methods

toStyleValue :: Ms -> StyleValue

data Media

Media allows for responsive designs that change based on characteristics of the window. See Layout Example

Constructors

MinWidth Int

MaxWidth Int

Instances

Show Media

Defined in Web.View.Types

Methods

showsPrec :: Int -> Media -> ShowS

show :: Media -> String

showList :: [Media] -> ShowS

Eq Media

Defined in Web.View.Types

Methods

(==) :: Media -> Media -> Bool

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

Ord Media

Defined in Web.View.Types

Methods

compare :: Media -> Media -> Ordering

(<) :: Media -> Media -> Bool

(<=) :: Media -> Media -> Bool

(>) :: Media -> Media -> Bool

(>=) :: Media -> Media -> Bool

max :: Media -> Media -> Media

min :: Media -> Media -> Media

data Sides a

Options for styles that support specifying various sides. This has a "fake" Num instance to support literals

border 5
border (X 2)
border (TRBL 0 5 0 0)

Constructors

All a

TRBL a a a a

X a

Y a

XY a a

T a

R a

B a

L a

Instances

Num a => Num (Sides a)

Defined in Web.View.Types

Methods

(+) :: Sides a -> Sides a -> Sides a

(-) :: Sides a -> Sides a -> Sides a

(*) :: Sides a -> Sides a -> Sides a

negate :: Sides a -> Sides a

abs :: Sides a -> Sides a

signum :: Sides a -> Sides a

fromInteger :: Integer -> Sides a

newtype FlatAttributes

Element's attributes do not include class, which is separated. FlatAttributes generate the class attribute and include it

Constructors

FlatAttributes

Fields

• attributes :: Map Name AttValue

Instances

Generic FlatAttributes

Defined in Web.View.Types

Associated Types

type Rep FlatAttributes

Defined in Web.View.Types

type Rep FlatAttributes = D1 ('MetaData "FlatAttributes" "Web.View.Types" "web-view-0.6.2-inplace" 'True) (C1 ('MetaCons "FlatAttributes" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Name AttValue))))

Methods

from :: FlatAttributes -> Rep FlatAttributes x

to :: Rep FlatAttributes x -> FlatAttributes

type Rep FlatAttributes

Defined in Web.View.Types

type Rep FlatAttributes = D1 ('MetaData "FlatAttributes" "Web.View.Types" "web-view-0.6.2-inplace" 'True) (C1 ('MetaCons "FlatAttributes" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Name AttValue))))

Colors

class ToColor a where

ToColor allows you to create a type containing your application's colors:

data AppColor
  = White
  | Primary
  | Dark

instance ToColor AppColor where
  colorValue White = "#FFF"
  colorValue Dark = "#333"
  colorValue Primary = "#00F"

hello :: View c ()
hello = el (bg Primary . color White) "Hello"

Minimal complete definition

colorValue

Methods

colorValue :: a -> HexColor

colorName :: a -> Text

default colorName :: Show a => a -> Text

Instances

ToColor HexColor

Defined in Web.View.Types

Methods

colorValue :: HexColor -> HexColor

colorName :: HexColor -> Text

newtype HexColor

Hexidecimal Color. Can be specified with or without the leading #. Recommended to use an AppColor type instead of manually using hex colors. See ToColor

Constructors

HexColor Text

Instances

IsString HexColor

Defined in Web.View.Types

Methods

fromString :: String -> HexColor

Show HexColor

Defined in Web.View.Types

Methods

showsPrec :: Int -> HexColor -> ShowS

show :: HexColor -> String

showList :: [HexColor] -> ShowS

ToClassName HexColor

Defined in Web.View.Types

Methods

toClassName :: HexColor -> ClassName

ToColor HexColor

Defined in Web.View.Types

Methods

colorValue :: HexColor -> HexColor

colorName :: HexColor -> Text

ToStyleValue HexColor

Defined in Web.View.Types

Methods

toStyleValue :: HexColor -> StyleValue

data Align

Constructors

AlignCenter

AlignLeft

AlignRight

AlignJustify

Instances

Show Align

Defined in Web.View.Types

Methods

showsPrec :: Int -> Align -> ShowS

show :: Align -> String

showList :: [Align] -> ShowS

ToClassName Align

Defined in Web.View.Types

Methods

toClassName :: Align -> ClassName

ToStyleValue Align

Defined in Web.View.Types

Methods

toStyleValue :: Align -> StyleValue

data None

Constructors

None

Instances

Show None

Defined in Web.View.Types

Methods

showsPrec :: Int -> None -> ShowS

show :: None -> String

showList :: [None] -> ShowS

ToClassName None

Defined in Web.View.Types

Methods

toClassName :: None -> ClassName

ToStyleValue None

Defined in Web.View.Types

Methods

toStyleValue :: None -> StyleValue

Style Display None

Defined in Web.View.Style

Methods

styleValue :: None -> StyleValue

Style ListType None

Defined in Web.View.Style

Methods

styleValue :: None -> StyleValue

Style Shadow None

Defined in Web.View.Style

Methods

styleValue :: None -> StyleValue