caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-14 04:56:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Revise docs for place element (#4105)

Browse Source
This commit is contained in:
bluebear94 2024-05-13 08:14:07 -04:00 committed by GitHub
parent e8ee15277d
commit 7b656b3deb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
crates/typst/src/layout/place.rs
View File

@ -30,8 +30,8 @@ use crate::realize::{Behave, Behaviour};
pub struct PlaceElem {
/// Relative to which position in the parent container to place the content.
///
/// Cannot be `{auto}` if `float` is `{false}` and must be either
/// `{auto}`, `{top}`, or `{bottom}` if `float` is `{true}`.
/// - If `float` is `{false}`, then this can be any alignment other than `{auto}`.
/// - If `float` is `{true}`, then this must be `{auto}`, `{top}`, or `{bottom}`.
///
/// When an axis of the page is `{auto}` sized, all alignments relative to
/// that axis will be ignored, instead, the item will be placed in the
@ -77,9 +77,17 @@ pub struct PlaceElem {
/// place(center, dx: amount - 32pt, dy: amount)[A]
/// }
/// ```
///
/// This does not affect the layout of in-flow content.
/// In other words, the placed content is treated as if it
/// were wrapped in a [`move`] element.
pub dx: Rel<Length>,
/// The vertical displacement of the placed content.
///
/// This does not affect the layout of in-flow content.
/// In other words, the placed content is treated as if it
/// were wrapped in a [`move`] element.
pub dy: Rel<Length>,
/// The content to place.