@@ -10,11 +10,9 @@
1010{-# LANGUAGE ScopedTypeVariables #-}
1111{-# LANGUAGE TypeFamilies #-}
1212module Reflex.Dom.Widget.Basic
13− ( partitionMapBySetLT
14− , ChildResult (..)
15−
13+ (
1614 -- * Displaying Values
17− , text
15+ text
1816 , dynText
1917 , display
2018 , button
@@ -57,6 +55,8 @@ module Reflex.Dom.Widget.Basic
5755 , module Data.Map.Misc
5856 , module Reflex.Collection
5957 , module Reflex.Workflow
58+ , partitionMapBySetLT
59+ , ChildResult (..)
6060 ) where
6161
6262import Reflex.Class
@@ -131,7 +131,7 @@ button t = do
131131--TODO: Should this be renamed to 'widgetView' for consistency with 'widgetHold'?
132132-- | Given a Dynamic of widget-creating actions, create a widget that is recreated whenever the Dynamic updates.
133133-- The returned Event of widget results occurs when the Dynamic does.
134−-- Note: Often, the type 'a' is an Event, in which case the return value is an Event-of-Events that would typically be flattened (via 'switchPromptly').
134+-- Note: Often, the type @a@ is an 'Event', in which case the return value is an Event-of-Events that would typically be flattened (via 'switchHold').
135135dyn :: (DomBuilder t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
136136dyn = networkView
137137
@@ -141,7 +141,7 @@ dyn_ = void . dyn
141141
142142-- | Given an initial widget and an Event of widget-creating actions, create a widget that is recreated whenever the Event fires.
143143-- The returned Dynamic of widget results occurs when the Event does.
144−-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
144+-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened (via 'switchDyn').
145145widgetHold :: (DomBuilder t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
146146widgetHold = networkHold
147147
@@ -150,43 +150,51 @@ widgetHold_ :: (DomBuilder t m, MonadHold t m) => m a -> Event t (m a) -> m ()
150150widgetHold_ z = void . widgetHold z
151151
152152-- | Create a DOM element
153−-- > el "div" (text "Hello World")
153+--
154+-- >>> el "div" (text "Hello World")
154155-- <div>Hello World</div>
155156{-# INLINABLE el #-}
156157el :: forall t m a. DomBuilder t m => Text -> m a -> m a
157158el elementTag child = snd <$> el' elementTag child
158159
159160-- | Create a DOM element with attributes
160−-- > elAttr "a" ("href" =: "http://google.com") (text "Google!")
161−-- <a href="http://google.com">Google!</a>
161+--
162+-- >>> elAttr "a" ("href" =: "https://reflex-frp.org") (text "Reflex-FRP!")
163+-- <a href="https://reflex-frp.org">Reflex-FRP!</a>
162164{-# INLINABLE elAttr #-}
163165elAttr :: forall t m a. DomBuilder t m => Text -> Map Text Text -> m a -> m a
164166elAttr elementTag attrs child = snd <$> elAttr' elementTag attrs child
165167
166168-- | Create a DOM element with classes
167−-- > elClass "div" "row" (return ())
169+--
170+-- >>> elClass "div" "row" (return ())
168171-- <div class="row"></div>
169172{-# INLINABLE elClass #-}
170173elClass :: forall t m a. DomBuilder t m => Text -> Text -> m a -> m a
171174elClass elementTag c child = snd <$> elClass' elementTag c child
172175
173176-- | Create a DOM element with Dynamic Attributes
174−-- > elClass "div" (constDyn ("class" =: "row")) (return ())
177+--
178+-- >>> elClass "div" (constDyn ("class" =: "row")) (return ())
175179-- <div class="row"></div>
176180{-# INLINABLE elDynAttr #-}
177181elDynAttr :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t (Map Text Text) -> m a -> m a
178182elDynAttr elementTag attrs child = snd <$> elDynAttr' elementTag attrs child
179183
180184-- | Create a DOM element with a Dynamic Class
181−-- > elDynClass "div" (constDyn "row") (return ())
185+--
186+-- >>> elDynClass "div" (constDyn "row") (return ())
182187-- <div class="row"></div>
183188{-# INLINABLE elDynClass #-}
184189elDynClass :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t Text -> m a -> m a
185190elDynClass elementTag c child = snd <$> elDynClass' elementTag c child
186191
187192-- | Create a DOM element and return the element
188−-- > do (e, _) <- el' "div" (text "Click")
189−-- > return $ domEvent Click e
193+--
194+-- @
195+-- do (e, _) <- el' "div" (text "Click")
196+-- return $ domEvent Click e
197+-- @
190198{-# INLINABLE el' #-}
191199el' :: forall t m a. DomBuilder t m => Text -> m a -> m (Element EventResult (DomBuilderSpace m) t, a)
192200el' elementTag = element elementTag def
@@ -272,6 +280,8 @@ newtype Link t
272280 = Link { _link_clicked :: Event t ()
273281 }
274282
283+-- | >>> linkClass "Click here" "link-class"
284+-- > <a class="link-class">Click here</a>
275285linkClass :: DomBuilder t m => Text -> Text -> m (Link t)
276286linkClass s c = do
277287 (l,_) <- elAttr' "a" ("class" =: c) $ text s