Skip to content

feat: read requireAnalyticsOptIn setting from visual editor config #1059

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

Merged
jwartofsky-yext merged 2 commits into from
Feb 24, 2026
Merged

feat: read requireAnalyticsOptIn setting from visual editor config #1059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb3d4ec
feat: read requireOptIn setting from visual editor config
jwartofsky-yext Feb 24, 2026
0caceb3
add try/catch wrappers to config json parsing
jwartofsky-yext Feb 24, 2026
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
12 changes: 12 additions & 0 deletions packages/visual-editor/src/vite-plugin/templates/directory.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,23 @@ const Directory: Template<TemplateRenderProps> = (props) => {
console.error("Failed to parse layout JSON:", e);
}

let requireAnalyticsOptIn = false;
if (document.__?.visualEditorConfig) {
try {
requireAnalyticsOptIn =
JSON.parse(document.__.visualEditorConfig)?.requireAnalyticsOptIn ??
false;
} catch (e) {
console.error("Failed to parse visualEditorConfig JSON:", e);
}
}

return (
<AnalyticsProvider
apiKey={document?._env?.YEXT_PUBLIC_VISUAL_EDITOR_APP_API_KEY}
templateData={props}
currency="USD"
requireOptIn={requireAnalyticsOptIn}
>
<VisualEditorProvider templateProps={props}>
<Render
Expand Down
12 changes: 12 additions & 0 deletions packages/visual-editor/src/vite-plugin/templates/locator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,17 @@ const Locator: Template<TemplateRenderProps> = (props) => {
console.error("Failed to parse layout JSON:", e);
}

let requireAnalyticsOptIn = false;
if (document.__?.visualEditorConfig) {
try {
requireAnalyticsOptIn =
JSON.parse(document.__.visualEditorConfig)?.requireAnalyticsOptIn ??
false;
} catch (e) {
console.error("Failed to parse visualEditorConfig JSON:", e);
}
}

return (
<>
<script
Expand All @@ -146,6 +157,7 @@ const Locator: Template<TemplateRenderProps> = (props) => {
apiKey={document?._env?.YEXT_PUBLIC_VISUAL_EDITOR_APP_API_KEY}
templateData={props}
currency="USD"
requireOptIn={requireAnalyticsOptIn}
>
<VisualEditorProvider templateProps={props}>
<Render
Expand Down
12 changes: 12 additions & 0 deletions packages/visual-editor/src/vite-plugin/templates/main.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,23 @@ const Location: Template<TemplateRenderProps> = (props) => {
document?._additionalLayoutCategories
);

let requireAnalyticsOptIn = false;
if (document.__?.visualEditorConfig) {
try {
requireAnalyticsOptIn =
JSON.parse(document.__.visualEditorConfig)?.requireAnalyticsOptIn ??
false;
} catch (e) {
console.error("Failed to parse visualEditorConfig JSON:", e);
}
}

return (
<AnalyticsProvider
apiKey={document?._env?.YEXT_PUBLIC_VISUAL_EDITOR_APP_API_KEY}
templateData={props}
currency="USD"
requireOptIn={requireAnalyticsOptIn}
>
<VisualEditorProvider templateProps={props}>
<Render
Expand Down
Loading