Struct HeadingElem 

pub struct HeadingElem {
    pub level: Settable<Self, 0u8>,
    pub depth: Settable<Self, 1u8>,
    pub offset: Settable<Self, 2u8>,
    pub numbering: Settable<Self, 3u8>,
    pub supplement: Settable<Self, 4u8>,
    pub outlined: Settable<Self, 5u8>,
    pub bookmarked: Settable<Self, 6u8>,
    pub hanging_indent: Settable<Self, 7u8>,
    pub body: Content,
    pub numbers: Option<EcoString>,
}

A section heading.

With headings, you can structure your document into sections. Each heading has a level, which starts at one and is unbounded upwards. This level indicates the logical role of the following content (section, subsection, etc.) A top-level heading indicates a top-level section of the document (not the document’s title). To insert a title, use the title element instead.

Typst can automatically number your headings for you. To enable numbering, specify how you want your headings to be numbered with a numbering pattern or function.

Independently of the numbering, Typst can also automatically generate an [outline] of all headings for you. To exclude one or more headings from this outline, you can set the outlined parameter to {false}.

When writing a show rule that accesses the body field to create a completely custom look for headings, make sure to wrap the content in a block (which is implicitly sticky for headings through a built-in show-set rule). This prevents headings from becoming “orphans”, i.e. remaining at the end of the page with the following content being on the next page.

Example

#set heading(numbering: "1.a)")

= Introduction
In recent years, ...

== Preliminaries
To start, ...

Syntax

Headings have dedicated syntax: They can be created by starting a line with one or multiple equals signs, followed by a space. The number of equals signs determines the heading’s logical nesting depth. The {offset} field can be set to configure the starting depth.

Accessibility

Headings are important for accessibility, as they help users of Assistive Technologies (AT) like screen readers to navigate within your document. Screen reader users will be able to skip from heading to heading, or get an overview of all headings in the document.

To make your headings accessible, you should not skip heading levels. This means that you should start with a first-level heading. Also, when the previous heading was of level 3, the next heading should be of level 3 (staying at the same depth), level 4 (going exactly one level deeper), or level 1 or 2 (new hierarchically higher headings).

HTML export

As mentioned above, a top-level heading indicates a top-level section of the document rather than its title. This is in contrast to the HTML <h1> element of which there should be only one per document.

For this reason, in HTML export, a [title] element will turn into an <h1> and headings turn into <h2> and lower (a level 1 heading thus turns into <h2>, a level 2 heading into <h3>, etc).

Fields

level: Settable<Self, 0u8>

depth: Settable<Self, 1u8>

offset: Settable<Self, 2u8>

numbering: Settable<Self, 3u8>

supplement: Settable<Self, 4u8>

outlined: Settable<Self, 5u8>

bookmarked: Settable<Self, 6u8>

hanging_indent: Settable<Self, 7u8>

body: Content

numbers: Option<EcoString>

Implementations

impl HeadingElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_level(self, level: Smart<NonZeroUsize>) -> Self

Builder-style setter for the level field.

pub fn with_depth(self, depth: NonZeroUsize) -> Self

Builder-style setter for the depth field.

pub fn with_offset(self, offset: usize) -> Self

Builder-style setter for the offset field.

pub fn with_numbering(self, numbering: Option<Numbering>) -> Self

Builder-style setter for the numbering field.

pub fn with_supplement(self, supplement: Smart<Option<Supplement>>) -> Self

Builder-style setter for the supplement field.

pub fn with_outlined(self, outlined: bool) -> Self

Builder-style setter for the outlined field.

pub fn with_bookmarked(self, bookmarked: Smart<bool>) -> Self

Builder-style setter for the bookmarked field.

pub fn with_hanging_indent(self, hanging_indent: Smart<Length>) -> Self

Builder-style setter for the hanging-indent field.

pub fn with_numbers(self, numbers: EcoString) -> Self

Builder-style setter for the numbers field.

impl HeadingElem

pub const level: Field<Self, 0u8>

pub const depth: Field<Self, 1u8>

pub const offset: Field<Self, 2u8>

pub const numbering: Field<Self, 3u8>

pub const supplement: Field<Self, 4u8>

pub const outlined: Field<Self, 5u8>

pub const bookmarked: Field<Self, 6u8>

pub const hanging_indent: Field<Self, 7u8>

pub const body: Field<Self, 8u8>

pub const numbers: Field<Self, 9u8>

impl HeadingElem

pub fn resolve_level(&self, styles: StyleChain<'_>) -> NonZeroUsize

Trait Implementations

impl Clone for HeadingElem

fn clone(&self) -> HeadingElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for HeadingElem

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

Construct an element from the arguments.

impl Debug for HeadingElem

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

Formats the value using the given formatter.

impl Hash for HeadingElem

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 HeadingElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl RequiredField<8> for HeadingElem

const FIELD: RequiredFieldData<Self, 8u8>

type Type = Content

impl Set for HeadingElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for HeadingElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = Smart<NonZero<usize>>

impl SettableField<1> for HeadingElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = NonZero<usize>

impl SettableField<2> for HeadingElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = usize

impl SettableField<3> for HeadingElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Option<Numbering>

impl SettableField<4> for HeadingElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Smart<Option<Supplement>>

impl SettableField<5> for HeadingElem

const FIELD: SettableFieldData<Self, 5u8>

type Type = bool

impl SettableField<6> for HeadingElem

const FIELD: SettableFieldData<Self, 6u8>

type Type = Smart<bool>

impl SettableField<7> for HeadingElem

const FIELD: SettableFieldData<Self, 7u8>

type Type = Smart<Length>

impl SynthesizedField<9> for HeadingElem

const FIELD: SynthesizedFieldData<Self, 9u8>

type Type = EcoString

impl RefableProperty<0> for HeadingElem

impl RefableProperty<1> for HeadingElem

impl RefableProperty<2> for HeadingElem

impl RefableProperty<3> for HeadingElem

impl RefableProperty<4> for HeadingElem

impl RefableProperty<5> for HeadingElem

impl RefableProperty<6> for HeadingElem

impl RefableProperty<7> for HeadingElem