@atlaskit/spotlight

Spotlight

The spotlight component is used typically during onboarding to highlight elements of the UI to the user in a modal dialog.

Example

import { Spotlight, SpotlightManager, SpotlightTarget } from '@atlaskit/spotlight';

class MyClass extends Component {
  render() {
    return (
      <SpotlightManager>
        <div>
          <SpotlightTarget name="foo">
            <span>bar</span>
          </SpotlightTarget>
          <Spotlight target="foo">
            <span>baz</span>
          </Spotlight>
        </div>
      </SpotlightManager>
    );
  }
}

Try it out

Interact with a live demo of the @atlaskit/spotlight component.

Installation

npm install @atlaskit/spotlight

* Please note that this module could have dependencies that are governed by the Atlassian Design Guidelines license which will be automatically included on install. Each dependency has a license file that indicates whether the Atlassian Design Guidelines license applies.

We're here to help!

Let us know what you think of our components and docs, your feedback is really important for us.

Are you in trouble? Read through our contribution guidelines and raise an issue to us.