@asgardeo/react
Version:
React implementation of Asgardeo JavaScript SDK.
60 lines (59 loc) • 1.69 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';
export interface AvatarProps {
/**
* Alternative text for the avatar image
*/
alt?: string;
/**
* Background generation strategy
* - 'random': Generate background color based on ASCII values of the name
* - 'none': Use default theme background
* - string: Use custom background color
* @default 'random'
*/
background?: 'random' | 'none' | string;
/**
* Optional className for the avatar
*/
className?: string;
/**
* The URL of the avatar image
*/
imageUrl?: string;
/**
* The name to use for generating initials when no image is provided
*/
name?: string;
/**
* The size of the avatar in pixels
*/
size?: number;
/**
* The variant of the avatar shape
* @default 'circular'
*/
variant?: 'circular' | 'square';
/**
* Loading state of the avatar
*/
isLoading?: boolean;
}
export declare const Avatar: FC<AvatarProps>;
export default Avatar;