Skip to content

feat(apollo-vertex): onboarding tour — step popover and type definitions#674

Open
petervachon wants to merge 1 commit intomainfrom
feat/vertex-onboarding-tour-joyride
Open

feat(apollo-vertex): onboarding tour — step popover and type definitions#674
petervachon wants to merge 1 commit intomainfrom
feat/vertex-onboarding-tour-joyride

Conversation

@petervachon
Copy link
Copy Markdown
Collaborator

Summary

First in a 3-part stack that adds a guided onboarding tour component
to Apollo Vertex. This slice lays the foundation: the step popover
card that highlights UI elements and walks users through a feature,
plus the type system and persistence that all three slices share.

When this stack is complete, product teams can drop an onboarding tour
into any Apollo-based app with a single shadcn install — defining their
own steps, selectors, and welcome screens without writing tour
infrastructure from scratch.

This PR intentionally ships no visible behavior. It exists so the
popover design and component API can be reviewed and signed off before
the orchestration layer (PR 2) and docs (PR 3) build on top of it.

What's included

  • Step and tour type definitions — the contract consumers use to define
    their tour steps, placements, and conditional gating
  • Popover card component — the tooltip UI that appears next to
    highlighted elements during a tour
  • Tour persistence — remembers which tours a user has already completed
    so they don't see the same tour twice

What's next

  • PR 2 (draft): the provider that runs the tour, sequences steps, and
    renders the welcome modal
  • PR 3 (draft): docs page with live demo and installation guide

Test plan

  • pnpm --filter apollo-vertex build passes
  • pnpm --filter apollo-vertex lint passes
  • Popover card renders correctly in light and dark mode

🤖 Generated with Claude Code

@petervachon petervachon requested a review from a team as a code owner May 11, 2026 13:02
@petervachon petervachon requested review from 0xr3ngar and ruudandriessen and removed request for a team May 11, 2026 13:02
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (PT)
apollo-design 🟢 Ready Preview, Logs May 11, 2026, 07:46:31 AM
apollo-docs 🟢 Ready Preview, Logs May 11, 2026, 07:45:30 AM
apollo-landing 🟢 Ready Preview, Logs May 11, 2026, 07:44:23 AM
apollo-ui-react 🟢 Ready Preview, Logs May 11, 2026, 07:44:30 AM
apollo-vertex 🟢 Ready Preview, Logs May 11, 2026, 07:46:06 AM

@github-actions github-actions Bot added the size:XL 500-999 changed lines. label May 11, 2026
@petervachon petervachon force-pushed the feat/vertex-onboarding-tour-joyride branch from ce9dc19 to a795087 Compare May 11, 2026 13:55
@github-actions github-actions Bot added size:L 100-499 changed lines. and removed size:XL 500-999 changed lines. labels May 11, 2026
@github-actions
Copy link
Copy Markdown

Dependency License Review

  • 2114 package(s) scanned
  • ✅ No license issues found
  • ⚠️ 15 package(s) excluded (see details below)
License distribution
License Packages
MIT 1834
ISC 105
Apache-2.0 69
BSD-3-Clause 30
BSD-2-Clause 24
Copyright 2022, UiPath, all rights reserved 9
BlueOak-1.0.0 8
MPL-2.0 5
MIT OR Apache-2.0 3
MIT-0 3
Unknown 3
Unlicense 3
CC0-1.0 3
LGPL-3.0-or-later 2
(MIT OR Apache-2.0) 2
Python-2.0 1
CC-BY-4.0 1
(MPL-2.0 OR Apache-2.0) 1
BSD 1
Artistic-2.0 1
(WTFPL OR MIT) 1
(BSD-2-Clause OR MIT OR Apache-2.0) 1
CC-BY-3.0 1
0BSD 1
(MIT OR CC0-1.0) 1
MIT AND ISC 1
Excluded packages
Package Version License Reason
@img/sharp-libvips-linux-x64 1.2.4 LGPL-3.0-or-later LGPL pre-built binary, not linked
@img/sharp-libvips-linuxmusl-x64 1.2.4 LGPL-3.0-or-later LGPL pre-built binary, not linked
@uipath/apollo-angular-elements 5.89.0 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/apollo-core 4.35.0, 4.35.1, 4.35.2 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/apollo-fonts 1.25.8 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/apollo-icons 1.33.7 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/apollo-mui5 2.31.26, 2.31.27 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/portal-shell 3.351.4 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/portal-shell-react 3.149.36 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/portal-shell-types 3.326.0 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/portal-shell-util 1.114.0 Copyright 2022, UiPath, all rights reserved UiPath first-party package
@uipath/apollo-lab 25.12.0 Unknown UiPath first-party package
@uipath/telemetry-client-web 5.1.0 Unknown UiPath first-party package
khroma 2.1.0 Unknown MIT per GitHub repo, missing license field in package.json
hyperx 2.5.4 BSD BSD-2-Clause per LICENSE file, non-SPDX "BSD" in package.json

@petervachon petervachon force-pushed the feat/vertex-onboarding-tour-joyride branch from a795087 to 92ab801 Compare May 11, 2026 14:14
…ypes

Adds the presentational layer of the onboarding-tour-joyride registry
component: step type definitions, tour persistence hook, and the popover
card that Joyride renders as its tooltipComponent.

The popover card is split into two components: OnboardingTourJoyridePopoverCard
(pure visual, usable standalone for static previews) and
OnboardingTourJoyridePopover (adapter that receives Joyride's TooltipRenderProps
and feeds them into the card). This keeps the presentational component
free of Joyride's internal prop types.

Co-Authored-By: Colin Reilly <colin.reilly@gmail.com>
@petervachon petervachon force-pushed the feat/vertex-onboarding-tour-joyride branch from 92ab801 to a525709 Compare May 11, 2026 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

app:apollo-vertex size:L 100-499 changed lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant