Struct BlockElem 

pub struct BlockElem {

    pub width: Settable<Self, 0u8>,
    pub height: Settable<Self, 1u8>,
    pub breakable: Settable<Self, 2u8>,
    pub fill: Settable<Self, 3u8>,
    pub stroke: Settable<Self, 4u8>,
    pub radius: Settable<Self, 5u8>,
    pub inset: Settable<Self, 6u8>,
    pub outset: Settable<Self, 7u8>,
    pub above: Settable<Self, 9u8>,
    pub below: Settable<Self, 10u8>,
    pub clip: Settable<Self, 11u8>,
    pub sticky: Settable<Self, 12u8>,
    pub body: Settable<Self, 13u8>,
}

A block-level container.

Such a container can be used to separate content, size it, and give it a background or border.

Blocks are also the primary way to control whether text becomes part of a paragraph or not. See the paragraph documentation for more details.

Examples

With a block, you can give a background to content while still allowing it to break across multiple pages.

#set page(height: 100pt)
#block(
  fill: luma(230),
  inset: 8pt,
  radius: 4pt,
  lorem(30),
)

Blocks are also useful to force elements that would otherwise be inline to become block-level, especially when writing show rules.

#show heading: it => it.body
= Blockless
More text.

#show heading: it => block(it.body)
= Blocky
More text.

Fields

width: Settable<Self, 0u8>

height: Settable<Self, 1u8>

breakable: Settable<Self, 2u8>

fill: Settable<Self, 3u8>

stroke: Settable<Self, 4u8>

radius: Settable<Self, 5u8>

inset: Settable<Self, 6u8>

outset: Settable<Self, 7u8>

above: Settable<Self, 9u8>

below: Settable<Self, 10u8>

clip: Settable<Self, 11u8>

sticky: Settable<Self, 12u8>

body: Settable<Self, 13u8>

Implementations

impl BlockElem

pub fn new() -> Self

Create a new instance of the element.

pub fn with_width(self, width: Smart<Rel<Length>>) -> Self

Builder-style setter for the width field.

pub fn with_height(self, height: Sizing) -> Self

Builder-style setter for the height field.

pub fn with_breakable(self, breakable: bool) -> Self

Builder-style setter for the breakable field.

pub fn with_fill(self, fill: Option<Paint>) -> Self

Builder-style setter for the fill field.

pub fn with_stroke(self, stroke: Sides<Option<Option<Stroke>>>) -> Self

Builder-style setter for the stroke field.

pub fn with_radius(self, radius: Corners<Option<Rel<Length>>>) -> Self

Builder-style setter for the radius field.

pub fn with_inset(self, inset: Sides<Option<Rel<Length>>>) -> Self

Builder-style setter for the inset field.

pub fn with_outset(self, outset: Sides<Option<Rel<Length>>>) -> Self

Builder-style setter for the outset field.

pub fn with_above(self, above: Smart<Spacing>) -> Self

Builder-style setter for the above field.

pub fn with_below(self, below: Smart<Spacing>) -> Self

Builder-style setter for the below field.

pub fn with_clip(self, clip: bool) -> Self

Builder-style setter for the clip field.

pub fn with_sticky(self, sticky: bool) -> Self

Builder-style setter for the sticky field.

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

Builder-style setter for the body field.

impl BlockElem

pub const width: Field<Self, 0u8>

pub const height: Field<Self, 1u8>

pub const breakable: Field<Self, 2u8>

pub const fill: Field<Self, 3u8>

pub const stroke: Field<Self, 4u8>

pub const radius: Field<Self, 5u8>

pub const inset: Field<Self, 6u8>

pub const outset: Field<Self, 7u8>

pub const above: Field<Self, 9u8>

pub const below: Field<Self, 10u8>

pub const clip: Field<Self, 11u8>

pub const sticky: Field<Self, 12u8>

pub const body: Field<Self, 13u8>

impl BlockElem

pub fn single_layouter<T: NativeElement>( captured: Packed<T>, f: fn(content: &Packed<T>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, region: Region) -> SourceResult<Frame>, ) -> Self

Create a block with a custom single-region layouter.

Such a block must have breakable: false (which is set by this constructor).

pub fn multi_layouter<T: NativeElement>( captured: Packed<T>, f: fn(content: &Packed<T>, engine: &mut Engine<'_>, locator: Locator<'_>, styles: StyleChain<'_>, regions: Regions<'_>) -> SourceResult<Fragment>, ) -> Self

Create a block with a custom multi-region layouter.

Trait Implementations

impl Clone for BlockElem

fn clone(&self) -> BlockElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for BlockElem

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

Construct an element from the arguments.

impl Debug for BlockElem

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

Formats the value using the given formatter.

impl ExternalField<8> for BlockElem

const FIELD: ExternalFieldData<Self, 8u8>

type Type = Spacing

impl Hash for BlockElem

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 BlockElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl Set for BlockElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for BlockElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = Smart<Rel>

impl SettableField<1> for BlockElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Sizing

impl SettableField<10> for BlockElem

const FIELD: SettableFieldData<Self, 10u8>

type Type = Smart<Spacing>

impl SettableField<11> for BlockElem

const FIELD: SettableFieldData<Self, 11u8>

type Type = bool

impl SettableField<12> for BlockElem

const FIELD: SettableFieldData<Self, 12u8>

type Type = bool

impl SettableField<13> for BlockElem

const FIELD: SettableFieldData<Self, 13u8>

type Type = Option<BlockBody>

impl SettableField<2> for BlockElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = bool

impl SettableField<3> for BlockElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Option<Paint>

impl SettableField<4> for BlockElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Sides<Option<Option<Stroke>>>

impl SettableField<5> for BlockElem

const FIELD: SettableFieldData<Self, 5u8>

type Type = Corners<Option<Rel>>

impl SettableField<6> for BlockElem

const FIELD: SettableFieldData<Self, 6u8>

type Type = Sides<Option<Rel>>

impl SettableField<7> for BlockElem

const FIELD: SettableFieldData<Self, 7u8>

type Type = Sides<Option<Rel>>

impl SettableField<9> for BlockElem

const FIELD: SettableFieldData<Self, 9u8>

type Type = Smart<Spacing>

impl RefableProperty<0> for BlockElem

impl RefableProperty<1> for BlockElem

impl RefableProperty<10> for BlockElem

impl RefableProperty<11> for BlockElem

impl RefableProperty<12> for BlockElem

impl RefableProperty<13> for BlockElem

impl RefableProperty<2> for BlockElem

impl RefableProperty<3> for BlockElem

impl RefableProperty<9> for BlockElem