- 18 May 2022
- 1 Minute to read
- DarkLight
- PDF
Page properties reference
- Updated on 18 May 2022
- 1 Minute to read
- DarkLight
- PDF
This reference document describes the properties and style properties available for a page.
Page properties
When the page is selected, there are several properties that can be viewed or edited via the properties panel in the right sidebar.
Name
Human-readable name for the page. Used in e.g. property dropdowns where a page can be selected (such as when using the Open page flow function) and in the page selection menu. By default, this is also what is shown in the navigation bar when this page is open.
Page ID
Internal ID for the page. Corresponds to the index in the Composer URL in your browser. While this is the actual value used by internal APIs, in most cases, this value is resolved for you automatically, and you don't have to worry about it.
Show spinner on page load
If toggled on, the page will show a centered spinner instead of page content until the Hide spinner flow is called. This can be useful when e.g. navigating to details page that loads some data from the Internet, allowing you to provide direct feedback for user interaction without showing a broken UI.
Page styles
The **Style tab gives you access to the following style properties.
Padding
Used to set the padding for the base container on your page. Bound to the $paddingPageHorizontal
and $paddingPageVertical
theme variables by default.
Background color
Background color for the page. Bound to the $colorBackground
theme variable by default.
Disable scroll
If checked, you cannot scroll the page on mobile. This is useful if you want to create your own scrollable section with the Scroll view component.
Stretch to viewport height
If checked, the base container will grow to fill the whole viewport. This is useful if you want to e.g. position a component at the bottom of the screen with absolute
position.