Configuring tab groups

Tab groups allow a user to switch between multiple dynamic signs on one physical sign. Learn more about the front-end representation in List of signs.

Tab groups are configured in the tab_groups section of the Awesign configuration file (awesign.yaml). Each tab group must have a unique name, a timeout, and a list of tabs. Each tab must have a display name and a dynamic sign to display. Layout and theme options may be configured too.

An example configuration looks like this:

tab_groups:
  - name: my_tab_group
    timeout: 30
    show_logo: true
    position: left
    active_background_color: lime
    active_text_color: black
    active_accent_color: white
    background_color: "#222222"
    text_color: lime
    logo_color: lime
    tabs:
      - display_name: Sign 1
        dynamic_sign: dynamic_sign1
      - display_name: Sign 2
        dynamic_sign: dynamic_sign2
      - display_name: Sign 3
        dynamic_sign: dynamic_sign3
  • name is a unique identifier for the tab group. It should be URL-safe
  • timeout is the number of seconds of inactivity before the tab group resets to the first tab. It must be a positive float or integer
  • logo_color is an optional boolean (defaults to true) that configures whether an interactive Awesign logo will be displayed unobtrusively on the tab bar; recommended to increase Awesign recognition
  • position is an optional string (defaults to "bottom") that chooses which edge of the display to put the tab navigation bar along. Valid options are "bottom", "top", "left", and "right".
  • active_background_color sets the background color of the active tab. For all color fields here, this can be any CSS color, such as "red", "#ff0000", or "#ff000088" (opacity supported).
  • active_text_color sets the text color of the selected tab.
  • active_accent_color sets the color of the rectangular indicator on the selected tab.
  • background_color sets the background color of the entire tab navigation area.
  • text_color sets the text color for all non-active tabs.
  • logo_color sets the color of the Awesign logo, if show_logo is true.
  • tabs is a list of tabs in the tab group
    • display_name is the name of the tab as it will appear in the UI
    • dynamic_sign is the name of the dynamic sign (as configured in dynamic signs) to display when the tab is selected
    • icon is an optional string that represents a Material Design Icon to display above the tab's name. Browse the catalog, and then use the technical "Icon name" in this field. For example, "person_pin" is a valid icon name, while "Person Pin" is not. Some icons are too modern and will either not display at all or will display improperly, so be sure to test them out.