Top
Enable the Spotlight feature
  • 17 Sep 2024
  • 2 Minutes To Read
  • Dark
    Light
  • PDF

Enable the Spotlight feature

  • Dark
    Light
  • PDF

Article summary

The Spotlight feature uses a Flow step to attract the user's attention to a specific element on the screen. When Spotlight is enabled, the end user is restricted to click only the element that completes the step. Interactions with other elements on the page are restricted and appear blacked out.
spotlight_demo

You can enable the Spotlight feature for Flows in the following ways:

  • While creating a flow.
  • After creating a flow.
  • Using tags.
While creating a flow

  1. Open the desktop application where you would like to create the Flow and then launch the Whatfix Desktop Studio.

  2. Click Flow.
    clm_Studio_flows

  3. Enter the name of the Flow as you want it displayed to the users.
    Editor_flow_name6

  4. Click + Add Step.
    Editor_flow_addstep

  5. Click the desired element on the page that the user needs to select.

  1. Click ADVANCED OPTIONS.
    Editor_flow_advanced_option

  2. Under More Options, enable the Show as spotlight toggle.
    Editor_flow_show_as_spotlight

  3. Once enabled, you have two options to personalize the Spotlight based on your needs.
    Editor_flow_spotlight_options

  • Opacity of overlay: This can be used to configure the opacity of the Spotlight. By default, it is set at 70.
  • Hide spotlight on hover: This option disables Spotlight when the user hovers their cursor over the selected element. This is ideal for drop-down elements where hovering over it shows multiple options.
  1. Click Save Step.
    Editor_flows_save_step

  2. To capture the next step or additonal steps, click + Add Step.
    Click_add_step

  3. Click Save Flow.
    save_flow.png

  4. Go to the Whatfix dashboard.

  5. In the Draft stage, select the Flow, and then click Send to ready.
    clm_db_send_to_ready

  6. In the Ready stage, select the Flow, and then click Push to production.
    clm_db_p2p

After creating a flow

  1. On the Whatfix Guidance dashboard, click Content.
    ia_left_nav_content

  2. Click Flows.
    ia_left%20nav_flows

  3. Hover your cursor over the required Flow, and then click the Edit icon.
    Desktop_Click_edit

  4. Go to the step and then click Edit.
    Dashboard_flow_edit_option

  1. Scroll down to the Spotlight Options section.
    spotlight_options.png

  2. Use the toggle button to enable Spotlight for the step.
    toggle_spotlight.png

  3. Customize the Spotlight based on your needs.

your title goes here

Use the following steps to customize the spotlight by changing its Overlay Opacity:

a. Select the checkbox next to Overlay Opacity.
spotlight_options.png

b. Change the opacity according to you needs. By default, it is set at 70%.

  1. Click Save Step.
    savestepflow.png

Using tags

You can also enable the Spotlight feature for one or more Flows using the spotlight tag. Spotlight is enabled for all the steps in the Flows to which the tag is added.

Use the following steps to enable the Spotlight feature using tags:

  1. On the Whatfix Guidance dashboard, click Content.
    ia_left_nav_content

  2. Click Flows.
    ia_left%20nav_flows

  1. Select the Flows you want to tag using the checkboxes.
    Desktop_Select_flows

  2. Click the Tags icon.
    Desktop_flows_click_tags

  3. Click the Plus icon.
    add_manage_tags.png

  4. Select the spotlight tag.
    spotlight_tag.png

  5. Click Done.
    done.png

Info:
  • If the Spotlight tag is added to a Flow and is also manually disabled for a step in the UI, then Spotlight for that step does not appear. The Step level configuration has precedence over the tag. The precedence for Spotlight is as follows:

Advanced Customization > Step level Spotlight configuration > Spotlight tag

  • The Spotlight works only on Flows. PDF, video, and article formats that are generated from the Flow do not display the spotlight.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.