sp-coach-indicator

Overview API

Description

Section titled Description

<sp-coach-indicator> show the connection between an object and its explanation in a touring mode — for example, the source of in an onboarding tour.

Usage

Section titled Usage

See it on NPM! How big is this package in your project?

yarn add @spectrum-web-components/coachmark

Import the side effectful registration of <sp-coach-indicator> via:

import '@spectrum-web-components/coachmark/sp-coach-indicator.js';

When looking to leverage the CoachIndicator base class as a type and/or for extension purposes, do so via:

import { CoachIndicator } from '@spectrum-web-components/coachmark';

Static color variants

Section titled Static color variants
Standard
<sp-coach-indicator></sp-coach-indicator>
<sp-coach-indicator static-color="dark"></sp-coach-indicator>
<sp-coach-indicator static-color="light"></sp-coach-indicator>
Quiet
<sp-coach-indicator quiet></sp-coach-indicator>
<sp-coach-indicator quiet static-color="dark"></sp-coach-indicator>
<sp-coach-indicator quiet static-color="light"></sp-coach-indicator>

API

Attributes and Properties

Section titled Attributes and Properties
Property Attribute Type Default Description quiet quiet boolean false staticColor static-color 'white' | 'black' | undefined