Struct HtmlElem

pub struct HtmlElem {
    pub tag: HtmlTag,
    /* private fields */
}

An HTML element that can contain Typst content.

Typst’s HTML export automatically generates the appropriate tags for most elements. However, sometimes, it is desirable to retain more control. For example, when using Typst to generate your blog, you could use this function to wrap each article in an <article> tag.

Typst is aware of what is valid HTML. A tag and its attributes must form syntactically valid HTML. Some tags, like meta do not accept content. Hence, you must not provide a body for them. We may add more checks in the future, so be sure that you are generating valid HTML when using this function.

Normally, Typst will generate html, head, and body tags for you. If you instead create them with this function, Typst will omit its own tags.

#html.elem("div", attrs: (style: "background: aqua"))[
  A div with _Typst content_ inside!
]

Fields

tag: HtmlTag

Implementations

impl HtmlElem

pub fn new(tag: HtmlTag) -> Self

Create a new instance of the element.

pub fn with_attrs(self, attrs: HtmlAttrs) -> Self

Builder-style setter for the attrs field.

pub fn with_body(self, body: Option<Content>) -> Self

Builder-style setter for the body field.

pub fn push_attrs(&mut self, attrs: HtmlAttrs)

Setter for the attrs field.

pub fn push_body(&mut self, body: Option<Content>)

Setter for the body field.

pub fn attrs<'a>(&'a self, styles: StyleChain<'a>) -> &'a HtmlAttrs

The element’s HTML attributes.

pub fn body<'a>(&'a self, styles: StyleChain<'a>) -> &'a Option<Content>

The contents of the HTML element.

The body can be arbitrary Typst content.

pub fn attrs_in(styles: StyleChain<'_>) -> &HtmlAttrs

Access the attrs field in the given style chain.

pub fn body_in(styles: StyleChain<'_>) -> &Option<Content>

Access the body field in the given style chain.

pub fn set_attrs(attrs: HtmlAttrs) -> Property

Create a style property for the attrs field.

pub fn set_body(body: Option<Content>) -> Property

Create a style property for the body field.

impl HtmlElem

pub fn with_attr(self, attr: HtmlAttr, value: impl Into<EcoString>) -> Self

Add an attribute to the element.

Trait Implementations

impl Capable for HtmlElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for HtmlElem

fn clone(&self) -> HtmlElem

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Construct for HtmlElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for HtmlElem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Fields for HtmlElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

impl Hash for HtmlElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for HtmlElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for HtmlElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for HtmlElem

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Repr for HtmlElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for HtmlElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.