/** * Copyright (c) 2023, 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 type { ForwardRefExoticComponent } from 'react'; import type { AvatarProps } from '../Avatar'; import type { BadgeProps } from '../Badge'; import type { CircularProgressProps } from '../CircularProgress'; export type CircularProgressAvatarProps = Omit & { /** * Props sent to the Avatar component. */ avatarOptions?: Omit; /** * Props sent to the Badge component. */ badgeOptions?: Omit; /** * Value prop sent to CircularProgress component. */ progress?: number; }; /** * The Circular Progress Avatar is a Avatar variant with a circular progress and a badge. * * Demos: * * // TODO: Move this demo to the Progress demo. * - [Circular Progress Avatar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-circular-progress-avatar) * * API: * * - [CircularProgress API](https://mui.com/material-ui/api/circular-progress/) * * @remarks * - ✨ This is a custom component that is not available in the Material-UI library. * - ✔️ Props of the native component are also available. * - ❌ `component` prop is not supported. * - ✅ The `ref` is forwarded to the root element. * * @param props - The props for the CircularProgressAvatar component. * @param ref - The ref to be forwarded to the Box component. * @returns The rendered CircularProgressAvatar component. */ declare const CircularProgressAvatar: ForwardRefExoticComponent; export default CircularProgressAvatar;