Struct ListElem

pub struct ListElem {
    pub children: Vec<Packed<ListItem>>,
    /* private fields */
}

A bullet list.

Displays a sequence of items vertically, with each item introduced by a marker.

Example

Normal list.
- Text
- Math
- Layout
- ...

Multiple lines.
- This list item spans multiple
  lines because it is indented.

Function call.
#list(
  [Foundations],
  [Calculate],
  [Construct],
  [Data Loading],
)

Syntax

This functions also has dedicated syntax: Start a line with a hyphen, followed by a space to create a list item. A list item can contain multiple paragraphs and other block-level content. All content that is indented more than an item’s marker becomes part of that item.

Fields

children: Vec<Packed<ListItem>>

Implementations

impl ListElem

pub fn new(children: Vec<Packed<ListItem>>) -> Self

Create a new instance of the element.

pub fn with_tight(self, tight: bool) -> Self

Builder-style setter for the tight field.

pub fn with_marker(self, marker: ListMarker) -> Self

Builder-style setter for the marker field.

pub fn with_indent(self, indent: Length) -> Self

Builder-style setter for the indent field.

pub fn with_body_indent(self, body_indent: Length) -> Self

Builder-style setter for the body-indent field.

pub fn with_spacing(self, spacing: Smart<Length>) -> Self

Builder-style setter for the spacing field.

pub fn push_tight(&mut self, tight: bool)

Setter for the tight field.

pub fn push_marker(&mut self, marker: ListMarker)

Setter for the marker field.

pub fn push_indent(&mut self, indent: Length)

Setter for the indent field.

pub fn push_body_indent(&mut self, body_indent: Length)

Setter for the body-indent field.

pub fn push_spacing(&mut self, spacing: Smart<Length>)

Setter for the spacing field.

pub fn tight(&self, styles: StyleChain<'_>) -> bool

Defines the default spacing of the list. If it is {false}, the items are spaced apart with paragraph spacing. If it is {true}, they use paragraph leading instead. This makes the list more compact, which can look better if the items are short.

In markup mode, the value of this parameter is determined based on whether items are separated with a blank line. If items directly follow each other, this is set to {true}; if items are separated by a blank line, this is set to {false}. The markup-defined tightness cannot be overridden with set rules.

- If a list has a lot of text, and
  maybe other inline content, it
  should not be tight anymore.

- To make a list wide, simply insert
  a blank line between the items.

pub fn marker<'a>(&'a self, styles: StyleChain<'a>) -> &'a ListMarker

The marker which introduces each item.

Instead of plain content, you can also pass an array with multiple markers that should be used for nested lists. If the list nesting depth exceeds the number of markers, the markers are cycled. For total control, you may pass a function that maps the list’s nesting depth (starting from {0}) to a desired marker.

#set list(marker: [--])
- A more classic list
- With en-dashes

#set list(marker: ([•], [--]))
- Top-level
  - Nested
  - Items
- Items

pub fn indent(&self, styles: StyleChain<'_>) -> <Length as Resolve>::Output

The indent of each item.

pub fn body_indent(&self, styles: StyleChain<'_>) -> <Length as Resolve>::Output

The spacing between the marker and the body of each item.

pub fn spacing(&self, styles: StyleChain<'_>) -> Smart<Length>

The spacing between the items of the list.

If set to {auto}, uses paragraph leading for tight lists and paragraph spacing for wide (non-tight) lists.

pub fn tight_in(styles: StyleChain<'_>) -> bool

Access the tight field in the given style chain.

pub fn marker_in(styles: StyleChain<'_>) -> &ListMarker

Access the marker field in the given style chain.

pub fn indent_in(styles: StyleChain<'_>) -> <Length as Resolve>::Output

Access the indent field in the given style chain.

pub fn body_indent_in(styles: StyleChain<'_>) -> <Length as Resolve>::Output

Access the body-indent field in the given style chain.

pub fn spacing_in(styles: StyleChain<'_>) -> Smart<Length>

Access the spacing field in the given style chain.

pub fn depth_in(styles: StyleChain<'_>) -> Depth

Access the depth field in the given style chain.

pub fn set_tight(tight: bool) -> Property

Create a style property for the tight field.

pub fn set_marker(marker: ListMarker) -> Property

Create a style property for the marker field.

pub fn set_indent(indent: Length) -> Property

Create a style property for the indent field.

pub fn set_body_indent(body_indent: Length) -> Property

Create a style property for the body-indent field.

pub fn set_spacing(spacing: Smart<Length>) -> Property

Create a style property for the spacing field.

pub fn set_depth(depth: Depth) -> Property

Create a style property for the depth field.

Trait Implementations

impl Capable for ListElem

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

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

impl Clone for ListElem

fn clone(&self) -> ListElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for ListElem

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

Construct an element from the arguments.

impl Debug for ListElem

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

Formats the value using the given formatter.

impl Fields for ListElem

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 ListElem

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 ListElem

fn into_value(self) -> Value

Cast this type into a value.

impl ListLike for ListElem

type Item = ListItem

The kind of list item this list is composed of.

fn create(children: Vec<Packed<Self::Item>>, tight: bool) -> Self

Create this kind of list from its children and tightness.

impl NativeElement for ListElem

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 NativeScope for ListElem

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl PartialEq for ListElem

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

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

const 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 ListElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for ListElem

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

Parse relevant arguments into style properties for this element.