tblr

tblr provides helper functions to better control table formatting. tblr was inspired by the LaTeX Tabularray package. Like Tabularray, table formatting can be specified with directives, so the formatting can be separate from table entries. You can also continue to use cell-level formatting, too.

Here is an example:

Example 1

#import "@preview/tblr:0.3.0": *

#set page(height: auto, width: auto, margin: 0em)

#let pop = from-csv("
China,1313,9596,136.9
India,1095,3287,333.2
United States,298,9631,31.0
Indonesia,245,1919,127.9
Brazil,188,8511,22.1
Pakistan,165,803,206.2
Bangladesh,147,144,1023.4
Russia,142,17075,8.4
Nigeria,131,923,142.7"
)

#set table(stroke: none)

#context tblr(header-rows: 1, columns: 4,
  align: (left+bottom, center, center, center),
  // formatting directives
  rows(within: "header", 0, fill: aqua.lighten(60%), hooks: strong),
  cols(within: "body", 0, fill: gray.lighten(70%), hooks: strong),
  rows(within: "body", 1, 6, hooks: text.with(red)),
  cells(((2, -3), end), hooks: strong),
  col-apply(within: "body", span(1, end), decimal-align), 
  note((-3, 3), "Highest value"),
  // content
  [Country], [Population \ (millions)],[Area\ (1000 sq. mi.)],[Pop. Density\ (per sq. mi.)],
  ..pop
)

API

`tblr`

#tblr(header-rows: 0, caption: none, placement: auto, remarks: none, table-fun: table, ..args)

tblr is the main function for table creation that supports several helper functions.

Returns a Typst table.

Normal table arguments like columns, fill, gutter, table.hline, and cell contents are passed to the table function.

Other arguments can be special directives to control formatting. These include cells(), cols(), rows(), hline(), …

Named arguments specific to tblr include:

header-rows (default: auto): Number of header rows in the content. auto means determine number from header rows provided with content, otherwise zero.
remarks: Content to include as a comment below the table.
caption: If provided, wrap the table in a figure.
placement (default: auto): Passed to figure.
table-fun (default: table): Specifies the table-creation function to use.
note-numbering (default: “a”): Numbering for table notes.
note-fun (default: super): Formatting function for note indicators.
ret: If provided, tblr returns a dictionary with components. Options include:
- “components”: includes “table”, “remarks”, and more.
- “arguments”: as above but includes arguments passed to table-fun.
Because ret relies on internals, it is not guaranteed to be stable with version changes.

`cells` and other special formatting directives

cells is a directive to control formatting of cells. Positional arguments can be one or more row and column indicators or special types. The named argument within applies row ranges to “header” or “body” if supplied.

Each indicator is specified by a (row, col) array pair. Each row and col can be an integer or array of integers or indicators.

Accepted indicators include:

Positive integers: normal row/column indicators starting at 0.
end: the last row or column.
auto: all rows or columns.
Negative integers: indexing from the end; -1 is the last row/column.
span(to) or span(from, to): ranges of rows or columns. Note that the to argument to span is different than the to argument for range. With span, the to argument is inclusive. span(2, end) includes the last row/column.
A function that returns a boolean indicating whether to include the row or column; commonly calc.even or calc.odd to select alternating rows or columns.

Named arguments are passed to cells. These include normal arguments like fill and colspan.

Special arguments include directives that specify further processing. These include:

hooks: apply the given function to the cell content. Can also be an array of functions to apply sequentially.

Variations of cells include the following functions:

cols: Control formatting of columns. Normal positional arguments are one or more column indicators. All rows are included.
rows: Control formatting of rows. Normal positional arguments are one or more row indicators. All columns are included.

A directive is available to add table notes. note is a function with positional arguments. Notes are positioned at the bottom of the table before remarks. Arguments given as arrays indicating which cells to apply the note to (same format as cells). If one argument positional argument has content, it’s taken as the body of the note. If two positional arguments have content, the first is the marker for the note, and the second is the body of the note.

Several directives are available to control horizontal and vertical lines. These are like table.hline and table.vline, but they can include directives like end.

hline – also takes a within argument to apply to “header” or “body”.
vline

Another special directive function is apply which applies a function to columns of a matrix. The function supplied will receive a one-dimensional array and should return a one-dimensional array of the same size. The function is supplied as the last positional argument. It accepts a within argument of “body” to apply only to the columns in the body of the table. Like cells, each positional argument is a (row, col) array pair, and normal positional indicators can be used. col-apply is a version of apply where each positional argument is a column indicator.

Note that the order of formatting directives matters. These are processed in reverse order, so later entries override earlier entries.

Data Utilities

#from-csv(x, delimiter: ",", flatten: true, trim: true, evaluate: false)

Converts string x into an array. This is a thin wrapper over csv.decode. Options include:

delimiter: default: “,”
flatten: default: true: Flatten the result.
trim: default: true: Trim each string.
evaluate: default: false: eval each string to convert each to content.

#dataframe-to-table(df, include-header: true)

Convert df from a dataframe to a flat array suitable to passing to table. df is expected to be a dictionary in dataframe style where each component is a columnar array. If include-headers is true, the keys of the dictionary are included on the first row of the table returned.

Decimal Alignment

#decimal-align(a, decimal: regex("\.\d"), marker: "&", other-align: center)

decimal-align takes an array a and returns an array with contents aligned. Rules mostly follow tbl:

One position after the leftmost occurrence of the non-printing input token marker (default: &), if any is present.
Otherwise, the rightmost occurrence of the decimal. Defaults to . just before a digit.
Otherwise, the rightmost digit.
Otherwise, the content is aligned using other-align (default: center).

Alignment tries to work with formatted content and not just strings. That means it should work with footnotes, basic formatting, and basic equations. This is tricky, so there are probably bugs.

Note that decimal-align needs to be used in a context. Common usage is to apply that to tblr and use decimal-align with apply. Note that the apply directive must come after other formatting directives. That means it is applied first before any of the other formatting directives, and the contents are still strings.

Here is an example:

Decimal Alignment

#import "@preview/tblr:0.3.0": *

#set page(height: auto, width: auto, margin: 0em)


#context tblr(columns: 1,
  align: center, inset: 3pt, stroke: none,
  col-apply(auto, decimal-align),
  // content
  "Text",
  "10000",
  "0.12345",
  ".1",
  "1.00",
  "300.",
  "hello&",
  "&hello",
  "3x",
  "30. mi.",
  "100,000 sq. mi.",
  "192.168.1.1 ip",
  "v1.0.2"
)

General Alignment Utilities

#split-and-align(x, format: (), align: ())

Given an array of content x, split it according to format, and then align them based on align.

format: an array of regex strings. Each string is the point at which the content is split (on the right side of the regex).
Each of these splits x sequentially from left to right. If the regex doesn’t match, the “cell” is left blank, and matching continues with the next regex.
align is an array of left or right designations for each component. The length of align should be one longer than the length of format.

split-and-align must be used in a context. This function will traverse into content, including equations. If the content has contexts, the splitting will not work with that.

Here is an example. It also shows usage of dataframe-to-table.

Alignment Example

#import "@preview/tblr:0.3.0": *

#set page(height: auto, width: auto, margin: 0em)

#let df = (
  Polar: ($-130.5$, $50.2∠120.3°$, $100∠-120°$, $2.3∠1.2°$),
  Complex: ($130.5$, $50.2 + j 90.3$, $100 - j 110$, $-90 - j 120$),
  "Fancy Numbers": ($(4.23 ± 0.01) times 10^2$, $-25.23 ± 10.1$, $1.23 times 10^2$, $0.5$),
)

#let align-polar = split-and-align.with(
  //          50  .2         ∠      120  .3°    
  format: ("\d+", "[^∠]*", "∠",   "\d+"), 
  align:  (right, left,    right, right, left))
  // Regex meanings:
  // \d+:   one or more digits
  // [^∠]*: anything but ∠
  // ∠:     ∠
  // \d+:   one or more digits
  // The last element is everything after the last match.

#let align-complex = split-and-align.with(
  format: ("\d+", "[^+−-]*",   ".*j", "\d+"), 
  align:  (right, left,        right, right, left))

#let align-numbers = split-and-align.with(
  //                 (      4  .23         ±          0  .01             )    ×        10  ^2
  format: ("[^\d+−-]*", "\d+", "[^± ]*", "±",   "[\d]+", "[.\d]*", "[^×]*", "×",    "\d+"), 
  align:  (right,       right, left,     right, right,   left,     right,   right,  right, left))

#context tblr(columns: 3,
  header-rows: 1, column-gutter: 3em,
  align: center, inset: 3pt, stroke: none,
  rows(0, stroke: (bottom: 1pt)),
  col-apply(within: "body", 0, align-polar),
  col-apply(within: "body", 1, align-complex),
  col-apply(within: "body", 2, align-numbers),
  // content
  ..dataframe-to-table(df)
)

More Examples

Booktabs

This example tries to mimic booktabs. Replicating booktabs with Typst tables is a bit fiddly. table.hline works fine, but adjusting the spacings between rule locations and rows is tough. It’d be great to have this feature to adjust spacing around hlines. The approach below adjusts insets to make the spacing between rows nicer. The column-gutter is needed for separation of the rules between the two column blocks. This example also shows the use of caption, remarks, and note.

Example 3

#import "@preview/tblr:0.3.0": *

#set page(height: auto, width: auto, margin: 2pt)
#show figure.where(kind: table): set figure.caption(position: top)

#tblr(columns: 7, header-rows: 2,
  stroke: none,
  // combine header cells
  cells((0, (1,4)), colspan: 3, stroke: (bottom: 0.03em)),
  column-gutter: 0.6em,
  // booktabs style rules
  rows(within: "header", auto, inset: (y: 0.5em)),
  rows(within: "header", auto, align: center),
  hline(within: "header", y: 0, stroke: 0.08em),
  hline(within: "header", y: end, position: bottom, stroke: 0.05em),
  rows(within: "body", 0, inset: (top: 0.5em)),
  hline(y: end, position: bottom, stroke: 0.08em),
  rows(end, inset: (bottom: 0.5em)),
  // table notes, remarks, and caption
  note((1, (1,4)), [$m v$ is in kg·m².]),
  note((1, (3,6)), [Time is in secs.]),
  note(sym.dagger, (2, 0), [Another note.]),
  remarks: [_Note:_ ] + lorem(18),
  caption: [This is a caption],
  note-fun: x => super(text(fill: blue, x)),
  note-numbering: "a",
  // content
  [], [tol $= mu_"single"$], [], [], [tol $= mu_"double"$], [], [],
  [], [$m v$], [Rel.~err], [Time], [$m v$], [Rel.~err], [Time], 
  [trigmv],  [11034], [1.3e-7], [3.9], [15846], [2.7e-11], [5.6], 
  [trigexpmv], [21952], [1.3e-7], [6.2], [31516], [2.7e-11], [8.8], 
  [trigblock], [15883], [5.2e-8], [7.1], [32023], [1.1e-11], [1.4e1], 
  [expleja], [11180], [8.0e-9], [4.3], [17348], [1.5e-11], [6.6])

The approach above is a bit cumbersome, but the formatting directives can be used as part of a wrapper function if you want to create many tables with a booktabs style. Here’s an example:

#let booktbl = tblr.with(
  stroke: none,
  column-gutter: 0.6em,
  // booktabs style rules
  rows(within: "header", auto, inset: (y: 0.5em)),
  rows(within: "header", auto, align: center),
  hline(within: "header", y: 0, stroke: 0.08em),
  hline(within: "header", y: end, position: bottom, stroke: 0.05em),
  rows(within: "body", 0, inset: (top: 0.5em)),
  hline(y: end, position: bottom, stroke: 0.08em),
  rows(end, inset: (bottom: 0.5em)),
)

Graphical Styling

This example shows use of a custom function to add some graphical styling to one of the columns of a table. Adapted from here. It also shows including passing in a table.header with header-rows defaulting to auto.

Example 2

#import "@preview/tblr:0.3.0": *

// Adapted from https://www.storytellingwithdata.com/blog/2012/02/grables-and-taphs
#set page(height: auto, width: auto, margin: 0em)

#let data = from-csv(delimiter: "|", "
Tower Hamlets          | 1  | 3  | 269 | 9692642
Hackney                | 2  | 2  | 225 | 7809608
Southwark              | 3  | 12 | 232 | 7266118
Camden                 | 4  | 14 | 136 | 6140419
Islington              | 5  | 4  | 156 | 5424137
Lambeth                | 6  | 8  | 156 | 5257941
Newham                 | 7  | 2  | 154 | 5217075
Hammersmith and Fulham | 8  | 13 | 109 | 4085708
Merton                 | 9  | 29 | 113 | 3656112
Croydon                | 10 | 20 | 127 | 3629066
")

#let bar(x) = {
  rect(width: int(x) / 7000000 * 2in, fill: blue, text(fill: white, x))
}

#tblr(columns: 5,
  stroke: none,
  align: center+horizon,
  // formatting directives
  rows(within: "header", auto, fill: aqua.lighten(60%), hooks: strong),
  cols(within: "body", 0, align: left, fill: gray.lighten(70%), hooks: strong),
  cols(within: "body", -1, align: left, hooks: bar),
  // content
  table.header([Borough],[Trust\ rank],[Index\ rank],[Number\ of grants],[Amount approved (£)]),
  ..data
)

Changelog

v0.3.0

Add note for table notes.
Improve decimal alignment to work with notes and other formatting.
Add general alignment utilities, including split-and-align.
Add data utilities from-csv and dataframe-to-table.
Add ret option to tblr to allow returning components.
Add tests.

v0.2.0

Remove functions like body-cells. Use cells(within: "body"...) instead.
Add apply and col-applyto apply a function column wise.
Fix a bug in span on the to argument.
Add decimal-align to align on decimals.
Change the default in header-rows to auto. Traverse into headers provided with content.

v0.1.0

Initial release

How to add

Copy this into your project and use the import as tblr

#import "@preview/tblr:0.3.0"

Check the docs for more information on how to import packages.

About

Author:

Tom Short

License:

MIT

Current version:

0.3.0

Last updated:

December 16, 2024

First released:

December 5, 2024

Archive size:

11.6 kB

Repository:

GitHub

Categories:

Where to report issues?

This package is a project of Tom Short. Report issues on their repository. You can also try to ask for help with this package on the Forum.

Please report this package to the Typst team using the contact form if you believe it is a safety hazard or infringes upon your rights.

Version history

Version	Release Date
0.3.0	December 16, 2024
0.2.0	December 9, 2024
0.1.0	December 5, 2024

Typst GmbH did not create this package and cannot guarantee correct functionality of this package or compatibility with any version of the Typst compiler or app.

API

tblr

cells and other special formatting directives

Data Utilities

Decimal Alignment

General Alignment Utilities

More Examples

Booktabs

Graphical Styling

Changelog

v0.3.0

v0.2.0

v0.1.0

`tblr`

`cells` and other special formatting directives