Skip to content

feat: add 'data' property to DriveStep for custom logic support #540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fredericbahr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: add 'data' property to DriveStep for custom logic support #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 4 additions & 1 deletion docs/src/content/guides/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,9 @@ type DriveStep = {
// Whether to disable interaction with the highlighted element. (default: false)
disableActiveInteraction?: boolean;

// Arbitrary data that you can pass to the step in order to support complex custom logic in hooks.
data?: Record<string, any>;

// Callback when the current step is deselected,
// about to be highlighted or highlighted.
// Each callback receives the following parameters:
Expand Down Expand Up @@ -241,4 +244,4 @@ type State = {
// container, title, description, buttons etc.
popover?: PopoverDOM;
}
```
```
1 change: 1 addition & 0 deletions src/driver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export type DriveStep = {
onDeselected?: DriverHook;
popover?: Popover;
disableActiveInteraction?: boolean;
data?: Record<string, any>;
};

export function driver(options: Config = {}) {
Expand Down