Struct ListElem 

pub struct ListElem {
    pub tight: Settable<Self, 0u8>,
    pub marker: Settable<Self, 1u8>,
    pub indent: Settable<Self, 2u8>,
    pub body_indent: Settable<Self, 3u8>,
    pub spacing: Settable<Self, 4u8>,
    pub children: Vec<Packed<ListItem>>,
}

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

tight: Settable<Self, 0u8>

marker: Settable<Self, 1u8>

indent: Settable<Self, 2u8>

body_indent: Settable<Self, 3u8>

spacing: Settable<Self, 4u8>

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.

impl ListElem

pub const tight: Field<Self, 0u8>

pub const marker: Field<Self, 1u8>

pub const indent: Field<Self, 2u8>

pub const body_indent: Field<Self, 3u8>

pub const spacing: Field<Self, 4u8>

pub const children: Field<Self, 5u8>

pub const depth: Field<Self, 6u8>

Trait Implementations

impl Clone for ListElem

fn clone(&self) -> ListElem

Returns a duplicate of the value.

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

const ELEM: Element

The associated element.

fn pack(self) -> Content

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 RequiredField<5> for ListElem

const FIELD: RequiredFieldData<Self, 5u8>

type Type = Vec<Packed<ListItem>>

impl Set for ListElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for ListElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = bool

impl SettableField<1> for ListElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = ListMarker

impl SettableField<2> for ListElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Length

impl SettableField<3> for ListElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Length

impl SettableField<4> for ListElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Smart<Length>

impl SettableProperty<6> for ListElem

const FIELD: SettablePropertyData<Self, 6u8>

type Type = Depth

const FOLD: Option<FoldFn<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 RefableProperty<0> for ListElem

impl RefableProperty<1> for ListElem

impl RefableProperty<2> for ListElem

impl RefableProperty<3> for ListElem

impl RefableProperty<4> for ListElem