Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wacky-singers-glow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@edwardloopez/react-native-coachmark': patch
---

fix: expose `renderTooltip` option in `createTour` DSL
9 changes: 9 additions & 0 deletions src/__tests__/createTour.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,13 @@ describe('createTour', () => {
expect(tour.key).toBe('test-tour');
expect(tour.steps).toEqual(mockSteps);
});

it('should create a tour with renderTooltip option', () => {
const mockRenderer = jest.fn();
const tour = createTour('test-tour', mockSteps, {
renderTooltip: mockRenderer,
});

expect(tour.renderTooltip).toBe(mockRenderer);
});
});
1 change: 0 additions & 1 deletion src/core/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ export type TourStep = {
onBeforeEnter?: () => Promise<boolean | void>;
onEnter?: () => void;
onExit?: () => void;
// Custom tooltip renderer
renderTooltip?: TooltipRenderer;
};

Expand Down
13 changes: 10 additions & 3 deletions src/dsl/createTour.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Tour, TourStep } from '../core/types';
import type { Tour, TourStep, TooltipRenderer } from '../core/types';

/**
* Creates a tour configuration object with the specified steps and options.
Expand All @@ -8,6 +8,7 @@ import type { Tour, TourStep } from '../core/types';
* @param opts - Optional configuration options for the tour
* @param opts.showOnce - If true, the tour will only be shown once to the user
* @param opts.delay - Delay in milliseconds before the tour starts
* @param opts.renderTooltip - Global custom tooltip renderer for all steps
* @returns A Tour object containing the key, steps, and optional configuration
*
* @example
Expand All @@ -22,7 +23,13 @@ import type { Tour, TourStep } from '../core/types';
export function createTour(
key: string,
steps: TourStep[],
opts?: { showOnce?: boolean; delay?: number }
opts?: { showOnce?: boolean; delay?: number; renderTooltip?: TooltipRenderer }
): Tour {
return { key, steps, showOnce: opts?.showOnce, delay: opts?.delay };
return {
key,
steps,
showOnce: opts?.showOnce,
delay: opts?.delay,
renderTooltip: opts?.renderTooltip,
};
}
Loading