Options

Options you can use to customise the AireFrame experience.

Headless Mode

AireFrame can be rendered in a 'headless' mode where the navigation components are not rendered. This may be useful when embededding AireFrame inside another site for example.

To use headless mode, all you need to do is add the query parameter ?headless=true to the URL.

You can also control how the subject banner is displayed by using the subjectBanner query parameter. The options are:

• hidden: No subject banner is displayed.
• collapsed: The subject banner is displayed in a collapsed state, showing only the subject's primary field value.
• expanded: The subject banner is displayed in an expanded state, showing all of the subject's custom field values.

Example

?headless=true&subjectBanner=collapsed

Subject Launch

You can launch directly into the subject record page by using the subject launch feature. This allows you to specify a unique custom field key and value to launch directly into the subject record page for the subject that matches that custom field key and value.

To use this feature, simply navigate to https://frame.aireinnovate.com/subject-launcher/<custom_field_key>/<custom_field_value>

Note

The custom field must be set to unique in the configuration for the specified custom field key in order for this feature to work.