Skip to content

Configuration Helper

Trevor Fayas edited this page Jan 2, 2022 · 1 revision

Xperience is all about creating great customer Xperiences. One way you can do that is to help guide content editors on how to build content.

The Baseline has a ConfigurationHelperViewComponent that allows you to give Edit-mode only tooltip or inline instructions to your user.

If you have a widget that requires some configuration, you can alert the user to edit the widget dialog and set something.

Or if you have a section that depends on Related Pages or Child Pages in order to display, you can alert them that there are no pages found and tell them how to enter the content in.

There are a couple of parameters:

  • visible: Whether or not to show the alert
  • mode: How you would like to display the information, either as a Tooltip (icon) or as Inline (bootstrap Alert box)
  • needs-attention: If true, the display will be red with an ! icon. If false, it will be blue with a ? icon.
  • instructions: The actual instructions, can be HTML.

Some examples are the _Layout page's Header/Footer areas.

Clone this wiki locally