Expand description
The core DOM abstraction in Blitz
This crate implements a flexible headless DOM (BaseDocument), which is designed to emebedded in and “driven” by external code. Most users will want
to use a wrapper:
HtmlDocumentfrom the blitz-html crate. Allows you to parse HTML (or XHTML) into a BlitzBaseDocument, and can be combined with a markdown-to-html converter like comrak or pulldown-cmark to render/process markdown.DioxusDocumentfrom the dioxus-native crate. Combines aBaseDocumentwith a DioxusVirtualDomto enable dynamic rendering and event handling.
It includes: A DOM tree respresentation, CSS parsing and resolution, layout and event handling. Additional functionality is available in separate crates, including html parsing (blitz-html), networking (blitz-net), rendering (blitz-paint) and windowing (blitz-shell).
Most of the functionality in this crates is provided through the struct.
blitz-dom has a native Rust API that is designed for higher-level abstractions to be built on top (although it can also be used directly).
The goal behind this crate is that any implementor can interact with the DOM and render it out using any renderer they want.
Re-exports§
pub use node::Attribute;pub use node::ElementData;pub use node::Node;pub use node::NodeData;pub use node::TextNodeData;pub use util::Point;
Modules§
Macros§
- local_
name - Takes a local name as a string and returns its key in the string cache.
- namespace_
prefix - Takes a namespace prefix string and returns its key in a string cache.
- namespace_
url - Takes a namespace url string and returns its key in a string cache.
- ns
- Maps the input of
namespace_prefix!to the output ofnamespace_url!. - qual_
name - Creates an markup5ever::QualName. Given a local name and an optional namespace
Structs§
- Base
Document - Document
Config - Options used when constructing a
BaseDocument - Document
Mutator - Dummy
Html Parser Provider - Event
Driver - Font
Context - A font database/cache (wrapper around a Fontique
CollectionandSourceCache). - Namespace
Static Set - Noop
Event Handler - Prefix
Static Set - Qual
Name - A fully qualified name (with a namespace), used to depict names of tags and attributes.
- Restyle
Hint - The kind of restyle we need to do for a given element.
Constants§
Traits§
- Document
- Abstraction over wrappers around
BaseDocumentto allow for them all to be driven byblitz-shell - Event
Handler - Html
Parser Provider