Struct HtmlElem 

pub struct HtmlElem {
    pub tag: HtmlTag,
    pub attrs: Settable<Self, 1u8>,
    pub body: Settable<Self, 2u8>,
    pub parent: Option<Location>,
}

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

attrs: Settable<Self, 1u8>

body: Settable<Self, 2u8>

parent: Option<Location>

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 with_parent(self, parent: Location) -> Self

Builder-style setter for the parent field.

impl HtmlElem

pub const tag: Field<Self, 0u8>

pub const attrs: Field<Self, 1u8>

pub const body: Field<Self, 2u8>

pub const parent: Field<Self, 3u8>

pub const role: Field<Self, 4u8>

impl HtmlElem

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

Add an attribute to the element.

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

Adds the attribute to the element if value is not None.

Trait Implementations

impl Clone for HtmlElem

fn clone(&self) -> HtmlElem

Returns a duplicate 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 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 NativeElement for HtmlElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl RequiredField<0> for HtmlElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = HtmlTag

impl Set for HtmlElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<1> for HtmlElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = HtmlAttrs

impl SettableField<2> for HtmlElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Option<Content>

impl SettableProperty<4> for HtmlElem

const FIELD: SettablePropertyData<Self, 4u8>

type Type = Option<EcoString>

const FOLD: Option<fn(Self::Type, Self::Type) -> Self::Type> = _

fn default() -> Self::Type

Produces an instance of the property’s default value.

fn default_ref() -> &'static Self::Type

Produces a static reference to this property’s default value.

impl SynthesizedField<3> for HtmlElem

const FIELD: SynthesizedFieldData<Self, 3u8>

type Type = Location

impl RefableProperty<1> for HtmlElem

impl RefableProperty<2> for HtmlElem

impl RefableProperty<4> for HtmlElem