Skip to content

fix: expose renderTooltip option in createTour DSL#26

Merged
edwardloopez merged 1 commit intomainfrom
fix/create-tour-render-tooltip
Mar 28, 2026
Merged

fix: expose renderTooltip option in createTour DSL#26
edwardloopez merged 1 commit intomainfrom
fix/create-tour-render-tooltip

Conversation

@edwardloopez
Copy link
Copy Markdown
Owner

The Tour type already defined renderTooltip?: TooltipRenderer but createTour() did not accept or propagate it, making the global custom tooltip renderer inaccessible via the DSL.

  • Add renderTooltip to createTour opts parameter
  • Import TooltipRenderer type in createTour.ts
  • Add test coverage for the new option

Closes #25

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the createTour() DSL helper to support the already-existing Tour.renderTooltip option, making it possible to configure a global custom tooltip renderer when defining tours via the DSL (addressing issue #25).

Changes:

  • Extend createTour() options to accept renderTooltip?: TooltipRenderer.
  • Propagate renderTooltip from opts onto the returned Tour object.
  • Add a Jest test asserting that renderTooltip is preserved.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/dsl/createTour.ts Adds renderTooltip to the DSL options and returns it on the Tour object.
src/core/types.ts Minor cleanup: removes an inline comment from TourStep (no behavioral change).
src/__tests__/createTour.test.ts Adds coverage verifying renderTooltip is set when passed to createTour().

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

The Tour type already defined renderTooltip?: TooltipRenderer but
createTour() did not accept or propagate it, making the global custom
tooltip renderer inaccessible via the DSL.

- Add renderTooltip to createTour opts parameter
- Import TooltipRenderer type in createTour.ts
- Add test coverage for the new option

Closes #25
@edwardloopez edwardloopez force-pushed the fix/create-tour-render-tooltip branch from 10c8bad to fdf324c Compare March 28, 2026 18:45
@edwardloopez edwardloopez merged commit 8ca8d3c into main Mar 28, 2026
5 checks passed
@edwardloopez edwardloopez deleted the fix/create-tour-render-tooltip branch March 28, 2026 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tour Options Missing - renderToolTip

2 participants