/** * 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 { BadgeProps as MuiBadgeProps, BadgeTypeMap } from '@mui/material/Badge'; import type { OverridableComponent } from '@mui/material/OverridableComponent'; import type { ElementType } from 'react'; export type BadgeProps = { /** * The component used for the root node. Either a string to use a HTML element or a component. */ component?: C; } & Omit, 'component'>; /** * The Badge component generates a small badge to the top-right of its child(ren). * * Demos: * * - [Avatar (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-avatar) * - [Badge (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/data-display-badge/) * - [Avatar (MUI)](https://mui.com/material-ui/react-avatar/) * - [Badge (MUI)](https://mui.com/material-ui/react-badge/) * * API: * * - [Badge API](https://mui.com/material-ui/api/badge/) * * @remarks * - ✔️ Props of the native 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 Badge component. * @param ref - The ref to be forwarded to the MuiBadge component. * @returns The rendered Badge component. */ declare const Badge: OverridableComponent>; export default Badge;