Skip to content

docs(repo): Revise and clarify isLoaded description and tab title#8336

Draft
SarahSoutoul wants to merge 2 commits intomainfrom
ss/DOCS-11007
Draft

docs(repo): Revise and clarify isLoaded description and tab title#8336
SarahSoutoul wants to merge 2 commits intomainfrom
ss/DOCS-11007

Conversation

@SarahSoutoul
Copy link
Copy Markdown
Contributor

@SarahSoutoul SarahSoutoul commented Apr 16, 2026

Description

This PR updates the description of isLoaded across hooks (useAuth, useUser, useSession, etc.) to better reflect its actual behavior.

Previously, the docs described isLoaded as:

“Initially false, becomes true once Clerk loads.”

This wording implies a one-time initialization phase. In practice, isLoaded represents whether the current authentication state is resolved, and can temporarily revert to false during auth updates (e.g. when switching organizations via setActive).

Here are the changes I applied:

  • Updated isLoaded descriptions to clarify that:
    • It starts as false and becomes true once loaded BUT may temporarily return to false while auth state is updating
    • Replaced “initialization” language with “current authentication state” for better accuracy
    • Added a concrete example (switching organizations) to make this behaviour clearer

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@SarahSoutoul SarahSoutoul self-assigned this Apr 16, 2026
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Apr 16, 2026 6:32pm

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 16, 2026

⚠️ No Changeset found

Latest commit: 9cb9f2a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@SarahSoutoul SarahSoutoul changed the title Revise and clarify isLoaded description and tab title docs(repo): Revise and clarify isLoaded description and tab title Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant