Skip to main content

<st-screenshot-tour>

JSON type: ScreenshotTour

A product tour: a row of tab buttons, one per screenshot, and below it the selected screenshot in a framed figure with its step, title and caption. Only the selected screen is shown; the others are not rendered in the document flow.

Keyboard (on the tab row): Arrow Right/Down moves to the next tab and Arrow Left/Up to the previous one, both wrapping at the ends; Home and End jump to the first and last tab. Each of these moves focus to the tab and selects it. Tab and Shift+Tab move through the tabs as usual. On narrow screens the tab row scrolls sideways (it never scrolls the page vertically).

Usage​

import '@sankhyatronics/sankhya-cms/screenshot-tour'; // registers <st-screenshot-tour>

Properties​

PropertyAttributeTypeDefaultDescription
items—ScreenshotTourItem[][]The screens, in tab order.
labellabelstring'Tour screens'Accessible name for the tab group.

See the live examples in Storybook.