Configuration

Configure the Page UI
Once you've set up your library, you can customize your Pages. We currently allow you to change what's shown on the Page, set the Page icon within your library, and add navigational buttons. Add an index.airplane.yaml file to a directory in your library in order to start customizing the Page corresponding to that directory.

Basic customization
Set the name and description fields to edit the heading and subheading of the Page, and set the icon field to an emoji to customize the Page's icon in the Library.
yaml
Copied
1
# index.airplane.yaml
2
name: Custom name!
3
description: This is a very important page
4
icon: 🔨

Change which tasks and runbooks are displayed
By default, tasks that are defined in the Page's corresponding directory are shown on the Page. To show more tasks on the Page from outside the directory, including tasks that may not be in the library/ folder at all, include those task slugs in the additionalTasks field. Similarly, use additionalRunbooks to link runbooks to the Page.
If you'd like to exclude tasks inside the Page's directory from being shown, include those task slugs in the hiddenTasks field. As a shortcut, you can set it to * to exclude all tasks in the directory. Note that additionalTasks is applied after hiddenTasks, so you can fully control the tasks that are shown by excluding all tasks and then specifying the exact tasks to be included in additionalTasks.
yaml
Copied
1
# index.airplane.yaml
2
name: Custom name!
3
description: This is a very important page
4
icon: 🔨
5
additionalTasks:
6
  - top_level_task
7
hiddenTasks:
8
  - "*"
9
additionalRunbooks:
10
  - test_book

Actions
You can add action buttons to your Page that link to Airplane entities or to any url. By default, actions will open a preview of the entity on the right side of the Page. You can set the as field to center_peek to open it in a modal or full_page to open it your current window. The action takes in a label field and a task, view, runbook, page, or href field representing the slug of the task, view, or runbook or the path of the page or the url to preview. If no label is provided, the entity slug or href will be used for the label.
You can also pass Task params, Runbook params, or Views params to the preview by including a paramValues field in the action. This will pre-fill the parameters in the task/runbook/view when the preview is opened.
yaml
Copied
1
# index.airplane.yaml
2
name: Custom name!
3
description: This is a very important page
4
icon: 🔨
5
additionalTasks:
6
  - top_level_task
7
hiddenTasks:
8
  - "*"
9
additionalRunbooks:
10
  - test_book
11
actions:
12
  - label: Get sales data
13
    task: sales_query
14
  - label: Go to other task
15
    task: other_task
16
    as: full_page

Reference
name
optional
string

Name of the Page.

description
optional
string

Description of the Page.

icon
optional
string

Icon to show for the Page. Must be a single emoji.

additionalTasks
optional
string[]

Slugs of other tasks to show on the Page.

hiddenTasks
optional
string[]

Slugs of tasks that were defined in the Page's directory, but shouldn't be shown on the Page. You can use the special wildcard "*" to exclude all tasks in the directory. hiddenTasks does not affect task slugs specified in additionalTasks.

additionalRunbooks
optional
string[]

Slugs of runbooks to show on the Page.

actions
optional
Action[]
List of actions to show on the Page.
Action definition
Actions become buttons with the corresponding label, linking to an entity according to the method specified by as. as defaults to "side_peek". A maximum of 3 actions are shown.
PrivacyTermsSupport