Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indent configuration for multiline headings #3459

Merged
merged 6 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 45 additions & 7 deletions crates/typst/src/model/heading.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@ use std::num::NonZeroUsize;
use crate::diag::SourceResult;
use crate::engine::Engine;
use crate::foundations::{
elem, Content, NativeElement, Packed, Show, ShowSet, Smart, StyleChain, Styles,
Synthesize,
elem, Content, NativeElement, Packed, Resolve, Show, ShowSet, Smart, StyleChain,
Styles, Synthesize,
};
use crate::introspection::{Count, Counter, CounterUpdate, Locatable};
use crate::layout::{BlockElem, Em, HElem, VElem};
use crate::model::{Numbering, Outlinable, Refable, Supplement};
use crate::layout::{
Abs, Axes, BlockElem, Em, HElem, LayoutMultiple, Length, Regions, VElem,
};
use crate::model::{Numbering, Outlinable, ParElem, Refable, Supplement};
use crate::text::{FontWeight, LocalName, SpaceElem, TextElem, TextSize};
use crate::util::NonZeroExt;

Expand Down Expand Up @@ -163,6 +165,18 @@ pub struct HeadingElem {
#[default(Smart::Auto)]
pub bookmarked: Smart<bool>,

/// The indent all but the first line of a heading should have.
///
/// The default value of `{auto}` indicates that the subsequent heading
/// lines will be indented based on the width of the numbering.
///
/// ```example
/// #set heading(numbering: "1.")
/// #heading[A very, very, very, very, very, very long heading]
/// ```
#[default(Smart::Auto)]
pub hanging_indent: Smart<Length>,

/// The heading's title.
#[required]
pub body: Content,
Expand Down Expand Up @@ -201,15 +215,39 @@ impl Synthesize for Packed<HeadingElem> {
impl Show for Packed<HeadingElem> {
#[typst_macros::time(name = "heading", span = self.span())]
fn show(&self, engine: &mut Engine, styles: StyleChain) -> SourceResult<Content> {
const SPACING_TO_NUMBERING: Em = Em::new(0.3);

let span = self.span();
let mut realized = self.body().clone();

let hanging_indent = self.hanging_indent(styles);

let mut indent = match hanging_indent {
Smart::Custom(length) => length.resolve(styles),
Smart::Auto => Abs::zero(),
};

if let Some(numbering) = (**self).numbering(styles).as_ref() {
realized = Counter::of(HeadingElem::elem())
let numbering = Counter::of(HeadingElem::elem())
.display_at_loc(engine, self.location().unwrap(), styles, numbering)?
.spanned(span)
+ HElem::new(Em::new(0.3).into()).with_weak(true).pack()
.spanned(span);

if hanging_indent.is_auto() {
let pod = Regions::one(Axes::splat(Abs::inf()), Axes::splat(false));
let size = numbering.measure(engine, styles, pod)?.into_frame().size();

indent = size.x + SPACING_TO_NUMBERING.resolve(styles);
}

realized = numbering
+ HElem::new(SPACING_TO_NUMBERING.into()).with_weak(true).pack()
+ realized;
}

if indent != Abs::zero() {
realized = realized.styled(ParElem::set_hanging_indent(indent.into()));
}

Ok(BlockElem::new().with_body(Some(realized)).pack().spanned(span))
}
}
Expand Down
Binary file modified tests/ref/outline-first-line-indent.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.