Skip to content
awesome-tour

Type to search every page.

    BHelp launcherContents

    Help launcher

    A resource center button that lets people replay tours, see what's new and find help — whenever they want.

    Tours that only run once are easy to miss. A launcher gives users a place to come back to: a button that opens a panel listing tours to replay (with their status), and any links you want.

    Help launcher
    Loopworknight-drive.lwp
    001.1.1
    1. 1
    2. 2
    3. 3
    4. 4
    5. 5
    6. 6
    7. 7
    8. 8
    Drums
    Beat A
    Beat B
    Bass
    Sub line
    Keys
    Rhodes
    Vox
    Hook (dry)

    Beat A

    16 steps · drums
    Kick
    Snare
    Hat
    Clap

    Mixer

    4 channels
    Drums
    80%
    Bass
    35%
    Keys
    60%
    Vox
    50%
    LauncherDemo.tsx
    import { createTour, Tour, TourProvider } from '@awesome-tour/react';
    import { LoopworkApp, parts } from '@loopwork';
    import { HelpLauncher } from '@/components/awesome-tour/launcher';
    import { TourPopover } from '@/components/awesome-tour/tour';
    import { DemoFrame } from './ui';
    const $ = parts('help');
    const firstSession = createTour({
    id: 'docs-launcher-first-session',
    steps: [
    {
    id: 'transport',
    target: $('transport'),
    title: 'Transport',
    description: 'Play, stop and record. The counter reads bar · beat · step.',
    },
    {
    id: 'arrangement',
    target: $('arrangement'),
    title: 'Arrangement',
    description: 'One lane per channel; clips are the parts of your song.',
    },
    ],
    });
    const effects = createTour({
    id: 'docs-launcher-effects',
    steps: [
    {
    id: 'slot',
    target: $('fx-slot'),
    side: 'left',
    title: 'Drum bus effects',
    description: 'Drive and tape saturation, on every drum hit before the mixer.',
    },
    ],
    });
    export function LauncherDemo() {
    return (
    <TourProvider tours={[firstSession, effects]}>
    <DemoFrame
    title="Help launcher"
    actions={
    <HelpLauncher
    side="bottom"
    className="relative right-auto bottom-auto size-9 shadow-none"
    tours={[
    {
    tour: firstSession.id,
    title: 'Your first session',
    description: 'Transport and arrangement.',
    },
    { tour: effects.id, title: 'Shaping drums', description: 'The drum bus effects.' },
    ]}
    links={[{ title: 'Keyboard shortcuts', href: '#' }]}
    />
    }
    >
    <LoopworkApp scope="help" />
    </DemoFrame>
    <Tour.Root tour={firstSession}>
    <TourPopover />
    </Tour.Root>
    <Tour.Root tour={effects}>
    <TourPopover />
    </Tour.Root>
    </TourProvider>
    );
    }
    import { Launcher } from '@awesome-tour/react/surfaces';
    <Launcher.Root>
    <Launcher.Trigger>
    Help <Launcher.Badge tours={['onboarding', 'billing']} />
    </Launcher.Trigger>
    <Launcher.Portal>
    <Launcher.Content>
    <Launcher.Item tour="onboarding">Product tour</Launcher.Item>
    <Launcher.Item tour="billing">Billing basics</Launcher.Item>
    <Launcher.Item asChild>
    <a href="/docs">Documentation</a>
    </Launcher.Item>
    </Launcher.Content>
    </Launcher.Portal>
    </Launcher.Root>
    Part Does
    Root Open state (open / defaultOpen / onOpenChange).
    Trigger Toggles the panel (aria-expanded, data-state).
    Content The panel, positioned next to the trigger (side, align…). Escape and outside clicks close it.
    Item With tour (an instance or a provider id): restarts it — interrupting what’s on screen — and gets `data-status=“new
    Badge How many of tours are unfinished; renders nothing at zero.

    useLauncherStatus(tour) returns the same status for your own UI. The styled HelpLauncher is npx shadcn@latest add @awesome-tour/launcher.