Skip to content

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

Merged
alexcarpenter merged 2 commits into
mainfrom
alexcarpenter/update-clerk-modal-types
Jan 21, 2025
Merged

alexcarpenter merged 2 commits into
mainfrom
alexcarpenter/update-clerk-modal-types

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

With the current types, routing options are available in the modal methods which is not relevant in modal usage. This PR updates the types to use the modal specific types which does not include routing or path.

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:

@changeset-bot

changeset-bot Bot commented Jan 17, 2025 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: fb9327c

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

This PR includes changesets to release 22 packages
Name Type
@clerk/types Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/clerk-js Patch
@clerk/elements Patch
@clerk/expo-passkeys Patch
@clerk/clerk-expo Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/localizations Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/clerk-react Patch
@clerk/remix Patch
@clerk/shared Patch
@clerk/tanstack-start Patch
@clerk/testing Patch
@clerk/themes Patch
@clerk/ui Patch
@clerk/vue Patch
@clerk/chrome-extension Patch

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

@vercel

vercel Bot commented Jan 17, 2025 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 6:23pm

@alexcarpenter alexcarpenter changed the title fix(clerk-js): Use modal props for modal methods fix(clerk-js): Use modal types for modal methods Jan 17, 2025
* @param props Optional props that will be passed to the Waitlist component.
*/
openWaitlist: (props?: WaitlistProps) => void;
openWaitlist: (props?: WaitlistModalProps) => void;

Copy link
Copy Markdown
Member Author

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.

@jacekradko jacekradko left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👌🏼

@alexcarpenter

Copy link
Copy Markdown
Member Author

!snapshot

@clerk-cookie

Copy link
Copy Markdown
Collaborator

Hey @alexcarpenter - the snapshot version command generated the following package versions:

Package Version
@clerk/astro 2.1.11-snapshot.v20250117210429
@clerk/backend 1.23.3-snapshot.v20250117210429
@clerk/chrome-extension 2.1.15-snapshot.v20250117210429
@clerk/clerk-js 5.45.2-snapshot.v20250117210429
@clerk/elements 0.22.11-snapshot.v20250117210429
@clerk/clerk-expo 2.6.14-snapshot.v20250117210429
@clerk/expo-passkeys 0.1.10-snapshot.v20250117210429
@clerk/express 1.3.38-snapshot.v20250117210429
@clerk/fastify 2.1.11-snapshot.v20250117210429
@clerk/localizations 3.9.11-snapshot.v20250117210429
@clerk/nextjs 6.9.14-snapshot.v20250117210429
@clerk/nuxt 1.0.7-snapshot.v20250117210429
@clerk/clerk-react 5.22.2-snapshot.v20250117210429
@clerk/react-router 0.2.1-snapshot.v20250117210429
@clerk/remix 4.4.13-snapshot.v20250117210429
@clerk/shared 2.20.10-snapshot.v20250117210429
@clerk/tanstack-start 0.8.12-snapshot.v20250117210429
@clerk/testing 1.4.11-snapshot.v20250117210429
@clerk/themes 2.2.9-snapshot.v20250117210429
@clerk/types 4.41.2-snapshot.v20250117210429
@clerk/ui 0.3.12-snapshot.v20250117210429
@clerk/vue 1.1.2-snapshot.v20250117210429

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/astro

npm i @clerk/astro@2.1.11-snapshot.v20250117210429 --save-exact

@clerk/backend

npm i @clerk/backend@1.23.3-snapshot.v20250117210429 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.1.15-snapshot.v20250117210429 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.45.2-snapshot.v20250117210429 --save-exact

@clerk/elements

npm i @clerk/elements@0.22.11-snapshot.v20250117210429 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.6.14-snapshot.v20250117210429 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.1.10-snapshot.v20250117210429 --save-exact

@clerk/express

npm i @clerk/express@1.3.38-snapshot.v20250117210429 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.1.11-snapshot.v20250117210429 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.9.11-snapshot.v20250117210429 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.9.14-snapshot.v20250117210429 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.0.7-snapshot.v20250117210429 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.22.2-snapshot.v20250117210429 --save-exact

@clerk/react-router

npm i @clerk/react-router@0.2.1-snapshot.v20250117210429 --save-exact

@clerk/remix

npm i @clerk/remix@4.4.13-snapshot.v20250117210429 --save-exact

@clerk/shared

npm i @clerk/shared@2.20.10-snapshot.v20250117210429 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.8.12-snapshot.v20250117210429 --save-exact

@clerk/testing

npm i @clerk/testing@1.4.11-snapshot.v20250117210429 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.9-snapshot.v20250117210429 --save-exact

@clerk/types

npm i @clerk/types@4.41.2-snapshot.v20250117210429 --save-exact

@clerk/ui

npm i @clerk/ui@0.3.12-snapshot.v20250117210429 --save-exact

@clerk/vue

npm i @clerk/vue@1.1.2-snapshot.v20250117210429 --save-exact

@alexcarpenter
alexcarpenter merged commit fe3e49f into main Jan 21, 2025
@alexcarpenter
alexcarpenter deleted the alexcarpenter/update-clerk-modal-types branch January 21, 2025 14:26

This branch was successfully deployed

1 active deployment
Preview — fb9327c0 Deployed Jan 17, 2025 by vercel[bot]
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.

5 participants