Skip to content
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.

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

feat(elements): Introduce exampleMode prop on Root components #3184

Merged
merged 4 commits into from
Apr 15, 2024

Conversation

brkalow
Copy link
Member

@brkalow brkalow commented Apr 12, 2024

Description

Introduce exampleMode, which unconditionally renders the start step. In the future, we can leverage this to make "mock" functional flows in docs. We'll use this currently in the docs to showcase pre-built examples.

Checklist

  • npm test runs as expected.
  • npm run 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:

Copy link

changeset-bot bot commented Apr 12, 2024

🦋 Changeset detected

Latest commit: 7bf0ed7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

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

Not sure what this means? Click here to learn what changesets are.

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

Comment on lines +34 to +44
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
router,
signInPath: SIGN_IN_DEFAULT_BASE_PATH,
exampleMode,
};

if (ref.getSnapshot().can(evt)) {
ref.send(evt);
}
}, [clerk, router]);
if (ref.getSnapshot().can(evt)) {
ref.send(evt);
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It made more sense to just put the init event inside the loaded callback, instead of introducing the new event. This fixed a bug where the init event wasn't applying if clerk loaded first.

@brkalow brkalow requested a review from tmilewski April 12, 2024 22:46
@brkalow brkalow enabled auto-merge (squash) April 15, 2024 15:19
@brkalow brkalow merged commit 2b4850a into main Apr 15, 2024
10 checks passed
@brkalow brkalow deleted the brk.feat/elements-exampleMode branch April 15, 2024 15:28
@LekoArts LekoArts added this to the @clerk/elements (Beta) milestone Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants