Tray Embedded / Core Topics / Managing CSS / Config Wizard CSS

Config Wizard CSS

Overview

In order to customize the Configuration Wizard which pops up when End Users are configuring a Solution Instance for their own use, it is possible to upload your own custom CSS in your Partner Account settings.

This will allow you to make sure that Config Wizard screens visible to End Users are in keeping with your branding.

Note: It is recommended that you only make simple styling changes to the Config Wizard. Changing the layout and positioning of items may break the display and may also be subject to being overwritten by product updates. The main purpose of this feature is to allow styling changes to colours, fonts, the shape/roundness of buttons, the thickness of borders etc.

Activate Config Wizard CSS by setting Embedded ID

To activate the feature you first of all need to set an Embedded ID (e.g. the initials of your company)

Editing the Config Wizard CSS

You have a choice of either uploading custom css files (using the 'choose file' button), or using the in-app editor and live preview facility (using the 'Edit & Preview' button).

Downloading the pre-populated CSS/LESS file or using the Edit & Preview function will show you the classes available to work with.

You can work with elements according to the following example:

  • partner__item affects all items in the UI
  • partner__item--auth specifically affects all authentication items (e.g. auth drop-down list)

So the following rule could be implemented to affect all authentication items .partner__item--auth > div { color: red; }

The following screenshot shows the live edit and preview when customizing your CSS:

Following is the full list of available classes:

partner__screen
partner__screen--first
partner__screen--last
partner__screen__header
partner__screen__header__title
partner__screen__header__description
partner__screen__items
partner__item__title
partner__item--auth
partner__item--config
partner__item--public-url
partner__modal__delete-auth
partner__modal__edit-auth
partner__modal__new-auth
partner__message--error
partner__field__checkbox
partner__field__radio
partner__button--cancel
partner__button--previous
partner__button--finish
partner__button--next
partner__button--add
partner__footer
partner__footer__button-group
partner__footer__step-indicator
partner__footer__step-indicator__dot
partner__footer__step-indicator__dot--active

Testing your CSS

You can create a test project and solution before running our demo app in order to preview and check that your CSS is working as expected.

Note on Caching

Note that once you save changes, it can take up to an hour for CSS changes to fully propagate to your applications globally.

Further Notes

Some further notes when editing CSS:

  1. Avoid using more than 2 levels within a class (for example .partner__screen div h1 span)

  2. Analysis of the source CSS for the End User Config Wizard will show that there are some Tray-specific classes (such as 'header_123ABC123QWE') for elements in the wizard. These are hashed on deployment so will change regularly. Therefore you should not attempt to use these as customizable classes.

  3. Some elements may require the use of !important to take effect. For example:

.partner__button--next{
background: green!important;
}

in order to change the color of the 'Next' button.