Guide / Controls / Readouts

Cards

A stack of cards

When to use it. Not for store rows: this control browses documentation nodes. Rows from a store use the list control (Card padding).

Type
cardList
Also titled
Card List
Default size
4 rows × 4 columns
Symbol
list.bullet.rectangle.fill
Docs
Docs complete
Search for it as
  • cards
  • feed
  • tiles
  • items
  • results
  • stack
Cards: Control browser pane
Rendered by the app

Emits and receives

What this control sends when you use it, and what it can show or follow when data arrives.

Receives

Receives
TakesFromTypeWhat it does
nodesshowhub, mqtt, http, storejson

nodes: an id with an optional name, category and icon each (links between nodes are ignored)

the cards are rebuilt under their category headers; the search box keeps filtering them

Example: {"nodes": [{"id": "item-1", "label": "Item 1", "group": "Row 1"}], "edges": []}

Sample

The placeholder value the editor shows before real data arrives.

  • {"nodes": [{"id": "item-1", "label": "Item 1", "group": "Row 1"}, {"id": "item-2", "label": "Item 2", "group": "Row 1"}, {"id": "item-3", "label": "Item 3", "group": "Row 2"}], "edges": []}

Examples

3 examples, each one a control you can paste into a layout.

Control browser pane

A full-size browser fed by a catalog broadcast.

JSON 7 lines
{
  "type": "cardList",
  "id": "control-browser",
  "position": [0, 0],
  "span": [6, 4],
  "sync": [{ "method": "meshsocket", "type": "listen", "event": "broadcast", "filter": { "msg_type": "catalog" }, "valuePath": "graph" }]
}

Open in CAR-TER

The server feeds it with a broadcast_request whose payload is {"msg_type": "catalog", "graph": {…}}.

Cards: Control browser pane
Rendered by the app

Custom search hint

A compact card list with its own placeholder text.

JSON 7 lines
{
  "type": "cardList",
  "id": "doc-browser",
  "position": [0, 0],
  "span": [4, 4],
  "sync": [{ "method": "meshsocket", "type": "listen", "event": "broadcast", "filter": { "msg_type": "catalog" }, "valuePath": "graph" }]
}

Open in CAR-TER

Side panel of cards

A narrow tall list beside other controls.

JSON 8 lines
{
  "type": "cardList",
  "id": "side-cards",
  "position": [6, 0],
  "span": [3, 6],
  "searchPlaceholder": "Search models",
  "sync": [{ "method": "meshsocket", "type": "listen", "event": "broadcast", "filter": { "msg_type": "models" }, "valuePath": "graph" }]
}

Open in CAR-TER

Try it on your phone

carterkit serves a small hub on your computer and pushes one example to CAR-TER on your iPhone or iPad. Pair once with the code it prints.

  1. Install the Python kit.

    pip install carterkit
  2. Show “Custom search hint” on your phone.

    carterkit demo cardList --example 'Custom search hint'
  3. Swap in any example name from this page, or leave --example off for the first one.

carterkit quickstart · Get CAR-TER

A searchable, scrollable browser that renders the same node data as the Particles control as a list of cards grouped by category. Each card shows a live example of the control on the left with its name and summary; tapping a card opens the control's documentation. Reads the same synced GraphData value as graph and uses only the nodes (edges are ignored).

Fields

Field Type Default Description
searchPlaceholder string "Search" Placeholder text shown in the search field while it is empty

Behavior

  • A search field filters cards by name or category.
  • Cards are grouped under category separators (Border thickness headers): Controls, Display, Layout, System, Models.
  • Tap a card to open its doc page; see Shadow opacity for the shared fields.

Generated from ControlDocs/cardList.md. Something unclear or missing? Tell me.