@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
60 lines (59 loc) • 2.1 kB
TypeScript
/**
* Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { FC } from 'react';
import { BaseUserProfileProps } from './BaseUserProfile';
/**
* Props for the UserProfile component.
* Extends BaseUserProfileProps but makes the user prop optional since it will be obtained from useAsgardeo
*/
export type UserProfileProps = Omit<BaseUserProfileProps, 'user' | 'profile' | 'flattenedProfile' | 'schemas'>;
/**
* UserProfile component displays the authenticated user's profile information in a
* structured and styled format. It shows user details such as display name, email,
* username, and other available profile information from Asgardeo.
*
* This component is the React-specific implementation that uses the BaseUserProfile
* and automatically retrieves the user data from Asgardeo context if not provided.
*
* @example
* ```tsx
* // Basic usage - will use user from Asgardeo context
* <UserProfile />
*
* // With explicit user data
* <UserProfile user={specificUser} />
*
* // With card layout and custom fallback
* <UserProfile
* cardLayout={true}
* fallback={<div>Please sign in to view your profile</div>}
* />
*
* // With field filtering - only show specific fields
* <UserProfile
* showFields={['name.givenName', 'name.familyName', 'emails']}
* />
*
* // With field hiding - hide specific fields
* <UserProfile
* hideFields={['phoneNumbers', 'addresses']}
* />
* ```
*/
declare const UserProfile: FC<UserProfileProps>;
export default UserProfile;