GHCJS.HPlay.View

Documentation

newtype Widget a

Constructors

Widget

Fields

• norender :: TransIO a

Instances

Monad Widget

Methods

(>>=) :: Widget a -> (a -> Widget b) -> Widget b

(>>) :: Widget a -> Widget b -> Widget b

return :: a -> Widget a

fail :: String -> Widget a

Functor Widget

Methods

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

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

Applicative Widget

Methods

pure :: a -> Widget a

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

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

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

Alternative Widget

Methods

empty :: Widget a

(<|>) :: Widget a -> Widget a -> Widget a

some :: Widget a -> Widget [a]

many :: Widget a -> Widget [a]

MonadPlus Widget

Methods

mzero :: Widget a

mplus :: Widget a -> Widget a -> Widget a

MonadIO Widget

Methods

liftIO :: IO a -> Widget a

AdditionalOperators Widget

Methods

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

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

atEnd' :: Widget a -> Widget b -> Widget a

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

atEnd :: Widget a -> Widget b -> Widget a

MonadState EventF Widget

Methods

get :: Widget EventF

put :: EventF -> Widget ()

state :: (EventF -> (a, EventF)) -> Widget a

(Eq a, Num a) => Num (Widget a)

Methods

(+) :: Widget a -> Widget a -> Widget a

(-) :: Widget a -> Widget a -> Widget a

(*) :: Widget a -> Widget a -> Widget a

negate :: Widget a -> Widget a

abs :: Widget a -> Widget a

signum :: Widget a -> Widget a

fromInteger :: Integer -> Widget a

Monoid a => Monoid (Widget a)

Methods

mempty :: Widget a

mappend :: Widget a -> Widget a -> Widget a

mconcat :: [Widget a] -> Widget a

Attributable (Widget a)

Methods

(!) :: Widget a -> Attribute -> Widget a

Running it

module Transient.Move.Utils

runBody :: Widget a -> IO (Maybe a)

run the widget as the body of the HTML. It adds the rendering to the body of the document.

Use only for pure client-side applications, like the ones of http://http://tryplayg.herokuapp.com

addHeader :: Perch -> IO ()

add a header in the header tag

render :: Widget a -> TransIO a

executes the computation and add the effect of "hanging" the generated rendering from the one generated by the previous render sentence, or from the body of the document, if there isn't any. If an event happens within the render parameter, it deletes the rendering of all subsequent ones. so that the sucessive sequence of render in the code will reconstruct them again. However the rendering of elements combined with <|> or <> or <*> are independent. This allows for full dynamic and composable client-side Web apps.

runWidget' :: Widget b -> Elem -> Widget b

addSData :: (MonadState EventF m, Typeable a, Monoid a) => a -> m ()

Widget Combinators and Modifiers

(<<) :: (Perch -> Perch) -> Perch -> Perch infixr 7

A parameter application with lower priority than ($) and direct function application

(<<<) :: (Perch -> Perch) -> Widget a -> Widget a infixr 5

Enclose Widgets within some formating. view is intended to be instantiated to a particular format

NOTE: It has a infix priority : infixr 5 less than the one of ++> and <++ of the operators, so use parentheses when appropriate, unless the we want to enclose all the widgets in the right side. Most of the type errors in the DSL are due to the low priority of this operator.

(<!) :: Widget a -> Attribs -> Widget a infixl 8

Add attributes to the topmost tag of a widget

(<++) :: Widget a -> Perch -> Widget a infixr 6

Append formatting code to a widget

 getString "hi" <++ H1 << "hi there"

It has a infix prority: infixr 6 higuer that <<< and most other operators

(++>) :: Perch -> Widget a -> Widget a infixr 6

Prepend formatting code to a widget

bold "enter name" ++ getString Nothing

It has a infix prority: infixr 6 higher that <<< and most other operators

validate :: Widget a -> (a -> StateIO (Maybe Perch)) -> Widget a

Validates a form or widget result against a validating procedure

getOdd= getInt Nothing validate (x -> return $ if mod x 2==0 then  Nothing else Just "only odd numbers, please")

wcallback :: Widget a -> (a -> Widget b) -> Widget b

It is a callback in the view monad. The rendering of the second parameter substitutes the rendering of the first paramenter when the latter validates without afecting the rendering of other widgets.

Basic Widgets

option :: (Typeable b, Show b) => b -> String -> Widget b

use this instead of option when runing in the browser

wprint :: ToElem a => a -> Widget ()

show something enclosed in the pre tag, so ASCII formatting chars are honored

getString :: Maybe String -> Widget String

Display a text box and return a non empty String

inputString :: Maybe String -> Widget String

getInteger :: Maybe Integer -> Widget Integer

Display a text box and return an Integer (if the value entered is not an Integer, fails the validation)

inputInteger :: Maybe Integer -> Widget Integer

getInt :: Maybe Int -> Widget Int

Display a text box and return a Int (if the value entered is not an Int, fails the validation)

inputInt :: Maybe Int -> Widget Int

inputFloat :: Maybe Float -> Widget Float

inputDouble :: Maybe Double -> Widget Double

getPassword :: Widget String

Display a password box

inputPassword :: Widget String

setRadio :: (Typeable a, Eq a, Show a) => a -> Widget (Radio a)

Implement a radio button the parameter is the name of the radio group

setRadioActive :: (Typeable a, Eq a, Show a) => a -> Widget (Radio a)

getRadio :: Monoid a => [Widget (Radio a)] -> Widget a

encloses a set of Radio boxes. Return the option selected

setCheckBox :: (Typeable a, Show a) => Bool -> a -> Widget (CheckBoxes a)

Display a text box and return the value entered if it is readable( Otherwise, fail the validation)

getCheckBoxes :: Show a => Widget (CheckBoxes a) -> Widget [a]

getTextBox :: (Typeable a, Show a, Read a) => Maybe a -> Widget a

getMultilineText :: JSString -> Widget String

Display a multiline text box and return its content

textArea :: JSString -> Widget String

A synonim of getMultilineText

getBool :: Bool -> String -> String -> Widget Bool

getSelect :: (Typeable a, Read a, Show a) => Widget (MFOption a) -> Widget a

Display a dropdown box with the options in the first parameter is optionally selected . It returns the selected option.

setOption :: (Show a, Eq a, Typeable a) => a -> Perch -> Widget (MFOption a)

Set the option for getSelect. Options are concatenated with <|>

setSelectedOption :: (Show a, Eq a, Typeable a) => a -> Perch -> Widget (MFOption a)

Set the selected option for getSelect. Options are concatenated with <|>

wlabel :: Perch -> Widget a -> Widget a

resetButton :: JSString -> Widget ()

inputReset :: JSString -> Widget ()

submitButton :: (Read a, Show a, Typeable a) => a -> Widget a

inputSubmit :: (Read a, Show a, Typeable a) => a -> Widget a

wbutton :: a -> JSString -> Widget a

active button. When clicked, return the first parameter

wlink :: (Show a, Typeable a) => a -> Perch -> Widget a

Present a link. It return the first parameter and execute the continuation when it is clicked.

It also update the path in the URL.

tlink :: (Show a, Read a, Typeable a) => a -> Perch -> Widget a

Present a link. Return the first parameter when clicked

template link. Besides the wlink behaviour, it loads the page from the server if there is any

the page many have been saved with edit

noWidget :: Widget a

Empty widget that does not validate. May be used as "empty boxes" inside larger widgets.

It returns a non valid value.

wraw :: Perch -> Widget ()

Render raw view formatting. It is useful for displaying information.

rawHtml :: Perch -> Widget ()

wraw synonym

isEmpty :: Widget a -> Widget Bool

True if the widget has no valid input

Events

data BrowserEvent

Constructors

OnLoad

OnUnload

OnChange

OnFocus

OnMouseMove

OnMouseOver

OnMouseOut

OnClick

OnDblClick

OnMouseDown

OnMouseUp

OnBlur

OnKeyPress

OnKeyUp

OnKeyDown

Instances

Show BrowserEvent

Methods

showsPrec :: Int -> BrowserEvent -> ShowS

show :: BrowserEvent -> String

showList :: [BrowserEvent] -> ShowS

IsEvent BrowserEvent

Methods

eventName :: BrowserEvent -> JSString

buildHandler :: Elem -> BrowserEvent -> (EventData -> IO ()) -> IO ()

Out of Flow Updates

data UpdateMethod

Constructors

Append

Prepend

Insert

Instances

Show UpdateMethod

Methods

showsPrec :: Int -> UpdateMethod -> ShowS

show :: UpdateMethod -> String

showList :: [UpdateMethod] -> ShowS

at :: JSString -> UpdateMethod -> Widget a -> Widget a

Run the widget as the content of the element with the given id. The content can be appended, prepended to the previous content or it can be the only content depending on the update method.

at' :: JSString -> UpdateMethod -> Cloud a -> Cloud a

Reactive and Events

class Typeable a => IsEvent a where

Minimal complete definition

eventName, buildHandler

Methods

eventName :: a -> JSString

buildHandler :: Elem -> a -> (EventData -> IO ()) -> IO ()

Instances

IsEvent BrowserEvent

Methods

eventName :: BrowserEvent -> JSString

buildHandler :: Elem -> BrowserEvent -> (EventData -> IO ()) -> IO ()

data EventData

Constructors

EventData

Fields

• evName :: JSString
• evData :: Dynamic

Instances

Show EventData

Methods

showsPrec :: Int -> EventData -> ShowS

show :: EventData -> String

showList :: [EventData] -> ShowS

data EvData

Constructors

NoData

Click Int (Int, Int)

Mouse (Int, Int)

MouseOut

Key Int

Instances

Eq EvData

Methods

(==) :: EvData -> EvData -> Bool

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

Show EvData

Methods

showsPrec :: Int -> EvData -> ShowS

show :: EvData -> String

showList :: [EvData] -> ShowS

resetEventData :: Widget ()

getEventData :: Widget EventData

setEventData :: EventData -> Widget ()

raiseEvent :: IsEvent event => Widget a -> event -> Widget a

triggers the event that happens in a widget. The effects are the following:

1)The event reexecutes the monadic sentence where the widget is, (with no re-rendering)

2) with the result of this reevaluaution of 1), the rest of the monadic computation is executed

3) update the DOM tree with the rendering generated by the reevaluation of 2).

As usual, If one step of the monadic computation return empty (stop), the reevaluation finish So the effect of an event can be restricted as much as you may need.

The part of the monadic expression that is before the event is not evaluated and his rendering is untouched. (but, at any moment, you can choose the element to be updated in the page using at)

fire :: IsEvent event => Widget a -> event -> Widget a

A shorter synonym for raiseEvent

wake :: IsEvent event => Widget a -> event -> Widget a

A shorter and smoother synonym for raiseEvent

pass :: IsEvent event => Perch -> event -> Widget EventData

pass trough only if the event is fired in this DOM element. Otherwise, if the code is executing from a previous event, the computation will stop

Low-level and Internals

type ElemID = JSString

class (Monoid view, Typeable view) => FormInput view where

Minimal interface for defining the basic form and link elements. The core of MFlow is agnostic about the rendering package used. Every formatting (either HTML or not) used with MFlow must have an instance of this class. See "MFlow.Forms.Blaze.Html for the instance for blaze-html" MFlow.Forms.XHtml for the instance for Text.XHtml and MFlow.Forms.HSP for the instance for Haskell Server Pages.

Minimal complete definition

fromStr, fromStrNoEncode, ftag, inred, flink, finput, ftextarea, fselect, foption, formAction, attrs

Methods

fromStr :: JSString -> view

fromStrNoEncode :: String -> view

ftag :: JSString -> view -> view

inred :: view -> view

flink :: JSString -> view -> view

flink1 :: JSString -> view

finput :: Name -> Type -> Value -> Checked -> OnClick1 -> view

ftextarea :: JSString -> JSString -> view

fselect :: JSString -> view -> view

foption :: JSString -> view -> Bool -> view

foption1 :: JSString -> Bool -> view

formAction :: JSString -> JSString -> view -> view

attrs :: view -> Attribs -> view

Instances

FormInput Perch

Methods

fromStr :: JSString -> Perch

fromStrNoEncode :: String -> Perch

ftag :: JSString -> Perch -> Perch

inred :: Perch -> Perch

flink :: JSString -> Perch -> Perch

flink1 :: JSString -> Perch

finput :: Name -> Type -> Value -> Checked -> OnClick1 -> Perch

ftextarea :: JSString -> JSString -> Perch

fselect :: JSString -> Perch -> Perch

foption :: JSString -> Perch -> Bool -> Perch

foption1 :: JSString -> Bool -> Perch

formAction :: JSString -> JSString -> Perch -> Perch

attrs :: Perch -> Attribs -> Perch

getNextId :: MonadState EventF m => m JSString

get the next ideitifier that will be created by genNewId

genNewId :: (MonadState EventF m, MonadIO m) => m JSString

continuePerch :: Widget a -> ElemID -> Widget a

when creating a complex widget with many tags, this call indentifies which tag will receive the attributes of the (!) operator.

getParam :: (Typeable a, Show a, Read a) => Maybe JSString -> JSString -> Maybe a -> Widget a

getCont :: TransIO EventF

Get the continuation context: closure, continuation, state, child threads etc

runCont :: EventF -> StateIO (Maybe a)

Run the closure and the continuation using the state data of the calling thread

elemById :: MonadIO m => JSString -> m (Maybe Elem)

withElem :: ElemID -> (Elem -> IO a) -> IO a

getProp :: Elem -> JSString -> IO JSString

setProp :: Elem -> JSString -> JSString -> IO ()

alert :: JSString -> IO ()

fromJSString :: (Typeable a, Read a) => JSString -> a

toJSString :: (Show a, Typeable a) => a -> JSString

getValue :: MonadIO m => Elem -> m (Maybe String)

Re-exported

module Control.Applicative

module GHCJS.Perch

data CheckBoxes a

Constructors

CheckBoxes [a]

Instances

Show a => Show (CheckBoxes a)

Methods

showsPrec :: Int -> CheckBoxes a -> ShowS

show :: CheckBoxes a -> String

showList :: [CheckBoxes a] -> ShowS

Monoid (CheckBoxes a)

Methods

mempty :: CheckBoxes a

mappend :: CheckBoxes a -> CheckBoxes a -> CheckBoxes a

mconcat :: [CheckBoxes a] -> CheckBoxes a

edit :: Cloud a -> Cloud a

edit and save the rendering of the widgets.

The edited content may be saved to a file with th current route by the save option of the editor. tlink will load this page. Also when this route is requested, the server will return this page.