diff --git a/.changeset/fresh-pandas-dress.md b/.changeset/fresh-pandas-dress.md new file mode 100644 index 00000000000..aec9c6dd986 --- /dev/null +++ b/.changeset/fresh-pandas-dress.md @@ -0,0 +1,5 @@ +--- +'@clerk/types': patch +--- + +Add example usage for `__experimental_startPath`. diff --git a/packages/types/src/clerk.ts b/packages/types/src/clerk.ts index e432fb76357..a8fc6103bc9 100644 --- a/packages/types/src/clerk.ts +++ b/packages/types/src/clerk.ts @@ -1496,6 +1496,7 @@ export type UserProfileProps = RoutingOptions & { customPages?: CustomPage[]; /** * Specify on which page the user profile modal will open. + * @example __experimental_startPath: '/members' * @experimental **/ __experimental_startPath?: string; @@ -1527,6 +1528,7 @@ export type OrganizationProfileProps = RoutingOptions & { customPages?: CustomPage[]; /** * Specify on which page the organization profile modal will open. + * @example __experimental_startPath: '/organization-members' * @experimental **/ __experimental_startPath?: string;