@@ -0,0 +1,204 @@
1+# Reflex-Dom Quick(ish) Reference
2+
3+## Typeclasses
4+
5+Function signatures have been simplified. The 't' type parameter and many typeclass constraints are removed, and annotations are added regarding the monad of the result type (See the Reflex Quickstart for more discussion). Annotations:
6+
7+```haskell
8+[ ] -- Pure function
9+[W] -- Function runs in any monad supporting MonadWidget
10+[I] -- Function runs in IO
11+```
12+
13+Functions from Reflex that run in MonadSample or MonadHold context ([S] or [H]) will also run in [W].
14+
15+## Creating widgets (DOM elements hooked into the FRP system)
16+
17+### Basic widgets
18+
19+These functions generally take an element tag (such as "div", "h1", etc) and a child widget, and produce a widget of the given type containing the child. Some of these functions return data of type `El`, which is a handle to the created DOM element along with a set of potential Events that might occur on that element.
20+
21+Widgets may return any type (this is 'a' in many of the functions below). Often this will be an Event carrying user interactions with the widget.
22+
23+```haskell
24+-- Simplest form. Create a widget of given type containing the given child.
25+-- Return whatever the child returns.
26+[W] el :: String -> m a -> m a
27+
28+-- This version returns the 'El' as well.
29+[W] el' :: String -> m a -> m (El, a)
30+
31+-- These two additionally apply attributes to the element, such as ("class" =: "blah")
32+[W] elAttr :: String -> Map String String -> m a -> m a
33+[W] elAttr' :: String -> Map String String -> m a -> m (El, a)
34+
35+-- As above, but now the attribute map is Dynamic
36+[W] elDynAttr :: String -> Dynamic (Map String String) -> m a -> m a
37+[W] elDynAttr' :: String -> Dynamic (Map String String) -> m a -> m (El, a)
38+
39+-- Shortcut for elAttr when you only want to set the "class" attribute.
40+[W] elClass :: String -> String -> m a -> m a
41+
42+-- Even shorter-cut for above when element type is "div". Create a div of given class.
43+[W] divClass :: String -> m a -> m a
44+
45+-- Create a widget of given type with arbitrary, Dymamic HTML inside.
46+[W] elDynHtml' :: String -> Dynamic String -> m El
47+[W] elDynHtmlAttr' :: String -> Map String String -> Dynamic String -> m El
48+
49+-- Shortcut for elDynHtml' where the type is "div" and you don't need the 'El'.
50+[W] dynHtml :: Dynamic String -> m ()
51+
52+-- Create a static text element
53+[W] text :: String -> m ()
54+
55+-- Create a dynamic text element
56+[W] dynText :: Dynamic String -> m ()
57+[W] display :: Show a => Dynamic a -> m ()
58+
59+-- Create a "button" element with given label, return onClick Event
60+[W] button :: String -> m (Event ())
61+
62+-- Empty widget
63+[W] blank :: m ()
64+```
65+
66+### Dynamic widgets
67+
68+In the Dynamic cases so far, the *content* of a widget is dynamic but the *definition* of the widget is static. The functions below enable the definition and/or structure of the widget itself to change over time.
69+
70+Note the "list" functions do not imply particular HTML tags (ul, li, etc), though the widgets they create can have those tags if you construct them appropriately.
71+
72+```haskell
73+-- Create a dynamically-redefined widget from a Dynamic of widget actions.
74+[W] dyn :: Dynamic (m a) -> m (Event a)
75+
76+-- Same as dyn, but takes initial value and an update Event instead of a Dynamic.
77+[W] widgetHold :: m a -> Event (m a) -> m (Dynamic a)
78+
79+-- Turn a Dynamic key/value map into a set of dynamically-changing widgets.
80+[W] listWithKey :: Ord k =>
81+ Dynamic (Map k v) -> (k -> Dynamic v -> m a ) -> m (Dynamic (Map k a))
82+
83+-- Same as above where the widget constructor doesn't care about the key.
84+[W] list :: Ord k =>
85+ Dynamic (Map k v) -> ( Dynamic v -> m a ) -> m (Dynamic (Map k a))
86+
87+-- Even simpler version where there are no keys and we just use a list.
88+[W] simpleList ::
89+ Dynamic [v] -> ( Dynamic v -> m a ) -> m (Dynamic [a])
90+
91+-- Like listWithKey specialized for widgets returning (Event a).
92+[W] listViewWithKey :: Ord k =>
93+ Dynamic (Map k v) -> (k -> Dynamic v -> m (Event a)) -> m (Event (Map k a))
94+
95+-- Create a dynamically-changing set of widgets, one of which is selected at any time.
96+[W] selectViewListWithKey_ :: Ord k => Dynamic k ->
97+ Dynamic (Map k v) -> (k -> Dynamic v -> Dynamic Bool -> m (Event a)) -> m (Event k)
98+
99+-- Same as listWithKey, but takes initial values and an updates Event instead of a Dynamic.
100+[W] listWithKey' :: Ord k =>
101+ Map k v -> Event (Map k (Maybe v)) -> (k -> v -> Event v -> m a) -> m (Dynamic (Map k a))
102+```
103+
104+### Utility widgets
105+
106+These are useful widgets that are implemented (or could be implemented) in terms of the low-level widgets above.
107+
108+Some of these widget builders take a configuration record and return a record containing Events or other useful data associated with the created widget (similar to 'El'). The configuration records have default values, so you can just supply 'def'. See Reflex/Dom/Widget/Input.hs for record fields (Lenses are provided).
109+
110+```haskell
111+-- Text input.
112+[W] textInput :: TextInputConfig -> m TextInput
113+[ ] textInputGetEnter :: TextInput -> Event ()
114+[W] textArea :: TextAreaConfig -> m TextArea
115+
116+-- Checkbox. The Bool supplies the initial state.
117+[W] checkbox :: Bool -> CheckboxConfig -> m Checkbox
118+
119+-- Dropdown with Dynamic options. First argument is initial state.
120+[W] dropdown :: (Ord k, Show k, Read k) =>
121+ k -> Dynamic (Map k String) -> DropdownConfig k -> m (Dropdown k)
122+
123+-- Table with static columns and dynamic rows.
124+[W] tableDynAttr :: ... -- See Reflex.Dom.Widget.Basic
125+
126+-- Tabbed view that shows only one of its child widgets at a time.
127+[W] tabDisplay :: (Show k, Ord k) => String -> String -> Map k (String, m ()) -> m ()
128+
129+-- Widget to efficiently display long scrolling lists.
130+[W] virtualListWithSelection :: ... -- See Reflex.Dom.Widget.Lazy
131+```
132+
133+## Connecting to the real world (I/O)
134+
135+### Connecting to DOM events
136+
137+```haskell
138+-- Extract the specified Event from an 'El'. See Reflex.Dom.Widget.Basic
139+[ ] domEvent :: EventName en -> El -> Event (EventResultType en)
140+```
141+
142+### Performing arbitrary I/O in response to Events
143+
144+```haskell
145+-- Run side-effecting actions in Event when it occurs; returned Event contains
146+-- results. Side effects run in (WidgetHost m) monad, which includes [S] and [H]
147+-- and can also do I/O via liftIO
148+[W] performEvent :: Event ( WidgetHost m a) -> m (Event a)
149+
150+-- Just run side-effects; no return Event
151+[W] performEvent_ :: Event ( WidgetHost m ()) -> m ()
152+
153+-- Actions run asynchronously; actions are given a callback to send return values
154+[W] performEventAsync :: Event ((a -> IO ()) -> WidgetHost m ()) -> m (Event a)
155+```
156+
157+### XMLHttpRequest
158+
159+Convenience functions for XMLHttpRequest. see Reflex.Dom.Xhr
160+
161+```haskell
162+-- Given method, URL, and config record (with default instance), construct a request.
163+[ ] xhrRequest :: String -> String -> XhrRequestConfig -> XhrRequest
164+
165+-- Given Event of requests, issue them and produce Event of responses.
166+[W] performRequestAsync :: Event XhrRequest -> m (Event XhrResponse)
167+
168+-- Issue a collection of requests, wait for them ALL to complete, return collected results.
169+[W] performRequestsAsync :: Traversable f => Event (f XhrRequest) -> m (Event (f XhrResponse))
170+
171+-- Convenience function to decode JSON-encoded responses.
172+[ ] decodeXhrResponse :: FromJSON a => XhrResponse -> Maybe a
173+
174+-- Simplified interface to "GET" URLs and return decoded results.
175+[W] getAndDecode :: FromJSON a => Event String -> m (Event (Maybe a))
176+```
177+
178+### Time
179+
180+```haskell
181+-- Create Event at given interval with given basis time.
182+[W] tickLossy :: NominalDiffTime -> UTCTime -> m (Event t TickInfo)
183+
184+-- Delay an Event's occurrences by a given amount in seconds.
185+[W] delay :: NominalDiffTime -> Event t a -> m (Event t a)
186+```
187+
188+## Startup
189+
190+```haskell
191+-- Reflex-Dom entry point. Takes a monadic widget-building action of lengthy
192+-- type and turns it into an IO action.
193+[I] mainWidget ::
194+ Widget Spider (Gui Spider (WithWebView SpiderHost) (HostFrame Spider)) () -> IO ()
195+[I] mainWidgetWithHead ::
196+ Widget Spider (Gui Spider (WithWebView SpiderHost) (HostFrame Spider)) () ->
197+ Widget Spider (Gui Spider (WithWebView SpiderHost) (HostFrame Spider)) () -> IO ()
198+[I] mainWidgetWithCss ::
199+ ByteString ->
200+ Widget Spider (Gui Spider (WithWebView SpiderHost) (HostFrame Spider)) () -> IO ()
201+
202+-- One-shot Event that is triggered once all initial widgets are built
203+[W] getPostBuild :: m (Event ())
204+```