Skip to content

feat(tour-group-interface): allow custom root element #221

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(tour-group-interface): allow custom root element #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5325a75
fix(): allow cutom root element
yassilah Jul 15, 2025
5c9a462
fix default for rootSelector
Nitwel Oct 10, 2025
96bbc41
remove console.logs
Nitwel Oct 10, 2025
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
1 change: 1 addition & 0 deletions packages/tour-group-interface/src/defaults.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ export default {
buttonIcon: 'subscriptions',
buttonTooltip: 'Start the tour',
exitMessage: 'Are you sure you want to leave the tour?',
rootSelector: 'main > .v-form',
};
11 changes: 11 additions & 0 deletions packages/tour-group-interface/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,17 @@ export default defineInterface({
default_value: null,
},
},
{
field: 'rootSelector',
name: 'Root selector',
type: 'string',
meta: {
width: 'full',
},
schema: {
default_value: defaults.rootSelector,
},
},
],
};

Expand Down
4 changes: 3 additions & 1 deletion packages/tour-group-interface/src/interface.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ const props = withDefaults(
buttonIcon: string;
buttonTooltip: string;
exitMessage: string;
rootSelector: string;
}>(),
{
batchActiveFields: () => [],
Expand All @@ -38,6 +39,7 @@ const props = withDefaults(
buttonIcon: defaults.buttonIcon,
buttonTooltip: defaults.buttonTooltip,
exitMessage: defaults.exitMessage,
rootSelector: defaults.rootSelector,
},
);

Expand Down Expand Up @@ -113,7 +115,7 @@ function useInjectButtonBar() {
}

function getRootForm() {
return document.querySelector('main>.v-form');
return document.querySelector(props.rootSelector);
}

function injectButtonBar() {
Expand Down