# Allergen matrix card

> Canonical HTML: https://screenrig.ai/docs/cards/allergen-matrix/

Show staff-supplied allergen declarations and calories, arranged by menu item.

Display menu items against the US 9, EU/UK 14 or Canada 11 preset. Each cell distinguishes contains, may contain, not declared and unknown; omitted information stays unknown. Portrait pages the columns in groups of seven. Compact views direct guests to the team for complete details.

## Live card

This card is drawn in your browser by the same code the Players run, with sample data.

Category: Food and drink. Tags: Restaurants and cafes, Healthcare.

## Layouts

This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.

Layouts: full. Forms: landscape, portrait.

[Card layouts, themes and publishing](/docs/cards/). [Browse the cards](/apps/#cards).

## Data and privacy

This card uses its configured properties and live card data.

Only display ingredient declarations supplied and maintained by the venue.

## Properties

For theme, background, accent and position, see [Common properties](/docs/cards/#common-properties).

Set static properties in `params`. Bind `data` to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in `params`. Nested rows describe the contents of their parent property.

### Static properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `preset` | string | `"us-9"` | `"us-9"`, `"eu-uk-14"`, `"canada-11"` |  |
| `rowsPerPage` | integer | `6` | `4`, `6`, `8` |  |
| `pageSeconds` | integer | `12` | minimum: `8`; maximum: `120` |  |
| `focusItem` | integer | `1` | minimum: `1`; maximum: `40` |  |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `title` | string | `"Nutrition and allergens"` | maxLength: `80` |  |
| `subtitle` | string | `""` | maxLength: `160` |  |
| `footnote` | string | `"Ask our team for full ingredient and allergen information."` | maxLength: `240` |  |
| `updatedAt` | string | `""` | maxLength: `40` |  |
| `items` | array | `[]` | maxItems: `40` |  |
| `items[].name` | string |  | minLength: `1`; maxLength: `100`; Required |  |
| `items[].serving` | string | `""` | maxLength: `80` |  |
| `items[].kcal` | integer |  | minimum: `0`; maximum: `5000` |  |
| `items[].allergens` | object | `{}` | additionalProperties: `false` | Explicit declarations for the selected preset keys. Missing keys are unknown. Not declared is not a free-from guarantee. Grouped Canada keys are supplied explicitly. |
| `items[].allergens.milk` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.eggs` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.fish` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.crustaceans` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.molluscs` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.tree-nuts` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.peanuts` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.wheat` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.soy` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.sesame` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.celery` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.gluten` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.lupin` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.mustard` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.sulphites` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.wheat-triticale` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |
| `items[].allergens.crustaceans-molluscs` | string |  | `"contains"`, `"may-contain"`, `"not-declared"`, `"unknown"` |  |

## Canvas example

Add this item to a playlist page’s `primitives`. [Publish the playlist and assign a screen](/docs/cards/#publish-a-card-canvas).

```json
{
  "id": "allergen-matrix",
  "primitive": "card",
  "card": "allergen-matrix",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "example-key"
}
```

## Write live data

The canvas example binds its `data` field to `example-key`. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with `feed:`.

Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.

Save the document as `card-data.json`. The CLI reads the document itself, with no wrapper:

```json
{
  "title": "Nutrition and allergens",
  "subtitle": "",
  "footnote": "Ask our team for full ingredient and allergen information.",
  "updatedAt": "",
  "items": []
}
```

```console
screenrig card-data put example-key --file card-data.json
```

Or call the API directly. The API wraps the same document in a `document` field. An agent token already names its project, so no project header is sent; if you send `ScreenRig-Project`, it must match the token’s project. Supply your API authorization through the environment; see [API authentication](/docs/authentication/).

```console
curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"title":"Nutrition and allergens","subtitle":"","footnote":"Ask our team for full ingredient and allergen information.","updatedAt":"","items":[]}}'
```