Add a block
add_componentAdd a component to the current canvas by supplying its name and schema-matching props. Returns the new block id and current display state, or an error explaining why it was not added.
Instructions
Add a component to the canvas the person is looking at. Props must match the component's props schema; a refusal gives the schema and an example. Returns the new block id and what it shows; read it: "nothing yet" means it shows no records now. A block that could not be shown (a type, field, date field, condition or tag the workspace does not have, one field asked for two values, a chart by a date with no period) is not added, and the error says why and what to do instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | full is the whole thing (the default). compact fits more on a page. icon is a glyph with its name for screen readers that opens the full thing; for people who know what it is. | |
| span | No | Width in columns of twelve. 12 is full width, 6 half, 4 a third. Defaults to 6. | |
| tone | No | Tints the block's surface. Defaults to none. | |
| frame | No | card gives the block a surface, bare sits flush on the page. Defaults to card. | |
| props | Yes | Props matching the component's schema. | |
| canvas | No | Which tab the block goes on, as a canvas id from the list of tabs; empty string is Home. Defaults to the tab the person is looking at. | |
| region | No | main is the body of the page. left and right are full height panes beside it: left for history and navigation, right for what the person glances at. header is the bar at the top, for what they reach for on every page; footer the bar at the bottom. Defaults to main. | |
| component | Yes | Component name, as the prompt lists it. |