f

faboxyst

@preview

Coloured, titled boxes — a tcolorbox-style toolkit.

v0.1.0
MIT

Package Information

Last Updated
Minimum Typst Version
0.15.0
Categories
componentslayout
Disciplines
educationcomputer-sciencemathematics

1. Get the package

Download the package using the TPIX CLI:

tpix get @preview/faboxyst:0.1.0

2. Import in your Typst file

Add this to your .typ file:

#import "@preview/faboxyst:0.1.0": *

Version History

0.1.00.15.0
a18b2545cf9e...

faboxyst

Coloured, titled boxes for Typst 0.15.x, in the spirit of LaTeX’s
tcolorbox. Version 0.1.0.
thumbnail.png

#import "@preview/faboxyst:0.1.0": *
#show: faboxyst.with(theme: themes.notebook)

#fabox(title: [Note])[A titled box.]
#sashbox(kind: "arch")[Welcome]
#ticket(stub: [12])[ADMIT ONE]

#show: faboxyst.with(…) is a theme show rule, not a document
class: it does not set the page.

What is in the box

  • fabox — the workhorse: titles, tabs (plaque, swoosh, fold,
    spine, ears, dots, …), shadows, zigzag / wave / caution borders.
  • fabox-sign / fabox-note — octagonal sign, folded yellow note.
  • Semanticnote, tip, warning, example, definition.
  • Papertorn-note, ruled-sheet, notepad, stamp-card,
    index-card, deckle-tag, lesson-card.
  • Textbook platesiconbox, crestbox, ribbonbox, helixbox,
    swooshbox, circuitbox, keybox, ringbox, punchbox,
    plannerbox, filebox, stubbox, stackbox, calloutbox,
    tapebox, chalkbox, markerbox, screwbox.
  • sashbox / ruban — folded ribbon (flat / arch / hang),
    incline for the bow, rough for a closed sloppy outline.
  • ticket / ticketbox — torn stub; hole and half-disc flip in RTL;
    digits stay Western.
  • RTL — tabs, rings, stubs, titles, sashes and tickets follow the
    reading edge (or stay physical where that is the point).

Manual

The guide is manual.typ /
manual.pdf: outline, numbered sections, signatures,
parameter tables, and code | result on every function. A 30-second
smoke test lives in examples/quickstart.typ.

Licence

MIT — see LICENSE. Box families follow tcolorbox
(Thomas F. Sturm). The wobble is a Rough.js / TikZ sketch port.
jotter-polylux (Andreas Kröpelin, MIT) inspired the sloppy frame and
the post-it fasteners.

FERGOUS Abdelhak.