Update from code changes: document window.mintlify.user for custom scripts - #6827
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
ethanpalm
approved these changes
Jul 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Custom JavaScript files can now read the authenticated user from
window.mintlify.userand react to the newmintlify:userevent. Documented the API on the custom scripts page and added a cross-link from the personalization page.Changes
customize/custom-scripts.mdx: New "Access authenticated user data" subsection under Custom JavaScript coveringwindow.mintlify.user, themintlify:userevent, signed-out behavior, and a security note about thecontentfield.create/personalization.mdx: Added a pointer from the MDXuservariable section to the new custom scripts guidance.Triggered by mintlify/mint#9665.
Note
Low Risk
Documentation-only changes with no runtime or auth logic modifications.
Overview
Documents how custom JavaScript can access the same authenticated user object as MDX’s
uservariable viawindow.mintlify.user, and how to react when it becomes available with themintlify:userevent (including signed-outnull/undefinedbehavior and optional chaining).On custom scripts, adds an “Access authenticated user data” section with event-listener and direct-read examples, plus a warning that anything in user
contentis visible in the browser. On personalization, adds a short cross-link from dynamic MDX content to that section. The same updates are mirrored in es, fr, and zh locale docs.Reviewed by Cursor Bugbot for commit 8e99b88. Bugbot is set up for automated code reviews on this repo. Configure here.