Copyright | (c) 2015 Jeffrey Rosenbluth |
---|---|
License | BSD-style (see LICENSE) |
Maintainer | jeffrey.rosenbluth@gmail.com |
Safe Haskell | None |
Language | Haskell2010 |
DSL for creating SVG.
- type Svg = SvgT Identity
- module Lucid.Svg.Path
- module Lucid.Svg.Elements
- module Lucid.Svg.Attributes
- renderText :: Html a -> Text
- renderBS :: Html a -> ByteString
- renderTextT :: Monad m => HtmlT m a -> m Text
- renderBST :: Monad m => HtmlT m a -> m ByteString
- renderToFile :: FilePath -> Html a -> IO ()
- execHtmlT :: Monad m => HtmlT m a -> m Builder
- evalHtmlT :: Monad m => HtmlT m a -> m a
- runHtmlT :: HtmlT m a -> m (HashMap Text Text -> Builder -> Builder, a)
- newtype Attribute :: * = Attribute (Text, Text)
- class Term arg result | result -> arg where
- class ToHtml a where
- class With a where
Intro
SVG elements and attributes in Lucid-Svg are written with a postfix ‘_
’.
Some examples:
path_
, circle_
, color_
, scale_
Note: If you're testing in the REPL you need to add a type annotation to indicate that you want SVG. In normal code your top-level declaration signatures handle that.
Plain text is written using the OverloadedStrings
and
ExtendedDefaultRules
extensions, and is automatically escaped:
As in Lucid, elements nest by function application:
>>>
g_ (text_ "Hello SVG") :: Svg ()
<g><text>Hello SVG</text></g>
and elements are juxtaposed via monoidal append or monadic sequencing:
>>>
text_ "Hello" <> text_ "SVG" :: Svg ()
<text>Hello</text><text>SVG</text>
>>>
do text_ "Hello"; text_ "SVG" :: Svg ()
<text>Hello</text><text>SVG</text>
Attributes are set by providing an argument list. In contrast to HTML many SVG elements have no content, only attributes.
>>>
rect_ [width_ "100%", height_ "100%", fill_ "red"] :: Svg ()
<rect height="100%" width="100%" fill="red"></rect>
Attributes and elements that share the same name are not conflicting unless they appear on the list in the note below:
>>>
mask_ [mask_ "attribute"] "element" :: Svg ()
<mask mask="attribute">element</mask>
Note: The following element and attribute names overlap and cannot be
handled polymorphically since doing so would create conflicting functional
dependencies. The unqualifed name refers to the element.
We qualify the attribute name as A
. For example, path_
and path_
.
colorProfile_
, cursor_
, filter_
, path_
, and style_
Path data can be constructed using the functions in Path
and combined monoidally:
path_ ( [ d_ (mA 10 80 <> qA 52.5 10 95 80 <> tA 180 80 <> z) , stroke_ "blue" , fill_ "orange" ])
<path d="M 10,80 Q 52.5,10 95,80 T 180,80 Z" stroke="blue" fill="orange"></path>
A slightly longer example:
import Lucid.Svg svg :: Svg () -> Svg () svg content = do doctype_ with (svg11_ content) [version_ "1.1", width_ "300" , height_ "200"] contents :: Svg () contents = do rect_ [width_ "100%", height_ "100%", fill_ "red"] circle_ [cx_ "150", cy_ "100", r_ "80", fill_ "green"] text_ [x_ "150", y_ "125", fontSize_ "60", textAnchor_ "middle", fill_ "white"] "SVG" main :: IO () main = do print $ svg contents
Re-exports
module Lucid.Svg.Path
module Lucid.Svg.Elements
module Lucid.Svg.Attributes
From Lucid.Base
renderText :: Html a -> Text
Render the HTML to a lazy Text
.
This is a convenience function defined in terms of execHtmlT
,
runIdentity
and toLazyByteString
, and
decodeUtf8
. Check the source if you're interested in the
lower-level behaviour.
renderBS :: Html a -> ByteString
Render the HTML to a lazy ByteString
.
This is a convenience function defined in terms of execHtmlT
,
runIdentity
and toLazyByteString
. Check the source if
you're interested in the lower-level behaviour.
renderTextT :: Monad m => HtmlT m a -> m Text
Render the HTML to a lazy Text
, but in a monad.
This is a convenience function defined in terms of execHtmlT
and
toLazyByteString
, and decodeUtf8
. Check the source if
you're interested in the lower-level behaviour.
renderBST :: Monad m => HtmlT m a -> m ByteString
Render the HTML to a lazy ByteString
, but in a monad.
This is a convenience function defined in terms of execHtmlT
and
toLazyByteString
. Check the source if you're interested in
the lower-level behaviour.
renderToFile :: FilePath -> Html a -> IO ()
Render the HTML to a lazy ByteString
.
This is a convenience function defined in terms of execHtmlT
,
runIdentity
and toLazyByteString
. Check the source if
you're interested in the lower-level behaviour.
Running
Build the HTML. Analogous to execState
.
You might want to use this is if you want to do something with the
raw Builder
. Otherwise for simple cases you can just use
renderText
or renderBS
.
:: forall (m :: * -> *). Monad m | |
=> HtmlT m a | HTML monad to evaluate. |
-> m a | Ignore the HTML output and just return the value. |
Evaluate the HTML to its return value. Analogous to evalState
.
Use this if you want to ignore the HTML output of an action completely and just get the result.
For using with the Html
type, you'll need runIdentity
e.g.
>>>
runIdentity (evalHtmlT (p_ "Hello!"))
()
Types
newtype Attribute :: *
A simple attribute. Don't use the constructor, use makeAttribute
.
Eq Attribute | |
Show Attribute | |
Term Text Attribute | Some terms (like |
TermRaw Text Attribute | Some termRaws (like |
(Monad m, (~) * f (HtmlT m a)) => Term [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |
(Monad m, ToHtml f, (~) * a ()) => TermRaw [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |
Classes
class Term arg result | result -> arg where
Used to construct HTML terms.
Simplest use: p_ = term "p" yields p_
.
Very overloaded for three cases:
- The first case is the basic
arg
of[(Text,Text)]
which will return a function that wants children. - The second is an
arg
which isHtmlT m ()
, in which case the term accepts no attributes and just the children are used for the element. - Finally, this is also used for overloaded attributes, like
style_
ortitle_
. If a return type of(Text,Text)
is inferred then an attribute will be made.
The instances look intimidating but actually the constraints make
it very general so that type inference works well even in the
presence of things like OverloadedLists
and such.
:: Text | Name of the element or attribute. |
-> arg | Either an attribute list or children. |
-> result | Result: either an element or an attribute. |
Used for constructing elements e.g. term "p"
yields p_
.
:: Text | Name. |
-> [Attribute] | Attribute transformer. |
-> arg | Some argument. |
-> result | Result: either an element or an attribute. |
Use this if you want to make an element which inserts some pre-prepared attributes into the element.
Term Text Attribute | Some terms (like |
(Monad m, (~) * f (HtmlT m a)) => Term [Attribute] (f -> HtmlT m a) | Given attributes, expect more child input. |
Monad m => Term (HtmlT m a) (HtmlT m a) | Given children immediately, just use that and expect no attributes. |
class ToHtml a where
Can be converted to HTML.
class With a where
With an element use these attributes. An overloaded way of adding attributes either to an element accepting attributes-and-children or one that just accepts attributes. See the two instances.
:: a | Some element, either |
-> [Attribute] | |
-> a |
With the given element(s), use the given attributes.