Skip to content

fix(clerk-js): Use modal types for modal methods #4931

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
merged 2 commits into from
Jan 21, 2025
Merged

fix(clerk-js): Use modal types for modal methods #4931

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
863e945
fix(clerk-js): Use modal props for modal methods
alexcarpenter Jan 17, 2025
fb9327c
add changeset
alexcarpenter Jan 17, 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
5 changes: 5 additions & 0 deletions .changeset/gorgeous-suns-cheer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Update modal methods to use the correct types.
12 changes: 6 additions & 6 deletions packages/types/src/clerk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ export interface Clerk {
* Opens the Clerk SignIn component in a modal.
* @param props Optional sign in configuration parameters.
*/
openSignIn: (props?: SignInProps) => void;
openSignIn: (props?: SignInModalProps) => void;

/**
* Closes the Clerk SignIn modal.
Expand Down Expand Up @@ -190,7 +190,7 @@ export interface Clerk {
* Opens the Clerk SignUp component in a modal.
* @param props Optional props that will be passed to the SignUp component.
*/
openSignUp: (props?: SignUpProps) => void;
openSignUp: (props?: SignUpModalProps) => void;

/**
* Closes the Clerk SignUp modal.
Expand All @@ -201,7 +201,7 @@ export interface Clerk {
* Opens the Clerk UserProfile modal.
* @param props Optional props that will be passed to the UserProfile component.
*/
openUserProfile: (props?: UserProfileProps) => void;
openUserProfile: (props?: UserProfileModalProps) => void;

/**
* Closes the Clerk UserProfile modal.
Expand All @@ -212,7 +212,7 @@ export interface Clerk {
* Opens the Clerk OrganizationProfile modal.
* @param props Optional props that will be passed to the OrganizationProfile component.
*/
openOrganizationProfile: (props?: OrganizationProfileProps) => void;
openOrganizationProfile: (props?: OrganizationProfileModalProps) => void;

/**
* Closes the Clerk OrganizationProfile modal.
Expand All @@ -223,7 +223,7 @@ export interface Clerk {
* Opens the Clerk CreateOrganization modal.
* @param props Optional props that will be passed to the CreateOrganization component.
*/
openCreateOrganization: (props?: CreateOrganizationProps) => void;
openCreateOrganization: (props?: CreateOrganizationModalProps) => void;

/**
* Closes the Clerk CreateOrganization modal.
Expand All @@ -234,7 +234,7 @@ export interface Clerk {
* Opens the Clerk Waitlist modal.
* @param props Optional props that will be passed to the Waitlist component.
*/
openWaitlist: (props?: WaitlistProps) => void;
openWaitlist: (props?: WaitlistModalProps) => void;
Copy link
Member Author

@alexcarpenter alexcarpenter Jan 17, 2025

Choose a reason for hiding this comment

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

This is equivalent, but no harm in being consistent.


/**
* Closes the Clerk Waitlist modal.
Expand Down
Loading