@asgardeo/react/dist/components/presentation/User/BaseUser.d.ts

React implementation of Asgardeo JavaScript SDK.

/**
 * 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 { User as IUser } from '@asgardeo/browser';
import { FC, ReactNode } from 'react';
/**
 * Props for the BaseUser component.
 */
export interface BaseUserProps {
    /**
     * The user object to display. If not provided, the component will render the fallback.
     */
    user: IUser | null;
    /**
     * Render prop that takes the user object and returns a ReactNode.
     * @param user - The authenticated user object from Asgardeo.
     * @returns A ReactNode to render.
     */
    children: (user: IUser | null) => ReactNode;
    /**
     * Optional element to render when no user is provided.
     */
    fallback?: ReactNode;
}
/**
 * Base User component that provides the core functionality for displaying user information.
 * This component takes a user object as a prop and uses render props to expose it.
 *
 * @remarks This is the base component that can be used in any context where you have
 * a user object available. For React applications, use the User component which
 * automatically retrieves the user from Asgardeo context.
 *
 * @example
 * ```tsx
 * import { BaseUser } from '@asgardeo/auth-react';
 *
 * const MyComponent = ({ user }) => {
 *   return (
 *     <BaseUser user={user} fallback={<p>No user data</p>}>
 *       {(user) => (
 *         <div>
 *           <h1>Welcome, {user.displayName}!</h1>
 *           <p>Email: {user.email}</p>
 *         </div>
 *       )}
 *     </BaseUser>
 *   );
 * }
 * ```
 */
declare const BaseUser: FC<BaseUserProps>;
export default BaseUser;