@ui5/webcomponents-react
Version:
React Wrapper for UI5 Web Components and additional components
65 lines (64 loc) • 2.43 kB
TypeScript
import '@ui5/webcomponents-fiori/dist/UserMenuAccount.js';
import type AvatarColorScheme from '@ui5/webcomponents/dist/types/AvatarColorScheme.js';
import type { CommonProps, Ui5DomRef } from '@ui5/webcomponents-react-base';
interface UserMenuAccountAttributes {
/**
* Defines additional information for the user.
*/
additionalInfo?: string;
/**
* Defines the background color of the desired image.
* If `avatarColorScheme` is set to `Auto`, the avatar will be displayed with the `Accent6` color.
* @default "Auto"
*/
avatarColorScheme?: AvatarColorScheme | keyof typeof AvatarColorScheme;
/**
* Defines the avatar initials of the user.
* @default undefined
*/
avatarInitials?: string | undefined;
/**
* Defines the avatar image url of the user.
*/
avatarSrc?: string | undefined;
/**
* Defines description of the user.
*/
description?: string;
/**
* Indicates whether a loading indicator should be shown.
*
* **Note:** Available since [v2.9.0](https://github.com/UI5/webcomponents/releases/tag/v2.9.0) of **@ui5/webcomponents-fiori**.
* @default false
*/
loading?: boolean;
/**
* Defines if the user is selected.
* @default false
*/
selected?: boolean;
/**
* Defines additional text of the user.
*/
subtitleText?: string;
/**
* Defines the title text of the user.
*/
titleText?: string;
}
interface UserMenuAccountDomRef extends Required<UserMenuAccountAttributes>, Ui5DomRef {
}
interface UserMenuAccountPropTypes extends UserMenuAccountAttributes, Omit<CommonProps, keyof UserMenuAccountAttributes> {
}
/**
* The `UserMenuAccount` represents an account in the `UserMenu`.
*
*
*
* __Note:__ This is a UI5 Web Component! [UserMenuAccount UI5 Web Component Documentation](https://ui5.github.io/webcomponents/components/fiori/UserMenuAccount) | [Repository](https://github.com/UI5/webcomponents)
*
* @since [2.5.0](https://github.com/UI5/webcomponents/releases/tag/v2.5.0) of __@ui5/webcomponents-fiori__.
*/
declare const UserMenuAccount: import("react").ForwardRefExoticComponent<UserMenuAccountPropTypes & import("@ui5/webcomponents-react-base").WithWebComponentPropTypes & import("react").RefAttributes<UserMenuAccountDomRef>>;
export { UserMenuAccount };
export type { UserMenuAccountDomRef, UserMenuAccountPropTypes };