Spotlight card

A spotlight card is for onboarding messages that need a more flexible layout, or don't require a dialog.

Deprecated

This package is deprecated. Use @atlaskit/spotlight.

Usage

You can customise the spotlight card to highlight app features in different contexts.

Parts

Examples of five spotlight cards with individual parts labeled. The description of each individual part follows this image.

  1. Stepper: Step through a series of cards to communicate multiple benefits of a single element or related task. Avoid using this to show the actual steps of a task, and always use as few steps as possible.
  2. Secondary button: Include a primary and secondary action. Best practice is to always allow people to dismiss the spotlight.
  3. Spotlight area action: Include a call to action to help the person interact with the spotlit feature.
  4. Illustration: Include an illustration if it enhances understanding for people, and doesn't distract. Illustrations should relate to the spotlight content or benefit.
  5. Heading: Include a heading to draw attention to the message. Keep your UI copy focused on the task that it helps people complete.

Accessibility

  • If you use an illustration that provides useful information, include alternative text. If it's only for decoration, avoid alt text, or consider removing the image altogether.
Was this page helpful?
We use this feedback to improve our documentation.
© 2026 AtlassianTrademark, (opens new window)Privacy, (opens new window)License