Time-based Toggle

Time-based Toggle is a Logic Component and part of the Component Modifiers Component Set. It enables Studio Users to control at what times throughout the week that a specific components appears in the app. For example, a banner can show only Monday-Friday from 9 a.m. - 5 p.m. 

Add a Time-based Toggle to a Page

1
Create or open an existing app.
2
Click the Edit Pencil on a Page.
3
Click the Add New under the Logic section on the left.
4

The Time-based Toggle Component will appear at the bottom of the Content list in the left hand column. The Time-based Toggle Properties will appear in the right hand column.

Time-based Toggle Properties

The Time-based Toggle Component has the following properties:

  • Component Id - Sets the name of the Image 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.
  • Target Component Id - Enter the Component Id that you want controlled by the Time-based Toggle Component.  
  • Timezone - Enter the Timezone for the Time-based Toggle. Here is a list of available time zones in the correct format.
  • Days of the Week (Sunday - Saturday)
    • Start Time 1 - Enter the start time for the specific day when the Target Component is shown to app end users. The Start Time must be written in military time. For example, 13:30 instead of 1:30 p.m.
    • End Time 1 - Enter the End Time for the specific day when the Target Component is shown to app end users. The End Time must be written in military time. For example, 13:30 instead of 1:30 p.m.
    • Start Time 2 - Enter the Start Time for the specific day when the Target Component is shown to app end users. The Start Time must be written in military time. For example, 13:30 instead of 1:30 p.m.
    • End Time 2 - Enter the End Time for the specific day when the Target Component is shown to app end users. The End Time must be written in military time. For example, 13:30 instead of 1:30 p.m.
    • All Day - Toggle on or off if the Target Component is shown all day on the selected day of the week. 

Time-based Toggle 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.

Still need help? Contact Us Contact Us