mirror
/
typst
mirror of https://github.com/stelzo/typst.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added example to `box.clip` & `block.clip` (#4870)

This commit is contained in:
Sébastien d'Herbais de Thun 2024-09-02 14:43:07 +02:00 committed by GitHub
parent 89521c2066
commit 39b47060cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
crates/typst/src/layout/container.rs
View File

@ -106,6 +106,18 @@ pub struct BoxElem {
pub outset: Sides<Option<Rel<Length>>>,
/// Whether to clip the content inside the box.
///
/// Clipping is useful when the box's content is larger than the box itself,
/// as any content that exceeds the box's bounds will be hidden.
///
/// ```example
/// #box(
/// width: 50pt,
/// height: 50pt,
/// clip: true,
/// image("tiger.jpg", width: 100pt, height: 100pt)
/// )
/// ```
#[default(false)]
pub clip: bool,
@ -422,6 +434,18 @@ pub struct BlockElem {
pub below: Smart<Spacing>,
/// Whether to clip the content inside the block.
///
/// Clipping is useful when the block's content is larger than the box itself,
/// as any content that exceeds the box's bounds will be hidden.
///
/// ```example
/// #block(
/// width: 50pt,
/// height: 50pt,
/// clip: true,
/// image("tiger.jpg", width: 100pt, height: 100pt)
/// )
/// ```
#[default(false)]
pub clip: bool,