Skip to content

chore(vue): Remove customPages prop types from UI components #5101

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
wobsoriano merged 4 commits into from
Feb 7, 2025
Merged

chore(vue): Remove customPages prop types from UI components #5101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16b4e24
chore(vue): Remove custom pages and menu item prop types
wobsoriano Feb 7, 2025
ebe844e
Merge branch 'main' into rob/chore/remove-custom-pages-types
wobsoriano Feb 7, 2025
b7d3f64
chore: add changeset
wobsoriano Feb 7, 2025
04c014d
chore: Omit custom menu items prop
wobsoriano Feb 7, 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/curvy-flowers-whisper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/vue": patch
---

Remove `customPages` prop types from `<UserProfile />`, `<OrganizationProfile />` and `<UserButton />` to align with runtime behavior.
5 changes: 4 additions & 1 deletion packages/vue/src/components/ui-components/OrganizationProfile/OrganizationProfile.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ import type { OrganizationProfileProps } from '@clerk/types';
import { OrganizationProfileInjectionKey } from '../../../keys';
import { ClerkHostRenderer, CustomPortalsRenderer } from '../../ClerkHostRenderer';

const props = defineProps<OrganizationProfileProps>();
type Props = Omit<OrganizationProfileProps, 'customPages'>;
const props = defineProps<Props>();

const clerk = useClerk();

const { customPages, customPagesPortals, addCustomPage } = useOrganizationProfileCustomPages();

const finalProps = computed(() => ({
Expand Down
6 changes: 4 additions & 2 deletions packages/vue/src/components/ui-components/UserButton/UserButton.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
<script setup lang="ts">
import { useClerk } from '../../../composables';
import type { UserButtonProps } from '@clerk/types';
import type { UserButtonProps, UserProfileProps } from '@clerk/types';
import { ClerkHostRenderer, CustomPortalsRenderer } from '../../ClerkHostRenderer';
import { computed, provide } from 'vue';
import { UserButtonInjectionKey, UserProfileInjectionKey } from '../../../keys';
import { useUserProfileCustomPages } from '../../../utils/useCustomPages';
import { useUserButtonCustomMenuItems } from '../../../utils/useCustomMenuItems';

type Props = Omit<UserButtonProps, 'customMenuItems'>;

@octoper octoper Feb 7, 2025

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.

❓ Why did we not omit customMenuItems now?

@wobsoriano wobsoriano Feb 7, 2025

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.

Oh good catch, def missed that

@wobsoriano wobsoriano Feb 7, 2025

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.

Updated!

type Props = Omit<UserButtonProps, 'userProfileProps' | 'customMenuItems'> & {
userProfileProps?: Pick<UserProfileProps, 'additionalOAuthScopes' | 'appearance'>;
};
const props = defineProps<Props>();

const clerk = useClerk();
Expand Down
3 changes: 2 additions & 1 deletion packages/vue/src/components/ui-components/UserProfile/UserProfile.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import { computed, provide } from 'vue';
import { UserProfileInjectionKey } from '../../../keys';
import { useUserProfileCustomPages } from '../../../utils/useCustomPages';

const props = defineProps<UserProfileProps>();
type Props = Omit<UserProfileProps, 'customPages'>;
const props = defineProps<Props>();

const clerk = useClerk();
const { customPages, customPagesPortals, addCustomPage } = useUserProfileCustomPages();
Expand Down