Displays
- Conveying the state of a run
- Rendering output in a custom format
Text

typescriptCopied1await airplane.display.text(`Found **${users.length}** users from team "${team.name}".`);
javascriptCopied1await airplane.display.text(`Found **${users.length}** users from team "${team.name}".`);
pythonCopied1airplane.display.text(f"Found **{len(users)}** users from team {name}.")
Table

typescriptCopied1await airplane.display.table(users);
javascriptCopied1await airplane.display.table(users);
pythonCopied1airplane.display.table(users)
JSON

typescriptCopied1await airplane.display.json(httpResponse);
javascriptCopied1await airplane.display.json(httpResponse);
pythonCopied1airplane.display.json(httpResponse)
File

typescriptCopied1// First ask the user for a file.2const { photo } = await airplane.prompt({ photo: "upload" });34// Then display it in the UI5await airplane.display.file(photo);
javascriptCopied1// First ask the user for a file.2const { photo } = await airplane.prompt({ photo: "upload" });34// Then display it in the UI5await airplane.display.file(photo);
pythonCopied1# First ask the user for a file.2values = airplane.prompt({ photo: "upload" });34# Then display it in the UI5airplane.display.file(values["photo"]);
API reference
The markdown-formatted content to render. See the CommonMark docs for an introduction to markdown formatting.
The list of rows to render in the table. Each row should be an object mapping header slugs to values. Columns that are not specified will default to None
. The selection, ordering, and naming of columns can be customized via opts.columns.
Declares the list of columns to include in the table.The order of columns in this list determines the order of columns when rendering the table. Each column can optionally specify a human-readable name that will be used when rendering the table. The name defaults to the slug.
Columns found in rows
that are not included in columns
will not be rendered.
If not specified, columns are inferred automatically from the provided rows:
- The set of columns is the union of all keys across all rows.
- The column order is inferred from the key order of the first row. All other columns not present in the first row are ordered after.
- Columns are named by their slug.
The object to render.
The file to render, as a download link. If the file is a text, csv, image, video, or audio file, it will also be shown inline alongside the download link.
The markdown-formatted content to render. See the CommonMark docs for an introduction to markdown formatting.
The list of rows to render in the table. Each row should be an object mapping header slugs to values. Columns that are not specified will default to None
. The selection, ordering, and naming of columns can be customized via opts.columns.
Declares the list of columns to include in the table.The order of columns in this list determines the order of columns when rendering the table. Each column can optionally specify a human-readable name that will be used when rendering the table. The name defaults to the slug.
Columns found in rows
that are not included in columns
will not be rendered.
If not specified, columns are inferred automatically from the provided rows:
- The set of columns is the union of all keys across all rows.
- The column order is inferred from the key order of the first row. All other columns not present in the first row are ordered after.
- Columns are named by their slug.
The object to render.
The file to render, as a download link. If the file is a text, csv, image, video, or audio file, it will also be shown inline alongside the download link.
The markdown-formatted content to render. See the CommonMark docs for an introduction to markdown formatting.
The list of rows to render in the table. Each row should be an object mapping header slugs to values. Columns that are not specified will default to None
. The selection, ordering, and naming of columns can be customized via columns.
Declares the list of columns to include in the table.The order of columns in this list determines the order of columns when rendering the table. Each column can optionally specify a human-readable name that will be used when rendering the table. The name defaults to the slug.
Columns found in rows
that are not included in columns
will not be rendered.
If not specified, columns are inferred automatically from the provided rows:
- The set of columns is the union of all keys across all rows.
- The column order is inferred from the key order of the first row. All other columns not present in the first row are ordered after.
- Columns are named by their slug.
The object to render.
The file to render, as a download link. If the file is a text, csv, image, video, or audio file, it will also be shown inline alongside the download link.