[Index]

Model: data/Theme

Controls appearance of web page

Model Details: data/Theme

Title Description Details
Theme Name * The name that is given to the Theme. Valid characters allowed for the name are [a-zA-Z0-9_]
  • Field Name: name
  • Type: String
  • Pattern: ^[a-zA-Z0-9_]+$
Site Title Title displayed in the browser tab
  • Field Name: title
  • Type: String
Import File
  • Field Name: import_file
  • Type: String
  • Format: file
Import File Id
  • Field Name: import_file_id
  • Type: String
Backup Enabled Create backup if existing theme exists
  • Field Name: backup
  • Type: Boolean
Navbar Text Text that appears in the Navbar after login
  • Field Name: banner_title
  • Type: String
Description A description for the Theme.
  • Field Name: description
  • Type: String
Use this Theme to style Login page Determines if this theme is used to style the login page
  • Field Name: is_login_theme
  • Type: Boolean
Hide from Lower Hierarchies Indicates if the theme can be viewed and dowloaded at lower hierarchies.
  • Field Name: hide_from_lower_hierarchies
  • Type: Boolean
Interface The selected interface that is associated with the Theme. The interface can be an Administration or Self Service. Default: administration
  • Field Name: interface
  • Type: String
  • Default: administration
  • Choices: ["Administration", "Self Service"]
Theme Customisation The colours and images that comprise a theme.
  • Field Name: theme_customisation
  • Type: Object
Primary Colour This is the background colour for most menus and headers, as well as the text colour for links and buttons.
  • Field Name: theme_customisation.primary_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Primary Text Colour This is the text colour for anything with the primary colour background.
  • Field Name: theme_customisation.primary_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Accent Colour This colour is used when attention needs to be drawn for important notifications or active buttons and text.
  • Field Name: theme_customisation.accent_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Accent Text Colour This is the text colour for anything with the accent colour background.
  • Field Name: theme_customisation.accent_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Topbar Colour The colour used for the top bar of the site. Will use the primary colour if no value is given.
  • Field Name: theme_customisation.topbar_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Topbar Text Colour This is the text colour for the top bar. Will use the primary text colour if no value is given.
  • Field Name: theme_customisation.topbar_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Menu Colour The colour used for the menu on the left. Will use the primary colour if no value is given.
  • Field Name: theme_customisation.menu_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Menu Text Colour This is the text colour for the menu. Will use the primary text colour if no value is given.
  • Field Name: theme_customisation.menu_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Panel Colour The colour used for all the panels in the app.
  • Field Name: theme_customisation.panel_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Panel Text Colour This is the text colour for normal text in the app.
  • Field Name: theme_customisation.panel_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Input Colour The background colour for input fields. Will use the panel colour if no value is given.
  • Field Name: theme_customisation.input_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Input Text Colour The text colour for input fields. Will use the panel text colour if no value is given.
  • Field Name: theme_customisation.input_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Background Colour The colour of the background.
  • Field Name: theme_customisation.background_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Info Notification Colour The colour used for info notifications.
  • Field Name: theme_customisation.info_notification_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Info Notification Text Colour This is the text colour for info notifications.
  • Field Name: theme_customisation.info_notification_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Success Notification Colour The colour used for success notifications.
  • Field Name: theme_customisation.success_notification_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Success Notification Text Colour This is the text colour for success notifications.
  • Field Name: theme_customisation.success_notification_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Warning Notification Colour The colour used for warning notifications.
  • Field Name: theme_customisation.warn_notification_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Warning Notification Text Colour This is the text colour for warning notifications.
  • Field Name: theme_customisation.warn_notification_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Error Notification Colour The colour used for error notifications.
  • Field Name: theme_customisation.error_notification_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Error Notification Text Colour This is the text colour for error notifications.
  • Field Name: theme_customisation.error_notification_text_colour
  • Type: String
  • Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
  • Format: color
Font This is the main font used for page content. Defaults to Roboto.
  • Field Name: theme_customisation.theme_font
  • Type: String
  • Format: font
  • Choices: ["Aptos", "Arial", "Bebas Neue", "Courier New", "DM Sans", "Dosis", "Figtree", "Fira Sans", "Helvetica", "Inconsolata", "Inter", "Josefin Sans", "Manrope", "Montserrat", "Noto Sans", "Noto Serif", "Open Sans", "Oswald", "Poppins", "PT Sans", "Quicksand", "Raleway", "Roboto", "Roboto Mono", "Source Code Pro", "Times New Roman", "Ubuntu"]
Favicon The favicon for the site. Shown on the tab and when the site is bookmarked.
  • Field Name: theme_customisation.favicon
  • Type: String
  • Format: file
Favicon Id
  • Field Name: theme_customisation.favicon_id
  • Type: String
Logo This image is used for the logo in the top left of the menu bar. Must be a PNG image with a transparent background. Maximum file size is 0.5MiB and maximum dimensions are 600 pixels in width and 192 pixels in height.
  • Field Name: theme_customisation.logo
  • Type: String
  • Format: file
Logo Id
  • Field Name: theme_customisation.logo_id
  • Type: String
Login Logo This image is used for the logo on the login page. Must be a PNG image with a transparent background. Maximum file size is 0.5MiB and maximum dimensions are 600 pixels in width and 192 pixels in height.
  • Field Name: theme_customisation.login_logo
  • Type: String
  • Format: file
Login Logo Id
  • Field Name: theme_customisation.login_logo_id
  • Type: String
Login Background This image is used for the login screen background. Must be a PNG or JPEG image. Maximum file size is 5MiB and maximum dimensions are 1920 pixels in width and 1080 pixels in height.
  • Field Name: theme_customisation.login_bg
  • Type: String
  • Format: file
Login Background Id
  • Field Name: theme_customisation.login_bg_id
  • Type: String
Menu Background This image is used for the side menu background. Must be a PNG or JPEG image. Maximum file size is 2MiB and maximum dimensions are 240 pixels in width and 1040 pixels in height.
  • Field Name: theme_customisation.menu_bg
  • Type: String
  • Format: file
Menu Background Id
  • Field Name: theme_customisation.menu_bg_id
  • Type: String
Generate Admin GUI Theme Generate a new admin GUI theme, overwriting an existing theme of the same name
  • Field Name: theme_customisation.data_driven
  • Type: Boolean
Login Page Details How theme styles the login page
  • Field Name: login_page
  • Type: Object
Title Title displayed at top of login page
  • Field Name: login_page.title
  • Type: String
Banner Text Banner text displayed at bottom of login page. References to {{cookie_policy}} and {{privacy_policy}} will be replaced with relevant links when displaying the theme.
  • Field Name: login_page.banner
  • Type: String
  • MaxLength: 2048
Cookie Policy Reference to resultant hyperlink can be added as {{cookie_policy}} inside the Banner Text field
  • Field Name: cookie_policy
  • Type: Object
Link Text Text that will be displayed for the hyperlink
  • Field Name: login_page.cookie_policy.text
  • Type: String
Link URL URL that has Cookie Policy. Opens in a new tab
  • Field Name: login_page.cookie_policy.url
  • Type: String
Privacy Policy Reference to resultant hyperlink can be added as {{privacy_policy}} inside the Banner Text field
  • Field Name: privacy_policy
  • Type: Object
Link Text Text that will be displayed for the hyperlink
  • Field Name: login_page.privacy_policy.text
  • Type: String
Link URL URL that has Privacy Policy. Opens in a new tab
  • Field Name: login_page.privacy_policy.url
  • Type: String