haskal
/
skhtml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sync README with crate doc 

5334d783f2 and
c036b7c7c5 were only applied to the crate
documentation but not to the copy in README.md.

Might make sense to use https://github.com/livioribeiro/cargo-readme or
https://github.com/orium/cargo-rdme ;)
This commit is contained in:
Adrian Heine 2023-03-14 16:20:58 +01:00
parent 643ab46220
commit f15ed2d080
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -34,7 +34,7 @@ let mut doc: DOMTree<String> = html!(
</p> </p>
)) } )) }
<p class="citation-needed"> <p class="citation-needed">
"Every company should be a developer experience company" "Every company should be a developer experience company."
</p> </p>
</body> </body>
</html> </html>
@ -95,14 +95,14 @@ conversion will panic at runtime if the string is invalid.
### Example ### Example
```rust ```rust
let classList: SpacedSet<Class> = ["foo", "bar", "baz"].into(); let classList: SpacedSet<Class> = ["foo", "bar", "baz"].try_into()?;
html!( html!(
<div> <div>
<div class="foo bar baz" /> // parses a string literal <div class="foo bar baz" /> // parses a string literal
<div class=["foo", "bar", "baz"] /> // uses From<[&str, &str, &str]> <div class=["foo", "bar", "baz"] /> // uses From<[&str, &str, &str]>
<div class=classList /> // uses a variable in scope <div class=classList /> // uses a variable in scope
<div class={ // evaluates a code block <div class={ // evaluates a code block
SpacedSet::from(["foo", "bar", "baz"]) SpacedSet::try_from(["foo", "bar", "baz"])?
} /> } />
</div> </div>
) )
@ -151,7 +151,7 @@ assert_eq!("<p>Hello Axo</p>", doc_str);
### Render to a virtual DOM ### Render to a virtual DOM
The DOM tree structure also implements a method called `vnode()`, which renders The DOM tree structure also implements a method called `vnode()`, which renders
the tree to a tree of [`Node`][Node]s, which is a mirror of the generated tree the tree to a tree of [`VNode`][VNode]s, which is a mirror of the generated tree
with every attribute value rendered into `String`s. You can walk this virtual with every attribute value rendered into `String`s. You can walk this virtual
DOM tree and pass it on to your favourite virtual DOM system. DOM tree and pass it on to your favourite virtual DOM system.
@ -168,7 +168,7 @@ Copyright 2018 Bodil Stokke, 2022 Axo Developer Co.
[Display]: https://doc.rust-lang.org/std/fmt/trait.Display.html [Display]: https://doc.rust-lang.org/std/fmt/trait.Display.html
[String]: https://doc.rust-lang.org/std/string/struct.String.html [String]: https://doc.rust-lang.org/std/string/struct.String.html
[to_string]: https://doc.rust-lang.org/std/string/trait.ToString.html#tymethod.to_string [to_string]: https://doc.rust-lang.org/std/string/trait.ToString.html#tymethod.to_string
[Node]: https://docs.rs/axohtml/latest/axohtml/dom/trait.Node.html [VNode]: https://docs.rs/axohtml/latest/axohtml/dom/enum.VNode.html
[FromStr]: https://doc.rust-lang.org/std/str/trait.FromStr.html [FromStr]: https://doc.rust-lang.org/std/str/trait.FromStr.html
[SpacedSet]: https://docs.rs/axohtml/latest/axohtml/types/struct.SpacedSet.html [SpacedSet]: https://docs.rs/axohtml/latest/axohtml/types/struct.SpacedSet.html
[IntoIterator]: https://doc.rust-lang.org/std/iter/trait.IntoIterator.html [IntoIterator]: https://doc.rust-lang.org/std/iter/trait.IntoIterator.html