sp-coach-indicator

NPM

0.42.2

Spectrum

View guidelines

Storybook

View Storybook

Try it on

webcomponents.dev
Examples API

Attributes and Properties #

Property Attribute Type Default Description quiet quiet boolean false static static 'white' | 'black' | undefined variant variant 'white' | 'black' | undefined

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 #

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';

Variants #

Standard 
<sp-coach-indicator></sp-coach-indicator>
<sp-coach-indicator variant="dark"></sp-coach-indicator>
<sp-coach-indicator variant="light"></sp-coach-indicator>
 Quiet 
<sp-coach-indicator quiet></sp-coach-indicator>
<sp-coach-indicator quiet variant="dark"></sp-coach-indicator>
<sp-coach-indicator quiet variant="light"></sp-coach-indicator>