Skip to main content

Crate blitz_dom

Crate blitz_dom 

Source
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:

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 crate::node::Widget;
pub use node::Attribute;
pub use node::DocumentData;
pub use node::ElementData;
pub use node::Node;
pub use node::NodeData;
pub use node::SelectData;
pub use node::TextNodeData;
pub use paint_damage::PaintDamage;
pub use range::LiveRange;
pub use range::RangeBoundary;
pub use range::RangeBounds;
pub use range::RangeContent;
pub use util::Point;
pub use util::decode_font_bytes;
pub use accesskit;
pub use kurbo;

Modules§

accessibility
The role an element has, and the AccessKit tree built out of those roles.
font_fallback
Embedder-supplied family fallback and helpers for registering compiled-in faces.
net
node
The nodes themsleves, and their data.
paint_damage
What changed on screen since the previous painted frame.
platform
Engine-backed CSSOM operations used by script bindings. CSSOM operations that use the same parser and computed values as rendering.
range
Live DOM ranges. Boundary offsets are UTF-16 code units for CharacterData and child indices for other nodes. The mutation hooks also cover detached trees and documents sharing this arena.
release
stash_policy
util

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 of namespace_url!.
qual_name
Creates an markup5ever::QualName. Given a local name and an optional namespace

Structs§

BaseDocument
DocumentConfig
Options used when constructing a BaseDocument
DocumentMutator
DummyHtmlParserProvider
EventDriver
FontContext
A font database/cache (wrapper around a Fontique Collection and SourceCache).
FormSubmissionScope
Scope a native form policy to the embedder’s document thread, including any nested document events dispatched on that thread.
LookupFormSubmission
A native GET submission prepared for one submitter in the live document.
LookupFormSubmissionDenied
MediaType
https://drafts.csswg.org/mediaqueries/#media-types
NamespaceStaticSet
NodeId
A versioned identifier for a node in a Blitz DOM tree.
NodeTree
The versioned map in which the nodes of the DOM tree are stored, backed by a slotmap::SlotMap.
NoopEventHandler
PlainDocument
PreClickActivation
What the pre-click activation steps changed, so a cancelled click can put it back. Produced by BaseDocument::run_pre_click_activation.
PrefixStaticSet
QualName
A fully qualified name (with a namespace), used to depict names of tags and attributes.
RestyleHint
The kind of restyle we need to do for a given element.

Enums§

AnimationPacing
How urgently a document needs another animation frame.
DocGuard
DocGuardMut
DomMutation
One change, in the shape a MutationRecord needs.
StyleThreading
Strategy for Stylo’s style traversal during resolve.

Constants§

BULLET_FONT
DEFAULT_CSS

Traits§

Document
Abstraction over wrappers around BaseDocument to allow for them all to be driven by blitz-shell
EventHandler
HtmlParserProvider

Functions§

build_font_context
Create an independent Parley font context with the embedded bullet font.
build_single_font_ctx
Convenience builder for the one-font case: produces a FontContext with system-font discovery disabled and the supplied font registered as the fallback for every generic family. The standard setup for WASM, where browsers don’t expose system fonts. WOFF/WOFF2 inputs are decoded automatically.
dom_node_id
Convert a taffy::NodeId produced by taffy_node_id back into a Blitz NodeId.
resolve_2d_transform
taffy_node_id
Convert a Blitz NodeId into a taffy::NodeId (which wraps a u64).

Type Aliases§

Atom
LocalName
Namespace
Prefix
SelectorList