Skip to content

Card

Where this goes: An entry in input.cards or output.cards.

Read the practical guide · See an illustrated example.

The tables below list configuration keys. Required means the key must be present in the config; it does not mean a labeler must answer the field.

A card grouping fields under a heading. The same shape drives read-only input cards and interactive output cards. Omit cards entirely for one implicit card holding every field, one per row.

Key Type Required Notes
name string yes Identifies the card; must be unique per side. min length 1, matches ^[A-Za-z0-9_-][A-Za-z0-9_ -]*[A-Za-z0-9_-]$|^[A-Za-z0-9_-]$
display string | TextDisplay no
scope "record" | "session" no session cards render on the setup step rather than once per record. Defaults to record.
rows array of CardRow yes The card’s rows, rendered top to bottom. at least 1 item