Skip to content

Commit 19f7616

Browse files
committed
did: update documentation
1 parent 0d66c45 commit 19f7616

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,18 +215,22 @@ In order to allow the building of a dynamic page virtual elements need to be use
215215
- ```htmlgenerator.BaseElement```: The base for all elements, can also be used to group elements without generating output by itself
216216
- ```htmlgenerator.If```: Lazy evaluates the first argument at render time and returns the first child on true and the second child on false
217217
- ```htmlgenerator.Iterator```: Takes an iterator which can be a lazy value and renders the child element for each iteration
218+
- ```htmlgenerator.Fragment```: Allows to name a part of the tree which can then selectively be rendered by passing setting the ```fragment``` parameter when calling ```hg.render```
218219

219220
Example:
220221

221222
```python
222-
from htmlgenerator import render, SPAN, BaseElement, If, C, Iterator
223+
from htmlgenerator import render, SPAN, BaseElement, If, C, Iterator, Fragment, DIV, BODY
223224

224225
print(
225226
render(BaseElement("Just", SPAN("some"), "elements", SPAN("without"), "parent"), {})
226227
)
227228
print(render(If(C("cold"), "It is cold", "It is not cold"), {"cold": True}))
228229
print(render(If(C("cold"), "It is cold", "It is not cold"), {"cold": False}))
229230
print(render(Iterator(range(7), SPAN("I love loops ")), {}))
231+
232+
print(render(BODY("HTML body", Fragment("content", DIV("Content of my page"))), {}))
233+
print(render(BODY("HTML body", Fragment("content", DIV("Content of my page"))), {}, fragment="content"))
230234
```
231235

232236
Output:
@@ -236,6 +240,9 @@ Just<span>some</span>elements<span>without</span>parent
236240
It is cold
237241
It is not cold
238242
<span>I love loops </span><span>I love loops </span><span>I love loops </span><span>I love loops </span><span>I love loops </span><span>I love loops </span><span>I love loops </span>
243+
244+
<body>HTML body<div>Content of my page</div></body>
245+
<div>Content of my page</div>
239246
```
240247

241248
Converting existing HTML source

0 commit comments

Comments
 (0)