Showybox is a package for creating colorful and customizable boxes.

Usage

To use this library through the Typst package manager (for Typst 0.6.0 or greater), write #import "@preview/showybox:0.1.1": showybox at the beginning of your Typst file.

Once imported, you can create an empty showybox by using the function showybox() and giving a default body content inside the parenthesis or outside them using squared brackets [].

By default, a box with no title, black borders, white background and 5pt border radius will be created.

#import "@preview/showybox:0.1.1": showybox

#showybox()[
  Hello world!
]

Looks quite simple, but the “magic” starts when adding a title and color. The following code creates two “unique” boxes with defined colors and custom borders:

// First showybox
#showybox(
  frame: (
    upper-color: red.darken(40%),
    lower-color: red.lighten(90%),
    border-color: black,
    width: 2pt
  ),
  title: "Hello world! - An example"
)[
  Hello world!
]

// Second showybox
#showybox(
  frame: (
    dash: "dotted",
    border-color: red.darken(40%)
  ),
  body-style: (
    align: center
  )
)[
  This is an important message!

  Be careful outside. There are dangerous bananas!
]

Reference

The showybox() function can recieve the following parameters:

• frame: A dictionary containing the frame’s properties
• title-style: A dictionary containing the title’s styles
• body-styles: A dictionary containing the body’s styles
• title: A string used as the title of the showybox
• body: The content of the showybox

Frame properties

• upper-color: Color used as background color where the title goes (default is black)
• lower-color: Color used as background color where the body goes (default is white)
• border-color: Color used for the showybox’s border (default is black)
• radius: Showybox’s radius (default is 5pt)
• width: Border width of the showybox (default is 2pt)
• dash: Showybox’s border style (default is solid)

Title styles

• color: Text color (default is white)
• weight: Text weight (default is bold)
• align: Text align (default is left)

Body styles

• color: Text color (default is black)
• align: Text align (default is left)

Known issues

• A break property and/or autobreak functionality is needed to avoid showyboxes’ overflow (when they occupy a full page and there’s lots of text inside them).
• A boxseparator (a horizontal line inside the showybox) will be needed to split a showybox content in two sections inside the same box.
• There’s a slightly thin line in showyboxes that have no borders or dashed borders, instead of white spaces or nothing.

Gallery

Changelog

Version 0.1.1

• Changed package name from colorbox to showybox
• Fixed a spacing bug in encapsulated showyboxes
  • Details: When a showybox was encapsulated inside another, the spacing after that showybox was 0pt, probably due to some “fixes” improved to manage default spacing between rect elements. The issue was solved by avoiding #set statements and adding a #v(-1.1em) to correct extra spacing between the title rect and the body rect.