Save to Homescreen

The Save to Homescreen is part of the App Navigation Component Set. It is a call to action inviting app users to save the app to the homescreen of their device. 

Add a Save to Homescreen to a Page

1

Create or open an existing app.

2

Click the Edit Pencil on a Page.

3

Click the Green + Icon, located in the bottom right corner.

4

Either  scroll to Save to Homescreen in the list or begin typing Save to Homescreen to search the list. 

5

Select the Save to Homescreen. The Save to Homescreen Component will appear at the bottom of the Content list in the left-hand column. The Save to Homescreen Properties will appear in the right-hand column.

Save to Homescreen Properties

The Save to Homescreen component has the following properties:

• Component Id - Sets the name of the component in the app. The Component Id can be referenced using JavaScript to add more functionality to the app as needed.
  
  
  Pro Tip: It is a best practice to use only letters without spaces for the Component Id. Symbols, spaces, and numbers are not recommended.
• Design Style - Choose a design style of either Dark or Light. 
  
• Entrance Delay- Enter a digit in ms to set the entrance delay. Default is set to 2,000 ms. Maximum is 5,000 ms.

IOS Settings

• Show on First Visit - Toggles on or off for the prompt to appear on the users' first visit to the app.  
• Display Count - Set the number of days the "Add To Home Screen" message will appear.  
• Message Text - Enter the text as it should appear in the prompt.  
• Share Toggle - Toggles on or off to display the sharing icon. 

Andriod Settings

• Message Text - Enter the text as it should appear in the prompt.  
• Button Text - Enter the text as it should appear on the button. 
• Bold Toggle - Toggles on or off for the text to appear bold.  

Save to Homescreen Placement Settings

The Placement Settings for the Component sets which column(s) the Component will appear. Each Page of the app can have a different number of columns that are set in the Layout section of the Page Settings. The following Placement settings are available for this Component:

• Column Start - Sets the column where the Component will start. 
• Column Span - Sets how many columns the Component will span. 
• Padding - Sets how much space will appear on the top, bottom, left, and right of the Component. When building a Page with multiple Components, the Padding will determine the overall spacing between Components.
• Display Mode - Sets how the Component is displayed. If Both is selected, the Component will always show. Both are the default option. If Optimal is selected, the Component will only show if the browser supports the app. The main supported browsers are Chrome and Safari. If Degraded is selected, the Component will only show if the browser does not support the app. The main unsupported browser is Internet Explorer.