/** * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). All Rights Reserved. * * 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 type { OverridableComponent } from '@mui/material/OverridableComponent'; import type { ElementType, ReactNode } from 'react'; import type { CardProps, CardTypeMap } from '../Card'; import type { CardHeaderProps } from '../CardHeader'; import type { CarouselStep } from '../Carousel'; import type { UserTemplate } from '../UserDropdownMenu'; import './account-overview.scss'; export type AccountOverviewProps = Omit, 'title'> & { /** * Account completion steps. */ accountCompletionSteps?: AccountCompletionSteps[]; /** * Account completion steps title. */ accountCompletionStepsTitle?: string; /** * Account progress. */ accountProgress: number; /** * Card header props. */ cardHeaderProps?: CardHeaderProps; /** * Card Subheader. * @example subheader */ subheader?: ReactNode; /** * Card Title. * @example title */ title: ReactNode; /** * Logged user information. */ user: UserTemplate; }; export type AccountCompletionSteps = CarouselStep; /** * The Account Overview component lets you display the progress of the user's account. * It includes the user's profile picture, name, email, account progress and account completion steps. * * Demos: * * - [Account Overview (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/patterns-account-overview) * * API: * * - inherits [Card API](https://mui.com/material-ui/api/card/) * * @remarks * - ✨ This is a custom component that is not available in the Material-UI library. * - ✔️ Props of the [Paper](https://mui.com/material-ui/api/card/) component are also available. * - ✅ `component` prop is supported. * - ✅ The `ref` is forwarded to the root element. * * @template C - The type of the component. * @param props - The props for the AccountOverview component. * @param ref - The ref to be forwarded to the Card component. * @returns The rendered AccountOverview component. */ declare const AccountOverview: OverridableComponent>; export default AccountOverview;